This class represents a individual data group object. More...
Public Member Functions | |
| virtual void | add (nDataStream stream) |
| Add a new stream to this data group More... | |
| void | add (IEnumerable< nDataStream > streams) |
| Adds the specified streams to this group More... | |
| virtual void | add (nDataGroup group) |
| Adds an existing data group to this data group, allowing groups to be cascaded More... | |
| virtual void | addListener (nDataGroupListener listener) |
| Add a new listener to this group so that when Streams or Groups are added or deleted the listener is notified More... | |
| virtual void | addPublisher (string subject) |
| Allow the specified subject to be allowed to publish to this group More... | |
| virtual void | addSnoop (nDataStream stream) |
| Add a new snoop stream to this data group. More... | |
| virtual bool | contains (nDataStream stream) |
| Checks if the stream exists in this group More... | |
| virtual bool | contains (string streamId) |
| Checks if the stream id exists in this group More... | |
| virtual bool | containsSnoop (nDataStream stream) |
| Checks if the snoop stream exists in this group More... | |
| virtual bool | containsSnoop (string streamId) |
| Checks if the snoop stream id exists in this group More... | |
| nRegisteredEvent | createRegisteredEvent () |
| Registers a new nRegisteredEvent with the data stream allowing just the updates to be sent through to the clients More... | |
| nConflationAttributes | getConflationAttributes () |
| Get the conflation attributes for this data group if they exist More... | |
| virtual nDataGroup | getGroup (string groupName) |
| Returns the DataGroup specified, if it is contained within this group. More... | |
| int | getGroupCount () |
| Returns the number of DataGroups (if any) contained within this group. More... | |
| virtual IEnumerable< nDataGroup > | getGroups () |
| Obtain a list of the nDataGroup objects contained within this group More... | |
| nDataGroup[] | getGroupsContaining () |
| Locate the groups that currently contain this group More... | |
| virtual long | getID () |
| Return the id of this nDataGroup object More... | |
| virtual nDataGroupListener | getListener () |
| returns the current listener for the datagroup More... | |
| int | getPriority () |
| Returns the level of priority associated with this data group More... | |
| virtual IEnumerable< string > | getPublishers () |
| Obtain a list of publisher ids More... | |
| nSession | getSession () |
| Returns the session associated with this data group instance More... | |
| virtual nDataStream | getSnoopStream (string streamId) |
| Get the nDataStream snoop object corresponding to the name More... | |
| virtual nDataStream | getStream (string streamId) |
| Get the nDataStream object corresponding to the name More... | |
| virtual IEnumerable< nDataStream > | getStreams () |
| Obtain the list of nDataStream objects contained within this group More... | |
| bool | isClosed () |
| Returns true if this group has been deleted More... | |
| bool | isMulticastEnabled () |
| Flag to indicate whether this Data Group is multicast enabled More... | |
| bool | isNested () |
| Flag indicating whether this group is nested within one of more other groups More... | |
| bool | isReadOnly () |
| Flag to indicate whether this group is read only. More... | |
| virtual void | remove (nDataStream stream) |
| Remove the stream from this data group More... | |
| virtual void | remove (nDataGroup group) |
| Remove the specified data group from this one More... | |
| virtual void | removePublisher (string subject) |
| Remove the specified subject from the list of authorised publishers for this group More... | |
| virtual void | removeSnoop (nDataStream stream) |
| Remove the snoop stream from this data group More... | |
| virtual void | setReadOnly () |
| Mark the nDataGroup as read only More... | |
| virtual int | size () |
| Get the current count of streams contained in this nDataGroup More... | |
Properties | |
| virtual string | Name [get] |
| |
 Properties inherited from com.pcbsys.nirvana.client.nDataStream | |
| virtual string | Name [get] |
| The stream name More... | |
| virtual string | Subject [get] |
| The stream subject More... | |
This class represents a individual data group object.
|
virtual |
Add a new stream to this data group
| stream | - the stream to add |
| void com.pcbsys.nirvana.client.nDataGroup.add | ( | IEnumerable< nDataStream > | streams | ) |
Adds the specified streams to this group
| streams | an IEnumerable of nDataStreams to be added to this group |
|
virtual |
Adds an existing data group to this data group, allowing groups to be cascaded
| group | - group to be added |
|
virtual |
Add a new listener to this group so that when Streams or Groups are added or deleted the listener is notified
| listener | the listener to receive callbacks on this data group |
| nDataGroupDeletedException |
|
virtual |
Allow the specified subject to be allowed to publish to this group
| subject | the subject to give permissions to |
|
virtual |
Add a new snoop stream to this data group.
This stream will be hidden from the group, with no callbacks fired for it
| stream | - the stream to add |
|
virtual |
Checks if the stream exists in this group
| stream | the stream or group to test for |
|
virtual |
Checks if the stream id exists in this group
| streamId | name of the stream or group to test for |
| nDataGroupDeletedException |
|
virtual |
Checks if the snoop stream exists in this group
| stream | the stream or group to test for |
|
virtual |
Checks if the snoop stream id exists in this group
| streamId | name of the stream or group to test for |
| nDataGroupDeletedException |
| nRegisteredEvent com.pcbsys.nirvana.client.nDataGroup.createRegisteredEvent | ( | ) |
Registers a new nRegisteredEvent with the data stream allowing just the updates to be sent through to the clients
| nDataGroupDeletedException |
| nConflationAttributes com.pcbsys.nirvana.client.nDataGroup.getConflationAttributes | ( | ) |
Get the conflation attributes for this data group if they exist
|
virtual |
Returns the DataGroup specified, if it is contained within this group.
| groupName | the group to find |
| nDataGroupDeletedException |
| int com.pcbsys.nirvana.client.nDataGroup.getGroupCount | ( | ) |
Returns the number of DataGroups (if any) contained within this group.
| nDataGroupDeletedException |
|
virtual |
Obtain a list of the nDataGroup objects contained within this group
| nDataGroupDeletedException |
| nDataGroup [] com.pcbsys.nirvana.client.nDataGroup.getGroupsContaining | ( | ) |
Locate the groups that currently contain this group
| nDataGroupDeletedException |
|
virtual |
Return the id of this nDataGroup object
|
virtual |
returns the current listener for the datagroup
| int com.pcbsys.nirvana.client.nDataGroup.getPriority | ( | ) |
Returns the level of priority associated with this data group
|
virtual |
Obtain a list of publisher ids
| nSession com.pcbsys.nirvana.client.nDataGroup.getSession | ( | ) |
Returns the session associated with this data group instance
|
virtual |
Get the nDataStream snoop object corresponding to the name
| streamId | name of the stream |
| nDataGroupDeletedException |
|
virtual |
Get the nDataStream object corresponding to the name
| streamId | name of the stream |
| nDataGroupDeletedException |
|
virtual |
Obtain the list of nDataStream objects contained within this group
| nDataGroupDeletedException |
| bool com.pcbsys.nirvana.client.nDataGroup.isClosed | ( | ) |
Returns true if this group has been deleted
| bool com.pcbsys.nirvana.client.nDataGroup.isMulticastEnabled | ( | ) |
Flag to indicate whether this Data Group is multicast enabled
| bool com.pcbsys.nirvana.client.nDataGroup.isNested | ( | ) |
Flag indicating whether this group is nested within one of more other groups
| bool com.pcbsys.nirvana.client.nDataGroup.isReadOnly | ( | ) |
Flag to indicate whether this group is read only.
If it is, it will be the default Data Group object
|
virtual |
Remove the stream from this data group
| stream | the stream to be removed |
|
virtual |
Remove the specified data group from this one
| group |
|
virtual |
Remove the specified subject from the list of authorised publishers for this group
| subject | the subject to remove permissions from |
|
virtual |
Remove the snoop stream from this data group
| stream | the stream to be removed |
|
virtual |
Mark the nDataGroup as read only
|
virtual |
Get the current count of streams contained in this nDataGroup