public class QABinaryMessage : QAMessage

• QAMessage class [QAnywhere C++]

All members of QABinaryMessage class, including all inherited members.

It inherits from the QAMessage class and adds a bytes message body. QABinaryMessage provides a variety of methods to read from and write to the bytes message body.

When the message is first created, the body of the message is write-only. After a message has been sent, the client that sent it can retain and modify it without affecting the message that has been sent. The same message object can be sent multiple times.

When a message is received, the provider has called the QABinaryMessage::reset method so that the message body is in read-only mode and reading of values starts from the beginning of the message body. If a client attempts to write a message in read-only mode, a COMMON_MSG_NOT_WRITEABLE_ERROR is set.

The following example uses the QABinaryMessage::writeString method to write the string "Q" followed by the string "Anywhere" to a QABinaryMessage instance's message body.

// Create a binary message instance.
QABinaryMessage * binary_message;
binary_message = qa_manager->createBinaryMessage();

// Set optional message properties.
binary_message->setReplyToAddress( "my-queue-name" );

// Write to the message body.
binary_message->writeString("Q");
binary_message->writeString("Anywhere");

// Put the message in the local database, ready for sending.

if( !qa_manager->putMessage( "store-id\\queue-name", msg ) ) {
    handleError();
}

On the receiving end, the first QABinaryMessage::readString() invocation returns "Q" and the next QABinaryMessage::readString() invocation returns "Anywhere".

The message is sent by the QAnywhere Agent.

For more information, see Determining when message transmission should occur on the client and How to write QAnywhere client applications.