QABinaryMessage class

A QABinaryMessage object is used to send a message containing a stream of uninterpreted bytes.

Syntax

public class QABinaryMessage : QAMessage

Members

All members of QABinaryMessage class, including all inherited members.

Name	Description
QABinaryMessage deconstructor	Virtual destructor.
beginEnumPropertyNames method	Begins an enumeration of message property names.
castToBinaryMessage method	Casts this QAMessage to a QABinaryMessage.
castToTextMessage method	Casts this QAMessage to a QATextMessage.
clearProperties method	Clears a message's properties.
endEnumPropertyNames method	Frees the resources associated with a message property name enumeration.
getAddress method	Gets the destination address for the QAMessage instance.
getBodyLength method	Returns the size of the message body in bytes.
getBooleanProperty method	Gets the value of the qa_bool property with the specified name.
getByteProperty method	Gets the value of the qa_byte property with the specified name.
getDoubleProperty method	Gets the value of the qa_double property with the specified name.
getExpiration method	Gets the message's expiration time.
getFloatProperty method	Gets the value of the qa_float property with the specified name.
getInReplyToID method	Gets the ID of the message that this message is in reply to.
getIntProperty method	Gets the value of the qa_int property with the specified name.
getLongProperty method	Gets the value of the qa_long property with the specified name.
getMessageID method	Gets the message ID.
getPriority method	Gets the message priority level.
getPropertyType method	Returns the type of a property with the given name.
getRedelivered method	Indicates whether the message has been previously received but not acknowledged.
getReplyToAddress method	Gets the address to which a reply to this message should be sent.
getShortProperty method	Gets the value of the qa_short property with the specified name.
getStringProperty method	Gets the value of the qa_string property with the specified name.
getTimestamp method	Gets the message timestamp.
getTimestampAsString method	Gets the message timestamp as a formatted string.
nextPropertyName method	Returns the message property name for the given enumeration, returning -1 if there are no more property names.
propertyExists method	Indicates whether a property value exists.
readBinary method	Reads a specified number of bytes starting from the unread portion of the QABinaryMessage instance's message body.
readBoolean method	Reads a boolean value starting from the unread portion of the QABinaryMessage instance's message body.
readByte method	Reads a signed 8-bit value starting from the unread portion of the QABinaryMessage instance's message body.
readChar method	Reads a character value starting from the unread portion of the QABinaryMessage instance's message body.
readDouble method	Reads a double value starting from the unread portion of the QABinaryMessage instance's message body.
readFloat method	Reads a float value starting from the unread portion of the QABinaryMessage instance's message body.
readInt method	Reads a signed 32-bit integer value starting from the unread portion of the QABinaryMessage instance's message body.
readLong method	Reads a signed 64-bit integer value starting from the unread portion of the QABinaryMessage instance's message body.
readShort method	Reads a signed 16-bit value starting from the unread portion of the QABinaryMessage instance's message body.
readString method	Reads a string value starting from the unread portion of the QABinaryMessage instance's message body.
reset method	Resets a message so that the reading of values starts from the beginning of the message body.
setAddress method	Sets the destination address for this message.
setBooleanProperty method	Sets the qa_bool property with the specified name to the specified value.
setByteProperty method	Sets a qa_byte property with the specified name to the specified value.
setDoubleProperty method	Sets the qa_double property with the specified name to the specified value.
setFloatProperty method	Sets the qa_float property with the specified name to the specified value.
setInReplyToID method	Sets the In-Reply-To ID for the message.
setIntProperty method	Sets the qa_int property with the specified name to the specified value.
setLongProperty method	Sets the qa_long property with the specified name to the specified value.
setMessageID method	Sets the message ID.
setPriority method	Sets the priority level for this message.
setRedelivered method	Sets an indication of whether this message was redelivered.
setReplyToAddress method	Sets the address to which a reply to this message should be sent.
setShortProperty method	Sets e qa_short property with the specified name to the specified value.
setStringProperty method	Sets a qa_string property with the specified name to the specified value.
setTimestamp method	Sets the message timestamp.
writeBinary method	Appends a byte array value to the QABinaryMessage instance's message body.
writeBoolean method	Appends a boolean value to the QABinaryMessage instance's message body.
writeByte method	Appends a byte value to the QABinaryMessage instance's message body.
writeChar method	Appends a char value to the QABinaryMessage instance's message body.
writeDouble method	Appends a double value to the QABinaryMessage instance's message body.
writeFloat method	Appends a float value to the QABinaryMessage instance's message body.
writeInt method	Appends an integer value to the QABinaryMessage instance's message body.
writeLong method	Appends a long value to the QABinaryMessage instance's message body.
writeShort method	Appends a short value to the QABinaryMessage instance's message body.
writeString method	Appends a string value to the QABinaryMessage instance's message body.
DEFAULT_PRIORITY variable	The default message priority.
DEFAULT_TIME_TO_LIVE variable	The default message time-to-live value.

Remarks

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.

Example

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 Writing QAnywhere client applications.

QABinaryMessage deconstructor
getBodyLength method
readBinary method
readBoolean method
readByte method
readChar method
readDouble method
readFloat method
readInt method
readLong method
readShort method
readString method
reset method
writeBinary method
writeBoolean method
writeByte method
writeChar method
writeDouble method
writeFloat method
writeInt method
writeLong method
writeShort method
writeString method

Discuss this page in DocCommentXchange.