- com
- pcbsys
- nirvana
- client
- nDataGroup
This class represents a individual data group object. More...
#include <nDataGroup.h>
Public Member Functions | |
virtual void | add (nDataStream *pStream) |
Add a new stream to this data group. More... | |
void | add (std::list< nDataStream * > &streams) |
Add a list of new streams to this data group. More... | |
virtual void | add (nDataGroup *pGroup) |
Adds an existing data group to this data group, allowing groups to be cascaded. More... | |
virtual void | addListener (nDataGroupListener *pListener) |
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 (const std::string &subject) |
Allow the specified subject to be allowed to publish to this group. More... | |
virtual void | addSnoop (nDataStream *pStream) |
Add a new snoop stream to this data group. More... | |
virtual bool | contains (nDataStream *pStream) |
Checks if the stream id exists in this group. More... | |
virtual bool | contains (const std::string &streamId) |
Checks if the snoop stream id exists in this group. More... | |
bool | contains (nDataGroup *pGroup) |
Checks if the stream id exists in this group. More... | |
virtual bool | containsSnoop (nDataStream *pStream) |
Checks if the stream id exists in this group. More... | |
virtual bool | containsSnoop (const std::string &streamId) |
Checks if the snoop stream id exists in this group. More... | |
nRegisteredEvent * | createRegisteredEvent () |
Registers a new nRegisteredEvent with the data stream allowing updates only 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 (const std::string &groupName) |
Returns the DataGroup specified, if it is contained within this group. More... | |
int | getGroupCount () |
Returns the size of the DataGroups (if any) contained within this group. More... | |
virtual std::list< nDataGroup * > * | getGroups () |
Returns the DataGroups (if any) contained within this group. More... | |
nDataGroup ** | getGroupsContaining (int &nGroup) |
Locate the groups that currently contain this group. More... | |
virtual longlong | getID () |
Return the id of this nDataGroup object. More... | |
virtual const std::string & | getName () |
Return the name of the group. More... | |
virtual fSortedList < std::string, std::string > & | getPublishers () |
Obtain a list of publisher ids. More... | |
nSession * | getSession () |
Returns the session associated with this data group instance. More... | |
virtual nDataStream * | getSnoopStream (const std::string &streamId) |
Get the nDataStream snoop object corresponding to the name. More... | |
virtual nDataStream * | getStream (const std::string &streamId) |
Get the nDataStream object corresponding to the name. More... | |
virtual std::list< nDataStream * > * | getStreams () |
Obtain a list of the nDataStream objects contained within this group. More... | |
bool | isClosed () |
Returns true if this group has been deleted. 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 *pStream) |
Remove the stream Id from this data group. More... | |
virtual void | remove (nDataGroup *pGroup) |
Remove the specified data group from this one. More... | |
virtual void | removePublisher (const std::string &subject) |
Remove the specified subject from the list of authorised publishers for this group. More... | |
virtual void | removeSnoop (nDataStream *pStream) |
Remove the snoop stream Id from this data group. More... | |
virtual void | setReadOnly () |
Mark the nDataGroup as read only. | |
virtual int | size () |
Return the total number of streams contained in this group. More... | |
Public Member Functions inherited from com::pcbsys::nirvana::client::nDataStream | |
virtual const std::string & | getSubject () |
Get the subject associated with the stream. More... | |
This class represents a individual data group object.
|
virtual |
Add a new stream to this data group.
*pStream | - the stream to add |
void com::pcbsys::nirvana::client::nDataGroup::add | ( | std::list< nDataStream * > & | streams | ) |
Add a list of new streams to this data group.
streams | - the list of streams to add |
|
virtual |
Adds an existing data group to this data group, allowing groups to be cascaded.
*pGroup | - 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.
*pListener | 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.
*pStream | - the stream to add |
|
virtual |
Checks if the stream id exists in this group.
*pStream | the stream to test for |
nDataGroupDeletedException | if this nDataGroup is now closed |
|
virtual |
Checks if the snoop stream id exists in this group.
streamId | the name of the stream or group to test for |
nDataGroupDeletedException |
bool com::pcbsys::nirvana::client::nDataGroup::contains | ( | nDataGroup * | pGroup | ) |
Checks if the stream id exists in this group.
stream | the stream to test for |
nDataGroupDeletedException | if this nDataGroup is now closed |
|
virtual |
Checks if the stream id exists in this group.
*pStream | the stream to test for |
nDataGroupDeletedException | if this nDataGroup is now closed |
|
virtual |
Checks if the snoop stream id exists in this group.
streamId | the 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 updates only to be sent through to the clients.
nIllegalStateException |
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 | to find |
nDataGroupDeletedException |
int com::pcbsys::nirvana::client::nDataGroup::getGroupCount | ( | ) |
Returns the size of the DataGroups (if any) contained within this group.
nDataGroupDeletedException |
|
virtual |
Returns the DataGroups (if any) contained within this group.
nDataGroupDeletedException |
nDataGroup** com::pcbsys::nirvana::client::nDataGroup::getGroupsContaining | ( | int & | nGroup | ) |
Locate the groups that currently contain this group.
nGroup | - the number of groups returned |
|
virtual |
Return the id of this nDataGroup object.
|
virtual |
Return the name of the group.
Reimplemented from com::pcbsys::nirvana::client::nDataStream.
|
virtual |
Obtain a list of publisher ids.
nDataGroupDeletedException | if this nDataGroup is now closed |
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 | the name of the stream |
nDataGroupDeletedException |
|
virtual |
Get the nDataStream object corresponding to the name.
streamId | the name of the stream |
nDataGroupDeletedException |
|
virtual |
Obtain a list of the nDataStream objects contained within this group.
nDataGroupDeletedException | if this nDataGroup is now closed |
bool com::pcbsys::nirvana::client::nDataGroup::isClosed | ( | ) |
Returns true if this group has been deleted.
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 Id from this data group.
*pStream | - the stream to remove from this data group |
|
virtual |
Remove the specified data group from this one.
*pGroup | the group to remove |
|
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 Id from this data group.
*pStream | - the stream to remove from this data group |
|
virtual |
Return the total number of streams contained in this group.
nDataGroupDeletedException |