QABinaryMessage interface

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

Syntax

public interface QABinaryMessage

Members

All members of QABinaryMessage interface, including all inherited members.

Name	Description
clearProperties method	Clear all the properties of the message.
getAddress method	Returns the destination address for the QAMessage instance.
getBodyLength method	Returns the size of the message body in bytes.
getBooleanProperty method	Gets a boolean message property.
getByteProperty method	Gets a signed byte message property.
getDoubleProperty method	Gets a double message property.
getExpiration method	Returns the message's expiration value, or null if the message does not expire or has not yet been sent.
getFloatProperty method	Gets a float message property.
getInReplyToID method	Returns the message ID of the message to which this message is a reply.
getIntProperty method	Gets an int message property.
getLongProperty method	Gets a long message property.
getMessageID method	Returns the globally unique message ID of the message.
getPriority method	Returns the priority of the message (ranging from 0 to 9).
getProperty method	Gets a message property.
getPropertyNames method	Gets an enumerator over the property names of the message.
getPropertyType method	Returns the property type of the given property.
getRedelivered method	Indicates whether the message has been previously received but not acknowledged.
getReplyToAddress method	Returns the reply-to address of this message.
getShortProperty method	Gets a short message property.
getStringProperty method	Gets a String message property.
getTimestamp method	Returns the message timestamp, which is the time the message was created.
propertyExists method	Indicates whether the given property has been set for this message.
readBinary method	Reads some number of bytes starting from the unread portion of a QABinaryMessage instance body and stores them into the dest array.
readBoolean method	Reads a boolean value starting from the unread portion of the QABinaryMessage instance's message body.
readByte method	Reads a signed byte value starting from the unread portion of a QABinaryMessage message body.
readChar method	Reads a char value starting from the unread portion of a QABinaryMessage message body.
readDouble method	Reads a double value starting from the unread portion of a QABinaryMessage message body.
readFloat method	Reads a float value starting from the unread portion of a QABinaryMessage message body.
readInt method	Reads an integer value starting from the unread portion of a QABinaryMessage message body.
readLong method	Reads a long value starting from the unread portion of a QABinaryMessage message body.
readShort method	Reads a short value starting from the unread portion of a QABinaryMessage message body.
readString method	Reads a string value starting from the unread portion of a QABinaryMessage message body.
reset method	Resets a message so that the reading of values starts from the beginning of the message body.
setBooleanProperty method	Sets a boolean property.
setByteProperty method	Sets a signed byte property.
setDoubleProperty method	Sets a double property.
setFloatProperty method	Sets a float property.
setInReplyToID method	Sets the in reply to ID, which identifies the message this message is a reply to.
setIntProperty method	Sets an int property.
setLongProperty method	Sets a long property.
setPriority method	Sets the priority of the message (ranging from 0 to 9).
setProperty method	Sets a property.
setReplyToAddress method	Sets the reply-to address.
setShortProperty method	Sets a short property.
setStringProperty method	Sets a string property.
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 signed 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 time-to-live value.

Remarks

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

When the message is first created, the body of the message is in write-only mode. 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 QABinaryMessage.reset() so that the message body is in read-only mode and reading of values starts from the beginning of the message body.

The following example uses the QABinaryMessage.writeString(String) 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.
try {
    qa_manager.putMessage( "store-id\\queue-name", binary_message );
}
catch ( QAException e ) {
    handleError();
}

Note

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.