This class is an Admin API wrapper for a Data Group object (nDataGroup) More...
Public Member Functions | |
| void | addListener (nDataGroupListener listener) |
| Add an nDataGroup listener to this node. More... | |
| float | getConsumedRate () |
| The number of events consumed per second More... | |
| nDataGroup | getDataGroup () |
| Get the client API nDataGroup object represented by this node More... | |
| float | getFanoutTime () |
| The total number of milliseconds it takes to fanout each event to all consumers More... | |
| long | getLastEID () |
| Returns the last EID that was used for the data group More... | |
| float | getPublishRate () |
| The number of events published per second More... | |
| long | getStreamCount () |
| Returns the current number of streams that are connected to this data group More... | |
| long | getTotalConsumed () |
| Returns the total number of events that this data group and nested groups have delivered to listeners More... | |
| long | getTotalPublished () |
| Returns the total number of events published to this data group and nested groups since the realm has started More... | |
| long | getTotalStreamCount () |
| Returns the total number of streams that have been connected to this data group More... | |
| void | removeListener (nDataGroupListener listener) |
| Remove the specified listener More... | |
 Public Member Functions inherited from com.pcbsys.nirvana.nAdminAPI.nContainer | |
| void | addACLEntries (nACL acl) |
| Adds a list of acl entry to all known nodes within the nContainer node. More... | |
| void | addACLEntries (nACL acl, nNode[] nodes) |
| Adds a list acl entry to all nodes contained with in the array of nNodes More... | |
| virtual void | addACLEntry (nACLEntry entry) |
| Adds a specific acl entry to all known nodes within the nContainer node. More... | |
| virtual void | addACLEntry (nACLEntry entry, bool allChannels, bool allQueues, bool allServices) |
| Adds a specific acl entry to all known nodes within the nContainer node. More... | |
| virtual void | closed (nRealmNode node) |
| Called when the nRealmNode is closed, for internal use only. More... | |
| virtual nNode | findNode (string name) |
| Given a name of the form /container/container/name this function will locate the name object and return it, or null if that object can not be found. More... | |
| virtual nNode | findNode (nNode node) |
| Given a name of the form /container/container/name this function will locate the nNode object and return it, or null if that can not be found. More... | |
| virtual nNode | findNode (nNode node, bool searchChildren) |
| Given a name of the form /container/container/name this function will locate the name object and return it, or null if that can not be found. More... | |
| nNode | getNextSibling () |
| Method to return the next sibling from this node's parent More... | |
| virtual nNode | getNextSibling (int idx) |
| Returns the sibling at position idx from this nodes parent. More... | |
| virtual System.Collections.IEnumerator | getNodes () |
| Returns an IEnumerator of all the nodes under this container. More... | |
| virtual nRealmNode | getRealmAt (string name) |
| Given a mount point this function will return a realm if one exists at the specified mount point More... | |
| nRealmNode | getRealmNode () |
| Get method for the realm node which acts as a container for this object More... | |
| virtual int | getSize () |
| Returns the number of nodes under this container. More... | |
| virtual int | getTotalNodes () |
| Returns the total number of nodes within this container and all subsequent children by traversing the entire structure beneath this container node More... | |
| virtual bool | hasRealmAt (string name) |
| Given a mount point this function will determine if this container contains a mounted realm at the specified mount point More... | |
| void | modACLEntries (nACL acl) |
| Modifies a list of acl entry to all known nodes within the nContainer node. More... | |
| void | modACLEntries (nACL acl, nNode[] nodes) |
| Modifies a list of acl entry to all nodes contained with in the array of nNodes More... | |
| virtual void | modACLEntry (nACLEntry entry) |
| modifies a specific acl entry's permissions for all known nodes within the nContainer node. More... | |
| virtual void | modACLEntry (nACLEntry entry, bool allChannels, bool allQueues, bool allServices) |
| modifies a specific acl entry's permissions for all known nodes within the nContainer node. More... | |
| void | removeACLEntries (nACL acl) |
| Removes a list of acl entries from all known nodes within the nContainer node. More... | |
| void | removeACLEntries (nACL acl, nNode[] nodes) |
| Removes a list of acl entries from all nodes contained with in the array of nNodes More... | |
| virtual void | removeACLEntry (nACLEntry entry) |
| removes a specific acl entry from all known nodes within the nContainer node. More... | |
| virtual void | removeACLEntry (nACLEntry entry, bool allChannels, bool allQueues, bool allServices) |
| removes a specific acl entry from all known nodes within the nContainer node. More... | |
| virtual void | setACL (nACL acl) |
| Replaces the existing ACL with the nACL supplied to all known nodes within the nContainer node. More... | |
| virtual void | setACL (nACL acl, bool allChannels, bool allQueues, bool allServices) |
| Replaces the existing ACL with the nACL supplied to all known nodes within the nContainer node. More... | |
| Public Member Functions inherited from com.pcbsys.nirvana.nAdminAPI.nNode | |
| bool | Equals (long aLong) |
| Needed as part of the SortedObject interface. More... | |
| override bool | Equals (object item) |
| Compares this object with the passed object More... | |
| virtual string | getAbsolutePath () |
| This function walks the tree to the root to generate a fully qualified name for this node More... | |
| virtual nNode | getParent () |
| Returns this nodes parent node. More... | |
| virtual string | getRelativePath (nNode top) |
| This method returns the relative path from this node to the nNode passed. More... | |
| virtual bool | lessThan (long aLong) |
| Needed as part of the SortedObject interface. More... | |
| virtual bool | lessThan (object item) |
| Compares this object with the passed object. More... | |
| Public Member Functions inherited from com.pcbsys.nirvana.client.Observable | |
| void | addObserver (IObserver o) |
| Adds an observer to the set of observers for this object, provided that it is not the same as some observer already in the set. More... | |
| int | countObservers () |
Returns the number of observers of this Observable object. More... | |
| void | deleteObserver (IObserver o) |
| Deletes an observer from the set of observers of this object. More... | |
| void | deleteObservers () |
| Clears the observer list so that this object no longer has any observers. More... | |
| bool | hasChanged () |
| Tests if this object has changed. More... | |
| void | notifyObservers () |
If this object has changed, as indicated by the hasChanged method, then notify all of its observers and then call the clearChanged method to indicate that this object has no longer changed. More... | |
| void | notifyObservers (Object arg) |
| If this object has changed, as indicated by the More... | |
| Observable () | |
| Construct an Observable with zero Observers. More... | |
Additional Inherited Members | |
| Protected Member Functions inherited from com.pcbsys.nirvana.client.Observable | |
| void | clearChanged () |
Indicates that this object has no longer changed, or that it has already notified all of its observers of its most recent change, so that the hasChanged method will now return false. More... | |
| void | setChanged () |
Marks this Observable object as having been changed; the hasChanged method will now return true. More... | |
| Properties inherited from com.pcbsys.nirvana.nAdminAPI.nNode | |
| virtual string | Name [get] |
| Returns the generic name of this node within the namespace More... | |
This class is an Admin API wrapper for a Data Group object (nDataGroup)
| void com.pcbsys.nirvana.nAdminAPI.nDataGroupNode.addListener | ( | nDataGroupListener | listener | ) |
Add an nDataGroup listener to this node.
This allows multiple listeners to be added to an instance of the nDataGroup object this node represents
| listener | the nDataGroupListener to receive callbacks when streams or other groups are added/removed from this group |
| float com.pcbsys.nirvana.nAdminAPI.nDataGroupNode.getConsumedRate | ( | ) |
The number of events consumed per second
| nDataGroup com.pcbsys.nirvana.nAdminAPI.nDataGroupNode.getDataGroup | ( | ) |
Get the client API nDataGroup object represented by this node
| float com.pcbsys.nirvana.nAdminAPI.nDataGroupNode.getFanoutTime | ( | ) |
The total number of milliseconds it takes to fanout each event to all consumers
| long com.pcbsys.nirvana.nAdminAPI.nDataGroupNode.getLastEID | ( | ) |
Returns the last EID that was used for the data group
| float com.pcbsys.nirvana.nAdminAPI.nDataGroupNode.getPublishRate | ( | ) |
The number of events published per second
| long com.pcbsys.nirvana.nAdminAPI.nDataGroupNode.getStreamCount | ( | ) |
Returns the current number of streams that are connected to this data group
| long com.pcbsys.nirvana.nAdminAPI.nDataGroupNode.getTotalConsumed | ( | ) |
Returns the total number of events that this data group and nested groups have delivered to listeners
| long com.pcbsys.nirvana.nAdminAPI.nDataGroupNode.getTotalPublished | ( | ) |
Returns the total number of events published to this data group and nested groups since the realm has started
| long com.pcbsys.nirvana.nAdminAPI.nDataGroupNode.getTotalStreamCount | ( | ) |
Returns the total number of streams that have been connected to this data group
| void com.pcbsys.nirvana.nAdminAPI.nDataGroupNode.removeListener | ( | nDataGroupListener | listener | ) |
Remove the specified listener
| listener | the nDataGroupListener to receive callbacks when streams or other groups are added/removed from this group |