MyChannels.Nirvana.IDataGroupSession Interface Reference

Defines a direct data delivery session. More...

Inherited by MyChannels.Nirvana.InternalSession.


Public Member Functions

IDataGroupBatch CreateBatch ()
 Creates a batch of data group operations.
IDataGroup CreateDataGroup (string name, ConflationBehaviour behaviour, TimeSpan interval)
 Create a conflated data group.
IDataGroup CreateDataGroup (string name)
 Create a new data group.
IProducer CreateProducer (string name=null)
 Create a direct data delivery producer, that can be used to publish messages to a data group.
void DeleteDataGroup (string name)
 Delete the specified data group from the realm.
IDataGroup GetDataGroup (string name)
 Retrieve data group with the specified name.

Properties

bool Enable [get, set]
 Is Direct Data Delivery enabled for the session.
IDataGroup Root [get]
 The realm's data groups.

Events

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

Detailed Description

Defines a direct data delivery session.

Member Function Documentation

IDataGroupBatch MyChannels.Nirvana.IDataGroupSession.CreateBatch (  ) 

Creates a batch of data group operations.

Returns:

IDataGroup MyChannels.Nirvana.IDataGroupSession.CreateDataGroup ( string  name,
ConflationBehaviour  behaviour,
TimeSpan  interval 
)

Create a conflated data group.

Parameters:
name The name of the data group
behaviour The conflation behaviour
interval The conflation interval
Returns:
The data group

IDataGroup MyChannels.Nirvana.IDataGroupSession.CreateDataGroup ( string  name  ) 

Create a new data group.

Parameters:
name The name of the data group
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:
name The name of the data group you would like to publish messages to.

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 [get, set]

Is Direct Data Delivery enabled for the session.

Must be enabled before the session is initialized.

Event Documentation

EventHandler<DataGroupAddedEventArgs> MyChannels.Nirvana.IDataGroupSession.DataGroupAdded

Raised when a Data Group is added to another group.

EventHandler<DataGroupRemovedEventArgs> MyChannels.Nirvana.IDataGroupSession.DataGroupRemoved

Raised when a Data Group is removed from another group.

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.