Interface IMessage
Represents a message either to be sent to a message broker or received from a message broker.
Assembly: Apache.NMS.dll
Syntax
public interface IMessage
Properties
|
Improve this Doc
View Source
NMSCorrelationID
The correlation ID used to correlate messages from conversations or long running business processes.
Declaration
string NMSCorrelationID { get; set; }
Property Value
Type |
Description |
System.String |
|
|
Improve this Doc
View Source
NMSCorrelationIDAsBytes
Declaration
byte[] NMSCorrelationIDAsBytes { get; set; }
Property Value
Type |
Description |
System.Byte[] |
|
|
Improve this Doc
View Source
NMSDeliveryMode
Whether or not this message is persistent.
Declaration
MsgDeliveryMode NMSDeliveryMode { get; set; }
Property Value
|
Improve this Doc
View Source
NMSDeliveryTime
Declaration
DateTime NMSDeliveryTime { get; set; }
Property Value
Type |
Description |
System.DateTime |
|
|
Improve this Doc
View Source
NMSDestination
The destination of the message. This property is set by the IMessageProducer.
Declaration
IDestination NMSDestination { get; set; }
Property Value
|
Improve this Doc
View Source
NMSExpiration
Declaration
DateTime NMSExpiration { get; set; }
Property Value
Type |
Description |
System.DateTime |
|
|
Improve this Doc
View Source
NMSMessageId
The message ID which is set by the provider.
Declaration
string NMSMessageId { get; set; }
Property Value
Type |
Description |
System.String |
|
|
Improve this Doc
View Source
NMSPriority
The Priority of this message.
Declaration
MsgPriority NMSPriority { get; set; }
Property Value
|
Improve this Doc
View Source
NMSRedelivered
Returns true if this message has been redelivered to this or another consumer before being acknowledged successfully.
Declaration
bool NMSRedelivered { get; set; }
Property Value
Type |
Description |
System.Boolean |
|
|
Improve this Doc
View Source
NMSReplyTo
The destination that the consumer of this message should send replies to
Declaration
IDestination NMSReplyTo { get; set; }
Property Value
|
Improve this Doc
View Source
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).
Declaration
DateTime NMSTimestamp { get; set; }
Property Value
Type |
Description |
System.DateTime |
|
|
Improve this Doc
View Source
NMSTimeToLive
The amount of time for which this message is valid. Zero if this message does not expire.
Declaration
TimeSpan NMSTimeToLive { get; set; }
Property Value
Type |
Description |
System.TimeSpan |
|
|
Improve this Doc
View Source
NMSType
The type name of this message.
Declaration
string NMSType { get; set; }
Property Value
Type |
Description |
System.String |
|
|
Improve this Doc
View Source
Properties
Provides access to the message properties (headers).
Declaration
IPrimitiveMap Properties { get; }
Property Value
Methods
|
Improve this Doc
View Source
Acknowledge()
If using client acknowledgement mode on the session, then this method will acknowledge that the
message has been processed correctly.
Declaration
|
Improve this Doc
View Source
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.
Declaration
|
Improve this Doc
View Source
ClearProperties()
Clears a message's properties.
The message's header fields and body are not cleared.
Declaration
|
Improve this Doc
View Source
GetBody<T>()
Declaration
Returns
Type Parameters
|
Improve this Doc
View Source
IsBodyAssignableTo<T>()
Declaration
bool IsBodyAssignableTo<T>()
Returns
Type |
Description |
System.Boolean |
|
Type Parameters