The Message class represents the data published to or consumed from a Nirvana realm. More...
Public Member Functions | |
| Message () | |
| Construct an empty event More... | |
| Message (String tag, byte[] data) | |
| Construct an event using a tag and data payload only More... | |
| Message (Properties properties, byte[] data) | |
| Construct an event using the specified MessageProperties and data payload More... | |
| Message (Properties properties, byte[] data, string tag) | |
| Construct an event using the specified MessageProperties, data payload and tag More... | |
| Message (Properties properties, String tag) | |
| Construct an event using the specified MessageProperties and tag More... | |
Properties | |
| string | Destination [get] |
| Return the name of the Destination (Topic, Queue or DataGroup) this Message was published to More... | |
| long | Id [get] |
| Return the unique number assigned to this Message by the Nirvana realm Server More... | |
| byte[] | Payload [get] |
| Return the payload within this Message More... | |
| bool | Persistent [get, set] |
| Indicate whether the Message is persistently stored on disk (Only supported by Topic / Queues of type Mixed or Persistent) More... | |
| IProperties | Properties [get] |
| Return the Properties for this Message More... | |
| byte[] | PublisherHost [get] |
| Represents the host name or ip address of the publisher of this message. More... | |
| byte[] | PublisherName [get] |
| Represents the subject of the publisher of this message. More... | |
| bool | Redelivered [get] |
| Returns whether a Message has been redelivered More... | |
| int | RedeliveryCount [get] |
| Returns the number of times a message has been delivered / redelivered More... | |
| byte[] | SubscriberHost [get, set] |
| Sets the host name or ip address representing the consumers of this message. More... | |
| IEnumerable< string > | SubscriberNames [get, set] |
| An enumeration of sessions that will be the only consumers of this message. More... | |
| string | Tag [get] |
| Return the 'tag' associated with this Message More... | |
| TimeSpan | Timestamp [get] |
| Represents the timestamp when the server received this message from the publisher. More... | |
| long | TTL [get, set] |
| Specify the TTL (time to live) of the Message being published (Only supported by Topic / Queues of type Mixed) More... | |
 Properties inherited from MyChannels.Nirvana.IMessage | |
The Message class represents the data published to or consumed from a Nirvana realm.
The Message class consists of 3 distinct parts:
The header object contains system specific attributes, set by the Nirvana Realm Server
The properties contain meta data, added by the user in key, value format.
The payload represents the actual data portion of the Message as a byte array.
In addition, a 'tag' can also be used as a high level identifier for each event
| MyChannels.Nirvana.Message.Message | ( | ) |
Construct an empty event
| MyChannels.Nirvana.Message.Message | ( | String | tag, |
| byte[] | data | ||
| ) |
| MyChannels.Nirvana.Message.Message | ( | Properties | properties, |
| byte[] | data | ||
| ) |
Construct an event using the specified MessageProperties and data payload
| properties | the MessageProperties provided for each Message |
| data | the payload data |
| MyChannels.Nirvana.Message.Message | ( | Properties | properties, |
| byte[] | data, | ||
| string | tag | ||
| ) |
| MyChannels.Nirvana.Message.Message | ( | Properties | properties, |
| String | tag | ||
| ) |
|
get |
Return the name of the Destination (Topic, Queue or DataGroup) this Message was published to
|
get |
|
get |
|
getset |
Indicate whether the Message is persistently stored on disk (Only supported by Topic / Queues of type Mixed or Persistent)
|
get |
Return the Properties for this Message
|
get |
Represents the host name or ip address of the publisher of this message.
|
get |
Represents the subject of the publisher of this message.
|
get |
Returns whether a Message has been redelivered
|
get |
Returns the number of times a message has been delivered / redelivered
|
getset |
Sets the host name or ip address representing the consumers of this message.
By setting this, only connections matching the host name or ip address will consume this event. Wildcard * are also supported, so you can have *.abc.com fore example
| host | the host name or ip address of connections that will consume this event |
|
getset |
An enumeration of sessions that will be the only consumers of this message.
By setting this, no other subscribers, either on a queue or channel will consume this event.
|
get |
Return the 'tag' associated with this Message
|
get |
Represents the timestamp when the server received this message from the publisher.
|
getset |
Specify the TTL (time to live) of the Message being published (Only supported by Topic / Queues of type Mixed)