| SUMMARY: FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
A BytesMessage object is used to send a message containing a
stream of uninterpreted bytes. It inherits from the Message
interface and adds a bytes
message body. The receiver of the message supplies the interpretation
of the bytes.
This message type is for client encoding of existing message formats.
Although the JMS API allows the use of message properties with byte messages, they are typically not used, since the inclusion of properties may affect the format.
When the message is first created, and when clearBody
is called, the body of the message is in write-only mode. After the
first call to reset has been made, the message body is in
read-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 has been received, the provider has called
reset so that the message body is in read-only mode for the client.
If clearBody is called on a message in read-only mode,
the message body is cleared and the message is in write-only mode.
If a client attempts to read a message in write-only mode, a
MessageNotReadableException is thrown.
If a client attempts to write a message in read-only mode, a
MessageNotWriteableException is thrown.
| Constructor Summary | |
BytesMessage()
A BytesMessage object is used to send a message containing a
stream of uninterpreted bytes.
|
|
| Method Summary | |
Number
|
getBodyLength()
Gets the number of bytes of the message body when the message is in read-only mode. |
boolean
|
readBoolean()
Reads a boolean from the bytes message stream.
|
Number
|
readByte()
Reads a signed 8-bit value from the bytes message stream. |
Number
|
readBytes(value, len)
Reads a portion of the bytes message stream. |
String
|
readChar()
Reads a Unicode character value from the bytes message stream. |
Number
|
readDouble()
Reads a double from the bytes message stream.
|
Number
|
readFloat()
Reads a float from the bytes message stream.
|
Number
|
readInt()
Reads a signed 32-bit integer from the bytes message stream. |
Number
|
readLong()
Reads a signed 64-bit integer from the bytes message stream. |
Number
|
readShort()
Reads a signed 16-bit number from the bytes message stream. |
Number
|
readUnsignedByte()
Reads an unsigned 8-bit number from the bytes message stream. |
Number
|
readUnsignedShort()
Reads an unsigned 16-bit number from the bytes message stream. |
String
|
readUTF()
Reads a string that has been encoded using a modified UTF-8 format from the bytes message stream. |
void
|
reset()
Puts the message body in read-only mode and repositions the stream of bytes to the beginning. |
void
|
writeBoolean(value)
Writes a boolean to the bytes message stream as a 1-byte
value.
|
void
|
writeByte(value)
Writes a byte to the bytes message stream as a 1-byte
value.
|
void
|
writeBytes(value, offset, len)
Writes a portion of a byte array to the bytes message stream. |
void
|
writeChar(value)
Writes a char to the bytes message stream as a 2-byte
value, high byte first.
|
void
|
writeDouble(value)
Writes the double value to the bytes message
stream as an 8-byte quantity.
|
void
|
writeFloat(value)
Writes a float value to the bytes message
stream as a 4-byte quantity.
|
void
|
writeInt(value)
Writes an int to the bytes message stream as four bytes,
high byte first.
|
void
|
writeLong(value)
Writes a long to the bytes message stream as eight bytes,
high byte first.
|
void
|
writeShort(value)
Writes a short to the bytes message stream as two bytes,
high byte first.
|
void
|
writeUTF(value)
Writes a string to the bytes message stream using UTF-8 encoding in a machine-independent manner. |
| Constructor Detail |
BytesMessage()
BytesMessage object is used to send a message containing a
stream of uninterpreted bytes. It inherits from the Message
interface and adds a bytes
message body. The receiver of the message supplies the interpretation
of the bytes.
This message type is for client encoding of existing message formats.
Although the JMS API allows the use of message properties with byte messages, they are typically not used, since the inclusion of properties may affect the format.
When the message is first created, and when clearBody
is called, the body of the message is in write-only mode. After the
first call to reset has been made, the message body is in
read-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 has been received, the provider has called
reset so that the message body is in read-only mode for the client.
If clearBody is called on a message in read-only mode,
the message body is cleared and the message is in write-only mode.
If a client attempts to read a message in write-only mode, a
MessageNotReadableException is thrown.
If a client attempts to write a message in read-only mode, a
MessageNotWriteableException is thrown.
| Method Detail |
Number getBodyLength()
Number number of bytes in the message
JMSException if the JMS provider fails to read the message
due to some internal error.
MessageNotReadableException if the message is in write-only
mode.
boolean readBoolean()
boolean from the bytes message stream.
boolean the boolean value read
JMSException if the JMS provider fails to read the message
due to some internal error.
MessageEOFException if unexpected end of bytes stream has
been reached.
MessageNotReadableException if the message is in write-only
mode.
Number readByte()
Number the next byte from the bytes message stream as a signed 8-bit
byte
JMSException if the JMS provider fails to read the message
due to some internal error.
MessageEOFException if unexpected end of bytes stream has
been reached.
MessageNotReadableException if the message is in write-only
mode.
Number readBytes(value, len)
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 IndexOutOfBoundsException is
thrown. No bytes will be read from the stream for this exception case.
Array value - the buffer into which the data is read
Number len - the number of bytes to read; must be less than or equal to
value.length
Number the total number of bytes read into the buffer, or -1 if
there is no more data because the end of the stream has been reached
JMSException if the JMS provider fails to read the message
due to some internal error.
MessageNotReadableException if the message is in write-only
mode.
String readChar()
String a character encoded as a String representing the next two bytes
from the bytes message stream as a Unicode character
JMSException if the JMS provider fails to read the message
due to some internal error.
MessageEOFException if unexpected end of bytes stream has
been reached.
MessageNotReadableException if the message is in write-only
mode.
Number readDouble()
double from the bytes message stream. (Not Implemented.)
Number the next eight bytes from the bytes message stream, interpreted
as a double
JMSException if the JMS provider fails to read the message
due to some internal error.
MessageEOFException if unexpected end of bytes stream has
been reached.
MessageNotReadableException if the message is in write-only
mode.
Number readFloat()
float from the bytes message stream. (Not Implemented.)
Number the next four bytes from the bytes message stream, interpreted
as a float
JMSException if the JMS provider fails to read the message
due to some internal error.
MessageEOFException if unexpected end of bytes stream has
been reached.
MessageNotReadableException if the message is in write-only
mode.
Number readInt()
Number the next four bytes from the bytes message stream, interpreted
as an int
JMSException if the JMS provider fails to read the message
due to some internal error.
MessageEOFException if unexpected end of bytes stream has
been reached.
MessageNotReadableException if the message is in write-only
mode.
Number readLong()
Number the next eight bytes from the bytes message stream, interpreted
as a long
JMSException if the JMS provider fails to read the message
due to some internal error.
MessageEOFException if unexpected end of bytes stream has
been reached.
MessageNotReadableException if the message is in write-only
mode.
Number readShort()
Number the next two bytes from the bytes message stream, interpreted as
a signed 16-bit number
JMSException if the JMS provider fails to read the message
due to some internal error.
MessageEOFException if unexpected end of bytes stream has
been reached.
MessageNotReadableException if the message is in write-only
mode.
Number readUnsignedByte()
Number the next byte from the bytes message stream, interpreted as an
unsigned 8-bit number
JMSException if the JMS provider fails to read the message
due to some internal error.
MessageEOFException if unexpected end of bytes stream has
been reached.
MessageNotReadableException if the message is in write-only
mode.
Number readUnsignedShort()
Number the next two bytes from the bytes message stream, interpreted as
an unsigned 16-bit integer
JMSException if the JMS provider fails to read the message
due to some internal error.
MessageEOFException if unexpected end of bytes stream has
been reached.
MessageNotReadableException if the message is in write-only
mode.
String readUTF()
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.
String a Unicode string from the bytes message stream
JMSException if the JMS provider fails to read the message
due to some internal error.
MessageEOFException if unexpected end of bytes stream has
been reached.
MessageNotReadableException if the message is in write-only
mode.
void reset()
void
JMSException if the JMS provider fails to reset the message
due to some internal error.
MessageFormatException if the message has an invalid
format.
void writeBoolean(value)
boolean 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.
value - the boolean value to be written
void
JMSException if the JMS provider fails to write the message
due to some internal error.
MessageNotWriteableException if the message is in read-only
mode.
void writeByte(value)
byte to the bytes message stream as a 1-byte
value.
Number value - the byte value to be written
void
JMSException if the JMS provider fails to write the message
due to some internal error.
MessageNotWriteableException if the message is in read-only
mode.
void writeBytes(value, offset, len)
Array value - the byte array value to be written
Number offset - the initial offset within the byte array
Number len - the number of bytes to use
void
JMSException if the JMS provider fails to write the message
due to some internal error.
MessageNotWriteableException if the message is in read-only
mode.
void writeChar(value)
char to the bytes message stream as a 2-byte
value, high byte first.
String value - the char value to be written
void
JMSException if the JMS provider fails to write the message
due to some internal error.
MessageNotWriteableException if the message is in read-only
mode.
void writeDouble(value)
double value to the bytes message
stream as an 8-byte quantity. (Not Implemented.)
Number value - the double value to be written
void
JMSException if the JMS provider fails to write the message
due to some internal error.
MessageNotWriteableException if the message is in read-only
mode.
void writeFloat(value)
float value to the bytes message
stream as a 4-byte quantity. (Not Implemented.)
Number value - the float value to be written
void
JMSException if the JMS provider fails to write the message
due to some internal error.
MessageNotWriteableException if the message is in read-only
mode.
void writeInt(value)
int to the bytes message stream as four bytes,
high byte first.
Number value - the int to be written
void
JMSException if the JMS provider fails to write the message
due to some internal error.
MessageNotWriteableException if the message is in read-only
mode.
void writeLong(value)
long to the bytes message stream as eight bytes,
high byte first. (Not Implemented.)
Number value - the long to be written
void
JMSException if the JMS provider fails to write the message
due to some internal error.
MessageNotWriteableException if the message is in read-only
mode.
void writeShort(value)
short to the bytes message stream as two bytes,
high byte first.
Number value - the short to be written
void
JMSException if the JMS provider fails to write the message
due to some internal error.
MessageNotWriteableException if the message is in read-only
mode.
void writeUTF(value)
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.
String value - the String value to be written
void
JMSException if the JMS provider fails to write the message
due to some internal error.
MessageNotWriteableException if the message is in read-only
mode.