MyChannels.Nirvana.IDataGroupSession Interface Reference

Defines DataGroup operations available in a session. More...

Inherited by MyChannels.Nirvana.InternalSession.

Public Member Functions

IDataGroupBatch CreateBatch (string[] groups)
 Creates a batch of data group operations (passing null or empty array requires use of IBatch.Send(string resource, IMessage message)) More...
 
IDataGroup CreateDataGroup (string name)
 Create a new data group More...
 
IDataGroup CreateDataGroup (string name, ConflationBehaviour behaviour, TimeSpan interval)
 Create a conflated data group More...
 
IProducer CreateProducer (string name=null)
 Create a direct data delivery producer, that can be used to publish messages to a data group. More...
 
IBatch CreateStreamBatch (string[] streams)
 Creates a batch of data stream operations (passing null or empty array requires use of IBatch.Send(string resource, IMessage message)) More...
 
void DeleteDataGroup (string name)
 Delete the specified data group from the realm. More...
 
IDataGroup GetDataGroup (string name)
 Retrieve data group with the specified name. More...
 

Properties

bool Enable [get, set]
 If set to true, the session will be added to the default data group. More...
 
bool EnableAdmin [get, set]
 If set to true, the session will receive data group administration messages More...
 
IDataGroup Root [get]
 The realm's data groups. More...
 
string StreamId [get]
 The callers Data Stream Id More...
 

Events

EventHandler
< DataGroupAddedEventArgs
DataGroupAdded
 Raised when a Data Group is added to another group More...
 
EventHandler
< DataGroupCreatedEventArgs
DataGroupCreated
 Raised when a Data Group is created. More...
 
EventHandler
< DataGroupDeletedEventArgs
DataGroupDeleted
 Raised when a Data Group is deleted. More...
 
EventHandler
< DataGroupRemovedEventArgs
DataGroupRemoved
 Raised when a Data Group is removed from another group More...
 
EventHandler< MessageEventArgsMessageReceived
 Raises an event when a direct data delivery message is received. More...
 
EventHandler
< DataGroupStreamEventArgs
StreamAdded
 Raised when a Data Delivery Stream is added to a Data Group More...
 
EventHandler
< DataGroupStreamEventArgs
StreamRemoved
 Raised when a Data Delivery Stream is added to a Data Group More...
 

Detailed Description

Defines DataGroup operations available in a session.

Member Function Documentation

IDataGroupBatch MyChannels.Nirvana.IDataGroupSession.CreateBatch ( string[]  groups)

Creates a batch of data group operations (passing null or empty array requires use of IBatch.Send(string resource, IMessage message))

Parameters
groupsarray of data group names to send to
Returns
IDataGroup MyChannels.Nirvana.IDataGroupSession.CreateDataGroup ( string  name)

Create a new data group

Parameters
nameThe name of the data group
Returns
The data group
IDataGroup MyChannels.Nirvana.IDataGroupSession.CreateDataGroup ( string  name,
ConflationBehaviour  behaviour,
TimeSpan  interval 
)

Create a conflated data group

Parameters
nameThe name of the data group
behaviourThe conflation behaviour
intervalThe conflation interval
Returns
The data group
IProducer MyChannels.Nirvana.IDataGroupSession.CreateProducer ( string  name = null)

Create a direct data delivery producer, that can be used to publish messages to a data group.

Parameters
nameThe name of the data group you would like to publish messages to.
IBatch MyChannels.Nirvana.IDataGroupSession.CreateStreamBatch ( string[]  streams)

Creates a batch of data stream operations (passing null or empty array requires use of IBatch.Send(string resource, IMessage message))

Parameters
streamsarray of data stream names to send to
Returns
void MyChannels.Nirvana.IDataGroupSession.DeleteDataGroup ( string  name)

Delete the specified data group from the realm.

Parameters
name
IDataGroup MyChannels.Nirvana.IDataGroupSession.GetDataGroup ( string  name)

Retrieve data group with the specified name.

Parameters
name
Returns

Property Documentation

bool MyChannels.Nirvana.IDataGroupSession.Enable
getset

If set to true, the session will be added to the default data group.

Must be enabled before the session is initialized.

bool MyChannels.Nirvana.IDataGroupSession.EnableAdmin
getset

If set to true, the session will receive data group administration messages

Must be enabled before the session is initialized.

IDataGroup MyChannels.Nirvana.IDataGroupSession.Root
get

The realm's data groups.

string MyChannels.Nirvana.IDataGroupSession.StreamId
get

The callers Data Stream Id

Event Documentation

EventHandler<DataGroupAddedEventArgs> MyChannels.Nirvana.IDataGroupSession.DataGroupAdded

Raised when a Data Group is added to another group

EventHandler<DataGroupCreatedEventArgs> MyChannels.Nirvana.IDataGroupSession.DataGroupCreated

Raised when a Data Group is created.

EventHandler<DataGroupDeletedEventArgs> MyChannels.Nirvana.IDataGroupSession.DataGroupDeleted

Raised when a Data Group is deleted.

EventHandler<DataGroupRemovedEventArgs> MyChannels.Nirvana.IDataGroupSession.DataGroupRemoved

Raised when a Data Group is removed from another group

EventHandler<MessageEventArgs> MyChannels.Nirvana.IDataGroupSession.MessageReceived

Raises an event when a direct data delivery message is received.

EventHandler<DataGroupStreamEventArgs> MyChannels.Nirvana.IDataGroupSession.StreamAdded

Raised when a Data Delivery Stream is added to a Data Group

EventHandler<DataGroupStreamEventArgs> MyChannels.Nirvana.IDataGroupSession.StreamRemoved

Raised when a Data Delivery Stream is added to a Data Group