The IBytesMessage type exposes the following members.
Methods
Name | Description | |
---|---|---|
Acknowledge |
If using client acknowledgement mode on the session, then this method will acknowledge that the
message has been processed correctly.
(Inherited from IMessage.) | |
ClearBody |
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.) | |
ClearProperties |
Clears a message's properties.
The message's header fields and body are not cleared.
(Inherited from IMessage.) | |
ReadBoolean |
Reads a boolean from the Message Stream.
| |
ReadByte |
Reads a byte from the 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 Exception is thrown. No bytes will be read from the stream for this
exception case.
| |
ReadChar |
Reads a char from the Message Stream.
| |
ReadDouble |
Reads an double from the Message Stream.
| |
ReadInt16 |
Reads a Short from the Message Stream.
| |
ReadInt32 |
Reads an int from the Message Stream.
| |
ReadInt64 |
Reads a long from the Message Stream.
| |
ReadSingle |
Reads a float from the Message Stream.
| |
ReadString |
Reads a string that has been encoded using a modified UTF-8 format from the bytes
message stream.
| |
Reset |
Puts the message body in read-only mode and repositions the stream of bytes to the beginning.
| |
WriteBoolean |
Write a one byte value to the message stream representing the boolean
value passed.
| |
WriteByte |
Writes a byte to the Message stream.
| |
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 |
Write a two byte value to the message stream representing the character
value passed. High byte first.
| |
WriteDouble |
Write a eight byte value to the message stream representing the double
value passed. High byte first.
| |
WriteInt16 |
Write a two byte value to the message stream representing the short
value passed. High byte first.
| |
WriteInt32 |
Write a four byte value to the message stream representing the integer
value passed. High byte first.
| |
WriteInt64 |
Write a eight byte value to the message stream representing the long
value passed. High byte first.
| |
WriteObject |
Writes an object to the bytes message stream.
This method works only for the objectified primitive object types
(Int32, Double, Boolean ...), String objects, and byte arrays.
| |
WriteSingle |
Write a four byte value to the message stream representing the float
value passed. High byte first.
| |
WriteString |
Writes a string to the bytes message stream using UTF-8 encoding in a
machine-independent manner.
|
Extension Methods
Name | Description | |
---|---|---|
ToObject()()()() | Overloaded.
Deserializes the object from Xml, and returns it.
(Defined by MessageExtensions.) | |
ToObject<(Of <<'(T>)>>)()()()() | Overloaded.
Deserializes the object from Xml, and returns it.
(Defined by MessageExtensions.) |
Properties
Name | Description | |
---|---|---|
BodyLength | ||
Content | ||
NMSCorrelationID |
The correlation ID used to correlate messages from conversations or long running business processes.
(Inherited from IMessage.) | |
NMSDeliveryMode |
Whether or not this message is persistent.
(Inherited from IMessage.) | |
NMSDestination |
The destination of the message. This property is set by the IMessageProducer.
(Inherited from IMessage.) | |
NMSMessageId |
The message ID which is set by the provider.
(Inherited from IMessage.) | |
NMSPriority |
The Priority of this message.
(Inherited from IMessage.) | |
NMSRedelivered |
Returns true if this message has been redelivered to this or another consumer before being acknowledged successfully.
(Inherited from IMessage.) | |
NMSReplyTo |
The destination that the consumer of this message should send replies to
(Inherited from IMessage.) | |
NMSTimestamp |
The timestamp of when the message was pubished in UTC time. If the publisher disables setting
the timestamp on the message, the time will be set to the start of the UNIX epoc (1970-01-01 00:00:00).
(Inherited from IMessage.) | |
NMSTimeToLive |
The amount of time for which this message is valid. Zero if this message does not expire.
(Inherited from IMessage.) | |
NMSType |
The type name of this message.
(Inherited from IMessage.) | |
Properties |
Provides access to the message properties (headers).
(Inherited from IMessage.) |