The IStreamMessage 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 stream message.
|
![]() | ReadByte |
Reads a byte from the stream message.
|
![]() | ReadBytes |
Reads a byte array field from the stream message into the specified byte[]
object (the read buffer).
To read the field value, ReadBytes should be successively called until it returns
a value less than the length of the read buffer. The value of the bytes in the
buffer following the last byte read is undefined.
If ReadBytes returns a value equal to the length of the buffer, a subsequent
ReadBytes call must be made. If there are no more bytes to be read, this call
returns -1.
If the byte array field value is null, ReadBytes returns -1.
If the byte array field value is empty, ReadBytes returns 0.
Once the first ReadBytes call on a byte[] field value has been made, the full
value of the field must be read before it is valid to read the next field.
An attempt to read the next field before that has been done will throw a
MessageFormatException.
To read the byte field value into a new byte[] object, use the ReadObject method.
|
![]() | ReadChar |
Reads a char from the stream message.
|
![]() | ReadDouble |
Reads a double from the stream message.
|
![]() | ReadInt16 |
Reads a short from the stream message.
|
![]() | ReadInt32 |
Reads a int from the stream message.
|
![]() | ReadInt64 |
Reads a long from the stream message.
|
![]() | ReadObject |
Reads a Object from the stream message.
|
![]() | ReadSingle |
Reads a float from the stream message.
|
![]() | ReadString |
Reads a string from the stream message.
|
![]() | Reset |
Puts the message body in read-only mode and repositions the stream to the beginning.
|
![]() | WriteBoolean |
Writes a boolean to the stream message.
|
![]() | WriteByte |
Writes a byte to the stream message.
|
![]() | WriteBytes(array<Byte>[]()[][]) |
Writes a byte array field to the stream message.
The byte array value is written to the message as a byte array field.
Consecutively written byte array fields are treated as two distinct
fields when the fields are read.
|
![]() | WriteBytes(array<Byte>[]()[][], Int32, Int32) |
Writes a portion of a byte array as a byte array field to the stream message.
The a portion of the byte array value is written to the message as a byte
array field. Consecutively written byte array fields are treated as two distinct
fields when the fields are read.
|
![]() | WriteChar |
Writes a char to the stream message.
|
![]() | WriteDouble |
Writes a double to the stream message.
|
![]() | WriteInt16 |
Writes a short to the stream message.
|
![]() | WriteInt32 |
Writes a int to the stream message.
|
![]() | WriteInt64 |
Writes a long to the stream message.
|
![]() | WriteObject |
Writes a boolean to the stream message.
|
![]() | WriteSingle |
Writes a float to the stream message.
|
![]() | WriteString |
Writes a string to the stream message.
|
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 | |
---|---|---|
![]() | 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.) |