MyChannels.Nirvana.IMessage Interface Reference
The Message class represents the data published to or consumed from a Nirvana realm. More...
Properties | |
| string | Destination [get] |
| Return the name of the Destination (channel or queue) this Message was published to. | |
| long | Id [get] |
| Return the unique number assigned to this Message by the Nirvana realm Server. | |
| byte[] | Payload [get] |
| Return the payload within this Message. | |
| IProperties | Properties [get] |
| Return the MessageProperties for this Message. | |
| byte[] | PublisherHost [get] |
| Represents the host name or ip address representing the publisher of this message. | |
| byte[] | PublisherName [get] |
| Represents the subject of the publisher of this message. | |
| byte[] | SubscriberHost [get, set] |
| Represents the host name or ip address representing the consumers of this message. | |
| byte[] | SubscriberName [get, set] |
| Represents the session name that will be the only consumer of this message. | |
| string | Tag [get] |
| Return the 'tag' associated with this Message. | |
| TimeSpan | Timestamp [get] |
| Represents the timestamp when the server received this message form the publisher. | |
Detailed Description
The Message class represents the data published to or consumed from a Nirvana realm.The Message class consists of 3 distinct parts:
1. The header 2. The properties 3. The payload of the event
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
Property Documentation
string MyChannels.Nirvana.IMessage.Destination [get] |
Return the name of the Destination (channel or queue) this Message was published to.
Implemented in MyChannels.Nirvana.Message.
long MyChannels.Nirvana.IMessage.Id [get] |
Return the unique number assigned to this Message by the Nirvana realm Server.
Implemented in MyChannels.Nirvana.Message.
byte [] MyChannels.Nirvana.IMessage.Payload [get] |
IProperties MyChannels.Nirvana.IMessage.Properties [get] |
Return the MessageProperties for this Message.
- Returns:
- The MessageProperties, or meta data associated with this Message
Implemented in MyChannels.Nirvana.Message.
byte [] MyChannels.Nirvana.IMessage.SubscriberHost [get, set] |
Represents 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
Implemented in MyChannels.Nirvana.Message.
byte [] MyChannels.Nirvana.IMessage.SubscriberName [get, set] |
Represents the session name that will be the only consumer of this message.
By setting this, no other subscribers, either on a queue or channel will consume this event.
Implemented in MyChannels.Nirvana.Message.
string MyChannels.Nirvana.IMessage.Tag [get] |
