The IBytesMessage type exposes the following members.
Methods
| Name | Description | |
|---|---|---|
| Acknowledge |
Acknowledges all consumed messages of the session of this consumed
message.
(Inherited from IMessage.)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. | |
| ClearBody |
Clears out the message body. Clearing a message's body does not clear
its header values or property entries.
(Inherited from IMessage.)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. | |
| ClearProperties |
Clears a message's properties.
(Inherited from IMessage.)The message's header fields and body are not cleared. | |
| GetBooleanProperty |
Returns the value of the boolean property with the
specified name.
(Inherited from IMessage.) | |
| GetByteProperty |
Returns the value of the byte property with the specified
name.
(Inherited from IMessage.) | |
| GetDoubleProperty |
Returns the value of the double property with the specified
name.
(Inherited from IMessage.) | |
| GetFloatProperty |
Returns the value of the float property with the specified
name.
(Inherited from IMessage.) | |
| GetIntProperty |
Returns the value of the int property with the specified
name.
(Inherited from IMessage.) | |
| GetLongProperty |
Returns the value of the long property with the specified
name.
(Inherited from IMessage.) | |
| GetObjectProperty |
Returns the value of the object property with the specified name.
(Inherited from IMessage.)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. | |
| GetShortProperty |
Returns the value of the short property with the specified
name.
(Inherited from IMessage.) | |
| GetStringProperty |
Returns the value of the String property with the specified
name.
(Inherited from IMessage.) | |
| PropertyExists |
Indicates whether a property value exists.
(Inherited from IMessage.) | |
| ReadBoolean | Reads a bool from the bytes message stream. | |
| ReadByte | Reads a signed 8-bit value from the bytes message stream. | |
| ReadBytes(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. | |
| ReadBytes(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. | |
| ReadChar | Reads a Unicode character value from the bytes message stream. | |
| ReadDouble | Reads a double from the bytes message stream. | |
| ReadFloat | Reads a float from the bytes message stream. | |
| ReadInt | Reads a signed 32-bit integer from the bytes message stream. | |
| ReadLong | Reads a signed 64-bit integer from the bytes message stream. | |
| ReadShort | Reads a signed 16-bit number from the bytes message stream. | |
| ReadUnsignedByte | Reads an unsigned 8-bit number from the bytes message stream. | |
| ReadUnsignedShort | Reads an unsigned 16-bit number from the bytes message stream. | |
| ReadUTF | 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. | |
| Reset | Puts the message body in read-only mode and repositions the stream of bytes to the beginning. | |
| SetBooleanProperty |
Sets a boolean property value with the specified name into
the message.
(Inherited from IMessage.) | |
| SetByteProperty |
Sets a byte property value with the specified name into
the message.
(Inherited from IMessage.) | |
| SetDoubleProperty |
Sets a double property value with the specified name into
the message.
(Inherited from IMessage.) | |
| SetFloatProperty |
Sets a float property value with the specified name into
the message.
(Inherited from IMessage.) | |
| SetIntProperty |
Sets an int property value with the specified name into
the message.
(Inherited from IMessage.) | |
| SetLongProperty |
Sets a long property value with the specified name into
the message.
(Inherited from IMessage.) | |
| SetObjectProperty |
Sets a object property value with the specified name into the
message.
(Inherited from IMessage.)Note that this method works only for the objectified primitive object types (Integer, Double, Long ...) and String objects. | |
| SetShortProperty |
Sets a short property value with the specified name into
the message.
(Inherited from IMessage.) | |
| SetStringProperty |
Sets a String property value with the specified name into
the message.
(Inherited from IMessage.) | |
| WriteBoolean | 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. | |
| WriteByte | Writes a byte to the bytes message stream as a 1-byte value. | |
| WriteBytes(array<Byte>[]()[][]) | Writes a byte array to the bytes message stream. | |
| WriteBytes(array<Byte>[]()[][], Int32, Int32) | Writes a portion of a byte array to the bytes message stream. | |
| WriteChar | Writes a char to the bytes message stream as a 2-byte value, high byte first. | |
| WriteDouble | 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. | |
| WriteFloat | 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. | |
| WriteInt | Writes an int to the bytes message stream as four bytes, high byte first. | |
| WriteLong | Writes a long to the bytes message stream as eight bytes, high byte first. | |
| WriteObject | 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. | |
| WriteShort | Writes a short to the bytes message stream as two bytes, high byte first. | |
| WriteUTF | 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. |
Properties
| Name | Description | |
|---|---|---|
| BodyLength |
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.
| |
| JMSCorrelationID |
Sets the correlation ID for the message.
(Inherited from IMessage.)A client can use the JMSCorrelationID header field to link one message with another. A typical use is to link a response message with its request message. JMSCorrelationID can hold one of the following:
Since each message sent by a JMS provider is assigned a message ID value, it is convenient to link messages via message ID. All message ID values must start with the 'ID:' prefix. In some cases, an application (made up of several clients) needs to use an application-specific value for linking messages. For instance, an application may use JMSCorrelationID to hold a value referencing some external information. Application-specified values must not start with the 'ID:' prefix; this is reserved for provider-generated message ID values. If a provider supports the native concept of correlation ID, a JMS client may need to assign specific JMSCorrelationID values to match those expected by clients that do not use the JMS API. A byte[] value is used for this purpose. JMS providers without native correlation ID values are not required to support byte[] values. The use of a byte[] value for JMSCorrelationID is non-portable. | |
| JMSCorrelationIDAsBytes |
Sets the correlation ID as an array of bytes for the message.
(Inherited from IMessage.)The array is copied before the method returns, so future modifications to the array will not alter this message header. If a provider supports the native concept of correlation ID, a JMS client may need to assign specific JMSCorrelationID values to match those expected by native messaging clients. JMS providers without native correlation ID values are not required to support this method and its corresponding get method; The use of a byte[] value for JMSCorrelationID is non-portable. | |
| JMSDeliveryMode |
Gets the DeliveryMode value specified for this message.
(Inherited from IMessage.) | |
| JMSDestination |
Gets the Destination object for this message.
(Inherited from IMessage.)The JMSDestination header field contains the destination to which the message is being sent. When a message is sent, this field is ignored. After completion of the send or publish method, the field holds the destination specified by the method. When a message is received, its JMSDestination value must be equivalent to the value assigned when it was sent. | |
| JMSExpiration |
Gets the message's expiration value.
(Inherited from IMessage.)When a message is sent, the JMSExpiration header field is left unassigned. After completion of the send or publish method, it holds the expiration time of the message. This is the sum of the time-to-live value specified by the client and the GMT at the time of the send or publish. If the time-to-live is specified as zero, JMSExpiration is set to zero to indicate that the message does not expire. When a message's expiration time is reached, a provider should discard it. The JMS API does not define any form of notification of message expiration. Clients should not receive messages that have expired; however, the JMS API does not guarantee that this will not happen. | |
| JMSMessageID |
Sets the message ID.
(Inherited from IMessage.)JMS providers set this field when a message is sent. This method can be used to change the value for a message that has been received. | |
| JMSPriority |
Gets the message priority level.
(Inherited from IMessage.)The JMS API defines ten levels of priority value, with 0 as the lowest priority and 9 as the highest. In addition, clients should consider priorities 0-4 as gradations of normal priority and priorities 5-9 as gradations of expedited priority. The JMS API does not require that a provider strictly implement priority ordering of messages; however, it should do its best to deliver expedited messages ahead of normal messages. | |
| JMSRedelivered |
Specifies whether this message is being redelivered.
(Inherited from IMessage.)This field is set at the time the message is delivered. This method can be used to change the value for a message that has been received. | |
| JMSReplyTo | Sets the Destination object to which a reply to this message should be sent. The JMSReplyTo header field contains the destination where a reply to the current message should be sent. If it is null, no reply is expected. The destination may be either a Queue object or a Topic object. Messages sent with a null JMSReplyTo value may be a notification of some event, or they may just be some data the sender thinks is of interest. Messages with a JMSReplyTo value typically expect a response. A response is optional; it is up to the client to decide. These messages are called requests. A message sent in response to a request is called a reply. In some cases a client may wish to match a request it sent earlier with a reply it has just received. The client can use the JMSCorrelationID header field for this purpose. | |
| JMSTimestamp |
Sets the message timestamp.
(Inherited from IMessage.)JMS providers set this field when a message is sent. This method can be used to change the value for a message that has been received. | |
| JMSType |
Sets the message type.
(Inherited from IMessage.)Some JMS providers use a message repository that contains the definitions of messages sent by applications. The JMSType header field may reference a message's definition in the provider's repository. The JMS API does not define a standard message definition repository, nor does it define a naming policy for the definitions it contains. Some messaging systems require that a message type definition for each application message be created and that each message specify its type. In order to work with such JMS providers, JMS clients should assign a value to JMSType, whether the application makes use of it or not. This ensures that the field is properly set for those providers that require it. To ensure portability, JMS clients should use symbolic values for JMSType that can be configured at installation time to the values defined in the current provider's message repository. If string literals are used, they may not be valid type names for some JMS providers. | |
| PropertyNames |
Returns an Enumeration of all the property names.
(Inherited from IMessage.)Note that JMS standard header fields are not considered properties and are not returned in this enumeration. |