MyChannels.Nirvana.IMessage Interface Reference

More...

Inheritance diagram for MyChannels.Nirvana.IMessage:
MyChannels.Nirvana.Message

Properties

string Destination [get]
 Return the name of the Destination (channel or queue) 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]
 Specify the TTL (time to live) of the Message being published (Only supported by Topic / Queues of type Mixed) More...
 
IProperties Properties [get]
 Return the MessageProperties for this Message More...
 
byte[] PublisherHost [get]
 Represents the host name or ip address representing 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]
 Represents 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 form the publisher. More...
 
long TTL [get, set]
 Specify the TTL (time to live) of the Message being published More...
 

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

long MyChannels.Nirvana.IMessage.Id
get

Return the unique number assigned to this Message by the Nirvana realm Server

byte [] MyChannels.Nirvana.IMessage.Payload
get

Return the payload within this Message

bool MyChannels.Nirvana.IMessage.Persistent
getset

Specify the TTL (time to live) of the Message being published (Only supported by Topic / Queues of type Mixed)

IProperties MyChannels.Nirvana.IMessage.Properties
get

Return the MessageProperties for this Message

Returns
The MessageProperties, or meta data associated with this Message
byte [] MyChannels.Nirvana.IMessage.PublisherHost
get

Represents the host name or ip address representing the publisher of this message.

byte [] MyChannels.Nirvana.IMessage.PublisherName
get

Represents the subject of the publisher of this message.

bool MyChannels.Nirvana.IMessage.Redelivered
get

Returns whether a Message has been redelivered

int MyChannels.Nirvana.IMessage.RedeliveryCount
get

Returns the number of times a message has been delivered / redelivered

byte [] MyChannels.Nirvana.IMessage.SubscriberHost
getset

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

IEnumerable<string> MyChannels.Nirvana.IMessage.SubscriberNames
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.

string MyChannels.Nirvana.IMessage.Tag
get

Return the 'tag' associated with this Message

TimeSpan MyChannels.Nirvana.IMessage.Timestamp
get

Represents the timestamp when the server received this message form the publisher.

long MyChannels.Nirvana.IMessage.TTL
getset

Specify the TTL (time to live) of the Message being published