javax::jms::BytesMessage Class Reference

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

#include <javax_jms_BytesMessage.h>

Inheritance diagram for javax::jms::BytesMessage:

[legend]Collaboration diagram for javax::jms::BytesMessage:

[legend]List of all members.

Public Types
enum	{   xmogDefaultFlags = xmog_base::GLOBAL, xmogMajorVersion = 3, xmogMinorVersion = 2, xmogPatchVersion = 9,   xmogBuildNumber = 2047 }
typedef ::xmog_java_array_template< ::javax::jms::BytesMessage >	array1D
typedef ::xmog_java_array_template< ::xmog_java_array_template< ::javax::jms::BytesMessage > >	array2D
Public Member Functions
virtual jlong	getBodyLength (::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
	Gets the number of bytes of the message body when the message is in read-only mode.
virtual bool	readBoolean (::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
	Reads a boolean from the bytes message stream.
virtual jbyte	readByte (::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
	Reads a signed 8-bit value from the bytes message stream.
virtual jint	readBytes (const ::xmog_java_byte_array &value, jint length,::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
	Reads a portion of the bytes message stream.
virtual jint	readBytes (const ::xmog_java_byte_array &value,::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
	Reads a byte array from the bytes message stream.
virtual jchar	readChar (::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
	Reads a Unicode character value from the bytes message stream.
virtual jdouble	readDouble (::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
	Reads a double from the bytes message stream.
virtual jfloat	readFloat (::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
	Reads a float from the bytes message stream.
virtual jint	readInt (::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
	Reads a signed 32-bit integer from the bytes message stream.
virtual jlong	readLong (::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
	Reads a signed 64-bit integer from the bytes message stream.
virtual jshort	readShort (::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
	Reads a signed 16-bit number from the bytes message stream.
virtual jint	readUnsignedByte (::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
	Reads an unsigned 8-bit number from the bytes message stream.
virtual jint	readUnsignedShort (::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
	Reads an unsigned 16-bit number from the bytes message stream.
virtual ::java::lang::String	readUTF (::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
	Reads a string that has been encoded using a modified UTF-8 format from the bytes message stream.
virtual void	reset (::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
	Puts the message body in read-only mode and repositions the stream of bytes to the beginning.
virtual void	writeBoolean (bool value,::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
	Writes a boolean to the bytes message stream as a 1-byte value.
virtual void	writeByte (jbyte value,::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
	Writes a byte to the bytes message stream as a 1-byte value.
virtual void	writeBytes (const ::xmog_java_byte_array &value, jint offset, jint length,::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
	Writes a portion of a byte array to the bytes message stream.
virtual void	writeBytes (const ::xmog_java_byte_array &value,::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
	Writes a byte array to the bytes message stream.
virtual void	writeChar (jchar value,::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
	Writes a char to the bytes message stream as a 2-byte value, high byte first.
virtual void	writeDouble (jdouble value,::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
	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.
virtual void	writeFloat (jfloat value,::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
	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.
virtual void	writeInt (jint value,::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
	Writes an int to the bytes message stream as four bytes, high byte first.
virtual void	writeLong (jlong value,::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
	Writes a long to the bytes message stream as eight bytes, high byte first.
virtual void	writeObject (const ::java::lang::Object &value,::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
	Writes an object to the bytes message stream.
virtual void	writeShort (jshort value,::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
	Writes a short to the bytes message stream as two bytes, high byte first.
virtual void	writeUTF (const ::java::lang::String &value,::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
	Writes a string to the bytes message stream using UTF-8 encoding in a machine-independent manner.

---

Detailed Description

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.

The BytesMessage methods are based largely on those found in java.io.DataInputStream and java.io.DataOutputStream.

This message type is for client encoding of existing message formats. If possible, one of the other self-defining message types should be used instead.

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.

The primitive types can be written explicitly using methods for each type. They may also be written generically as objects. For instance, a call to BytesMessage.writeInt(6) is equivalent to BytesMessage.writeObject(new Integer(6)). Both forms are provided, because the explicit form is convenient for static programming, and the object form is needed when types are not known at compile time.

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.

Author:

Mark Hapner

Rich Burridge

Kate Stout

---

Member Function Documentation

virtual jlong javax::jms::BytesMessage::getBodyLength (  ::xmog_localenv *  p_xenv = NULL, xmog_flags  f_xflags = xmogDefaultFlags )  [virtual]

Gets the number of bytes of the message body when the message is in read-only mode. The value returned can be used to allocate a byte array. The value returned is the entire length of the message body, regardless of where the pointer for reading the message is currently located. Parameters: p_xenv  the local call environment. The default value is NULL. f_xflags  the flags that allow control over the reference type and other internal matters. The default value is xmog_base::GLOBAL. Returns: number of bytes in the message

virtual bool javax::jms::BytesMessage::readBoolean (  ::xmog_localenv *  p_xenv = NULL, xmog_flags  f_xflags = xmogDefaultFlags )  [virtual]

Reads a boolean from the bytes message stream. Parameters: p_xenv  the local call environment. The default value is NULL. f_xflags  the flags that allow control over the reference type and other internal matters. The default value is xmog_base::GLOBAL. Returns: the boolean value read

virtual jbyte javax::jms::BytesMessage::readByte (  ::xmog_localenv *  p_xenv = NULL, xmog_flags  f_xflags = xmogDefaultFlags )  [virtual]

Reads a signed 8-bit value from the bytes message stream. Parameters: p_xenv  the local call environment. The default value is NULL. f_xflags  the flags that allow control over the reference type and other internal matters. The default value is xmog_base::GLOBAL. Returns: the next byte from the bytes message stream as a signed 8-bit byte

virtual jint javax::jms::BytesMessage::readBytes (  const ::xmog_java_byte_array &  value, jint  length, ::xmog_localenv *  p_xenv = NULL, xmog_flags  f_xflags = xmogDefaultFlags )  [virtual]

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 IndexOutOfBoundsException is thrown. No bytes will be read from the stream for this exception case. Parameters: value  the buffer into which the data is read length  the number of bytes to read; must be less than or equal to value.length p_xenv  the local call environment. The default value is NULL. f_xflags  the flags that allow control over the reference type and other internal matters. The default value is xmog_base::GLOBAL. Returns: 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

virtual jint javax::jms::BytesMessage::readBytes (  const ::xmog_java_byte_array &  value, ::xmog_localenv *  p_xenv = NULL, xmog_flags  f_xflags = xmogDefaultFlags )  [virtual]

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. Parameters: value  the buffer into which the data is read p_xenv  the local call environment. The default value is NULL. f_xflags  the flags that allow control over the reference type and other internal matters. The default value is xmog_base::GLOBAL. Returns: 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

virtual jchar javax::jms::BytesMessage::readChar (  ::xmog_localenv *  p_xenv = NULL, xmog_flags  f_xflags = xmogDefaultFlags )  [virtual]

Reads a Unicode character value from the bytes message stream. Parameters: p_xenv  the local call environment. The default value is NULL. f_xflags  the flags that allow control over the reference type and other internal matters. The default value is xmog_base::GLOBAL. Returns: the next two bytes from the bytes message stream as a Unicode character

virtual jdouble javax::jms::BytesMessage::readDouble (  ::xmog_localenv *  p_xenv = NULL, xmog_flags  f_xflags = xmogDefaultFlags )  [virtual]

Reads a double from the bytes message stream. Parameters: p_xenv  the local call environment. The default value is NULL. f_xflags  the flags that allow control over the reference type and other internal matters. The default value is xmog_base::GLOBAL. Returns: the next eight bytes from the bytes message stream, interpreted as a double

virtual jfloat javax::jms::BytesMessage::readFloat (  ::xmog_localenv *  p_xenv = NULL, xmog_flags  f_xflags = xmogDefaultFlags )  [virtual]

Reads a float from the bytes message stream. Parameters: p_xenv  the local call environment. The default value is NULL. f_xflags  the flags that allow control over the reference type and other internal matters. The default value is xmog_base::GLOBAL. Returns: the next four bytes from the bytes message stream, interpreted as a float

virtual jint javax::jms::BytesMessage::readInt (  ::xmog_localenv *  p_xenv = NULL, xmog_flags  f_xflags = xmogDefaultFlags )  [virtual]

Reads a signed 32-bit integer from the bytes message stream. Parameters: p_xenv  the local call environment. The default value is NULL. f_xflags  the flags that allow control over the reference type and other internal matters. The default value is xmog_base::GLOBAL. Returns: the next four bytes from the bytes message stream, interpreted as an int

virtual jlong javax::jms::BytesMessage::readLong (  ::xmog_localenv *  p_xenv = NULL, xmog_flags  f_xflags = xmogDefaultFlags )  [virtual]

Reads a signed 64-bit integer from the bytes message stream. Parameters: p_xenv  the local call environment. The default value is NULL. f_xflags  the flags that allow control over the reference type and other internal matters. The default value is xmog_base::GLOBAL. Returns: the next eight bytes from the bytes message stream, interpreted as a long

virtual jshort javax::jms::BytesMessage::readShort (  ::xmog_localenv *  p_xenv = NULL, xmog_flags  f_xflags = xmogDefaultFlags )  [virtual]

Reads a signed 16-bit number from the bytes message stream. Parameters: p_xenv  the local call environment. The default value is NULL. f_xflags  the flags that allow control over the reference type and other internal matters. The default value is xmog_base::GLOBAL. Returns: the next two bytes from the bytes message stream, interpreted as a signed 16-bit number

virtual jint javax::jms::BytesMessage::readUnsignedByte (  ::xmog_localenv *  p_xenv = NULL, xmog_flags  f_xflags = xmogDefaultFlags )  [virtual]

Reads an unsigned 8-bit number from the bytes message stream. Parameters: p_xenv  the local call environment. The default value is NULL. f_xflags  the flags that allow control over the reference type and other internal matters. The default value is xmog_base::GLOBAL. Returns: the next byte from the bytes message stream, interpreted as an unsigned 8-bit number

virtual jint javax::jms::BytesMessage::readUnsignedShort (  ::xmog_localenv *  p_xenv = NULL, xmog_flags  f_xflags = xmogDefaultFlags )  [virtual]

Reads an unsigned 16-bit number from the bytes message stream. Parameters: p_xenv  the local call environment. The default value is NULL. f_xflags  the flags that allow control over the reference type and other internal matters. The default value is xmog_base::GLOBAL. Returns: the next two bytes from the bytes message stream, interpreted as an unsigned 16-bit integer

virtual ::java::lang::String javax::jms::BytesMessage::readUTF (  ::xmog_localenv *  p_xenv = NULL, xmog_flags  f_xflags = xmogDefaultFlags )

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. Parameters: p_xenv  the local call environment. The default value is NULL. f_xflags  the flags that allow control over the reference type and other internal matters. The default value is xmog_base::GLOBAL. Returns: a Unicode string from the bytes message stream

virtual void javax::jms::BytesMessage::reset (  ::xmog_localenv *  p_xenv = NULL, xmog_flags  f_xflags = xmogDefaultFlags )  [virtual]

Puts the message body in read-only mode and repositions the stream of bytes to the beginning. Parameters: p_xenv  the local call environment. The default value is NULL. f_xflags  the flags that allow control over the reference type and other internal matters. The default value is xmog_base::GLOBAL. Returns:

virtual void javax::jms::BytesMessage::writeBoolean (  bool  value, ::xmog_localenv *  p_xenv = NULL, xmog_flags  f_xflags = xmogDefaultFlags )  [virtual]

Writes a 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. Parameters: value  the boolean value to be written p_xenv  the local call environment. The default value is NULL. f_xflags  the flags that allow control over the reference type and other internal matters. The default value is xmog_base::GLOBAL. Returns:

virtual void javax::jms::BytesMessage::writeByte (  jbyte  value, ::xmog_localenv *  p_xenv = NULL, xmog_flags  f_xflags = xmogDefaultFlags )  [virtual]

Writes a byte to the bytes message stream as a 1-byte value. Parameters: value  the byte value to be written p_xenv  the local call environment. The default value is NULL. f_xflags  the flags that allow control over the reference type and other internal matters. The default value is xmog_base::GLOBAL. Returns:

virtual void javax::jms::BytesMessage::writeBytes (  const ::xmog_java_byte_array &  value, jint  offset, jint  length, ::xmog_localenv *  p_xenv = NULL, xmog_flags  f_xflags = xmogDefaultFlags )  [virtual]

Writes a portion of a byte array to the bytes message stream. Parameters: value  the byte array value to be written offset  the initial offset within the byte array length  the number of bytes to use p_xenv  the local call environment. The default value is NULL. f_xflags  the flags that allow control over the reference type and other internal matters. The default value is xmog_base::GLOBAL. Returns:

virtual void javax::jms::BytesMessage::writeBytes (  const ::xmog_java_byte_array &  value, ::xmog_localenv *  p_xenv = NULL, xmog_flags  f_xflags = xmogDefaultFlags )  [virtual]

Writes a byte array to the bytes message stream. Parameters: value  the byte array to be written p_xenv  the local call environment. The default value is NULL. f_xflags  the flags that allow control over the reference type and other internal matters. The default value is xmog_base::GLOBAL. Returns:

virtual void javax::jms::BytesMessage::writeChar (  jchar  value, ::xmog_localenv *  p_xenv = NULL, xmog_flags  f_xflags = xmogDefaultFlags )  [virtual]

Writes a char to the bytes message stream as a 2-byte value, high byte first. Parameters: value  the char value to be written p_xenv  the local call environment. The default value is NULL. f_xflags  the flags that allow control over the reference type and other internal matters. The default value is xmog_base::GLOBAL. Returns:

virtual void javax::jms::BytesMessage::writeDouble (  jdouble  value, ::xmog_localenv *  p_xenv = NULL, xmog_flags  f_xflags = xmogDefaultFlags )  [virtual]

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. Parameters: value  the double value to be written p_xenv  the local call environment. The default value is NULL. f_xflags  the flags that allow control over the reference type and other internal matters. The default value is xmog_base::GLOBAL. Returns:

virtual void javax::jms::BytesMessage::writeFloat (  jfloat  value, ::xmog_localenv *  p_xenv = NULL, xmog_flags  f_xflags = xmogDefaultFlags )  [virtual]

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. Parameters: value  the float value to be written p_xenv  the local call environment. The default value is NULL. f_xflags  the flags that allow control over the reference type and other internal matters. The default value is xmog_base::GLOBAL. Returns:

virtual void javax::jms::BytesMessage::writeInt (  jint  value, ::xmog_localenv *  p_xenv = NULL, xmog_flags  f_xflags = xmogDefaultFlags )  [virtual]

Writes an int to the bytes message stream as four bytes, high byte first. Parameters: value  the int to be written p_xenv  the local call environment. The default value is NULL. f_xflags  the flags that allow control over the reference type and other internal matters. The default value is xmog_base::GLOBAL. Returns:

virtual void javax::jms::BytesMessage::writeLong (  jlong  value, ::xmog_localenv *  p_xenv = NULL, xmog_flags  f_xflags = xmogDefaultFlags )  [virtual]

Writes a long to the bytes message stream as eight bytes, high byte first. Parameters: value  the long to be written p_xenv  the local call environment. The default value is NULL. f_xflags  the flags that allow control over the reference type and other internal matters. The default value is xmog_base::GLOBAL. Returns:

virtual void javax::jms::BytesMessage::writeObject (  const ::java::lang::Object &  value, ::xmog_localenv *  p_xenv = NULL, xmog_flags  f_xflags = xmogDefaultFlags )  [virtual]

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. Parameters: value  the object in the Java programming language ("Java object") to be written; it must not be null p_xenv  the local call environment. The default value is NULL. f_xflags  the flags that allow control over the reference type and other internal matters. The default value is xmog_base::GLOBAL. Returns:

virtual void javax::jms::BytesMessage::writeShort (  jshort  value, ::xmog_localenv *  p_xenv = NULL, xmog_flags  f_xflags = xmogDefaultFlags )  [virtual]

Writes a short to the bytes message stream as two bytes, high byte first. Parameters: value  the short to be written p_xenv  the local call environment. The default value is NULL. f_xflags  the flags that allow control over the reference type and other internal matters. The default value is xmog_base::GLOBAL. Returns:

virtual void javax::jms::BytesMessage::writeUTF (  const ::java::lang::String &  value, ::xmog_localenv *  p_xenv = NULL, xmog_flags  f_xflags = xmogDefaultFlags )  [virtual]

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. Parameters: value  the String value to be written p_xenv  the local call environment. The default value is NULL. f_xflags  the flags that allow control over the reference type and other internal matters. The default value is xmog_base::GLOBAL. Returns:

---

The documentation for this class was generated from the following file:

• javax_jms_BytesMessage.h

---