The IBytesMessage type exposes the following members.

Methods

  NameDescription
Public methodAcknowledge
Acknowledges all consumed messages of the session of this consumed message.

All consumed JMS messages support the acknowledge method for use when a client has specified that its JMS session's consumed messages are to be explicitly acknowledged. By invoking acknowledge on a consumed message, a client acknowledges all messages consumed by the session that the message was delivered to.

Calls to acknowledge are ignored for both transacted sessions and sessions specified to use implicit acknowledgement modes.

A client may individually acknowledge each message as it is consumed, or it may choose to acknowledge messages as an application-defined group (which is done by calling acknowledge on the last received message of the group, thereby acknowledging all messages consumed by the session.)

Messages that have been received but not acknowledged may be redelivered.

(Inherited from IMessage.)
Public methodClearBody
Clears out the message body. Clearing a message's body does not clear its header values or property entries.

If this message body was read-only, calling this method leaves the message body in the same state as an empty body in a newly created message.

(Inherited from IMessage.)
Public methodClearProperties
Clears a message's properties.

The message's header fields and body are not cleared.

(Inherited from IMessage.)
Public methodGetBooleanProperty
Returns the value of the boolean property with the specified name.
(Inherited from IMessage.)
Public methodGetByteProperty
Returns the value of the byte property with the specified name.
(Inherited from IMessage.)
Public methodGetDoubleProperty
Returns the value of the double property with the specified name.
(Inherited from IMessage.)
Public methodGetFloatProperty
Returns the value of the float property with the specified name.
(Inherited from IMessage.)
Public methodGetIntProperty
Returns the value of the int property with the specified name.
(Inherited from IMessage.)
Public methodGetLongProperty
Returns the value of the long property with the specified name.
(Inherited from IMessage.)
Public methodGetObjectProperty
Returns the value of the object property with the specified name.

This method can be used to return, in objectified format, an object that has been stored as a property in the message with the equivalent SetObjectProperty method call, or its equivalent primitive SettypeProperty method.

(Inherited from IMessage.)
Public methodGetShortProperty
Returns the value of the short property with the specified name.
(Inherited from IMessage.)
Public methodGetStringProperty
Returns the value of the String property with the specified name.
(Inherited from IMessage.)
Public methodPropertyExists
Indicates whether a property value exists.
(Inherited from IMessage.)
Public methodReadBoolean

Reads a bool from the bytes message stream.

Public methodReadByte

Reads a signed 8-bit value from the bytes message stream.

Public methodReadBytes(array<Byte>[]()[][])

Reads a byte array from the bytes message stream.

If the length of array value is less than the number of bytes remaining to be read from the stream, the array should be filled. A subsequent call reads the next increment, and so on.

If the number of bytes remaining in the stream is less than the length of array value, the bytes should be read into the array. The return value of the total number of bytes read will be less than the length of the array, indicating that there are no more bytes left to be read from the stream. The next read of the stream returns -1.

Public methodReadBytes(array<Byte>[]()[][], Int32)

Reads a portion of the bytes message stream.

If the length of array value is less than the number of bytes remaining to be read from the stream, the array should be filled. A subsequent call reads the next increment, and so on.

If the number of bytes remaining in the stream is less than the length of array value, the bytes should be read into the array. The return value of the total number of bytes read will be less than the length of the array, indicating that there are no more bytes left to be read from the stream. The next read of the stream returns -1.

If length is negative, or length is greater than the length of the array value, then an IndexOutOfRangeException is thrown. No bytes will be read from the stream for this exception case.

Public methodReadChar

Reads a Unicode character value from the bytes message stream.

Public methodReadDouble

Reads a double from the bytes message stream.

Public methodReadFloat

Reads a float from the bytes message stream.

Public methodReadInt

Reads a signed 32-bit integer from the bytes message stream.

Public methodReadLong

Reads a signed 64-bit integer from the bytes message stream.

Public methodReadShort

Reads a signed 16-bit number from the bytes message stream.

Public methodReadUnsignedByte

Reads an unsigned 8-bit number from the bytes message stream.

Public methodReadUnsignedShort

Reads an unsigned 16-bit number from the bytes message stream.

Public methodReadUTF

Reads a string that has been encoded using a modified UTF-8 format from the bytes message stream.

For more information on the UTF-8 format, see "File System Safe UCS Transformation Format (FSS_UTF)", X/Open Preliminary Specification, X/Open Company Ltd., Document Number: P316. This information also appears in ISO/IEC 10646, Annex P.

Public methodReset

Puts the message body in read-only mode and repositions the stream of bytes to the beginning.

Public methodSetBooleanProperty
Sets a boolean property value with the specified name into the message.
(Inherited from IMessage.)
Public methodSetByteProperty
Sets a byte property value with the specified name into the message.
(Inherited from IMessage.)
Public methodSetDoubleProperty
Sets a double property value with the specified name into the message.
(Inherited from IMessage.)
Public methodSetFloatProperty
Sets a float property value with the specified name into the message.
(Inherited from IMessage.)
Public methodSetIntProperty
Sets an int property value with the specified name into the message.
(Inherited from IMessage.)
Public methodSetLongProperty
Sets a long property value with the specified name into the message.
(Inherited from IMessage.)
Public methodSetObjectProperty
Sets a object property value with the specified name into the message.

Note that this method works only for the objectified primitive object types (Integer, Double, Long ...) and String objects.

(Inherited from IMessage.)
Public methodSetShortProperty
Sets a short property value with the specified name into the message.
(Inherited from IMessage.)
Public methodSetStringProperty
Sets a String property value with the specified name into the message.
(Inherited from IMessage.)
Public methodWriteBoolean

Writes a bool to the bytes message stream as a 1-byte value. The value true is written as the value (byte)1; the value false is written as the value (byte)0.

Public methodWriteByte

Writes a byte to the bytes message stream as a 1-byte value.

Public methodWriteBytes(array<Byte>[]()[][])

Writes a byte array to the bytes message stream.

Public methodWriteBytes(array<Byte>[]()[][], Int32, Int32)

Writes a portion of a byte array to the bytes message stream.

Public methodWriteChar

Writes a char to the bytes message stream as a 2-byte value, high byte first.

Public methodWriteDouble

Converts the double argument to a long using the doubleToLongBits method in class Double, and then writes that long value to the bytes message stream as an 8-byte quantity, high byte first.

Public methodWriteFloat

Converts the float argument to an int using the floatToIntBits method in class Float, and then writes that int value to the bytes message stream as a 4-byte quantity, high byte first.

Public methodWriteInt

Writes an int to the bytes message stream as four bytes, high byte first.

Public methodWriteLong

Writes a long to the bytes message stream as eight bytes, high byte first.

Public methodWriteObject

Writes an object to the bytes message stream.

This method works only for the objectified primitive object types (Integer, Double, Long...), String objects, and byte arrays.

Public methodWriteShort

Writes a short to the bytes message stream as two bytes, high byte first.

Public methodWriteUTF

Writes a string to the bytes message stream using UTF-8 encoding in a machine-independent manner.

For more information on the UTF-8 format, see "File System Safe UCS Transformation Format (FSS_UTF)", X/Open Preliminary Specification, X/Open Company Ltd., Document Number: P316. This information also appears in ISO/IEC 10646, Annex P.

See Also