Glossary:
com.pcbsys.nirvana.nAdminAPI.nDataGroupsContainer Class Reference
This class is an Admin API wrapper for all configured Data Group objects (nDataGroup). More...
Public Member Functions | |
| Iterator< nDataStream > | getAllStreams () |
| Get all nDataStream objects connected to the Nirvana realm. | |
| float | getConsumedRate () |
| The number of events consumed per second across all nDataGroup objects. | |
| nDataGroupNode | getDefaulDataGroup () |
| Obtain the default nDataGroup object. | |
| int | getGroupCount () |
| Get the number of known nDataGroup objects. | |
| float | getPublishRate () |
| The number of events published per second across all nDataGroup objects. | |
| int | getStreamCount () |
| Get the number of nDataStream objects currently connected. | |
| long | getTotalConsumed () |
| Returns the total number of events that delivered to listeners across all nDataGroup objects. | |
| long | getTotalPublished () |
| Returns the total number of events published to this all data groups since the realm has started. | |
| long | getTotalStreamCount () |
| Returns the total number of streams that have been added to all data groups since the realm last started. | |
Detailed Description
This class is an Admin API wrapper for all configured Data Group objects (nDataGroup).This class also can also be used to obtain all known nDataStream objects, that have been added to the default data group.
Member Function Documentation
| Iterator<nDataStream> com.pcbsys.nirvana.nAdminAPI.nDataGroupsContainer.getAllStreams | ( | ) |
Get all nDataStream objects connected to the Nirvana realm.
- Returns:
- an Iterator of all nDataStream objects
| float com.pcbsys.nirvana.nAdminAPI.nDataGroupsContainer.getConsumedRate | ( | ) |
The number of events consumed per second across all nDataGroup objects.
- Returns:
- float the rate at which events are being consumed on the data group
| nDataGroupNode com.pcbsys.nirvana.nAdminAPI.nDataGroupsContainer.getDefaulDataGroup | ( | ) |
Obtain the default nDataGroup object.
- Returns:
- default nDataGroup
| int com.pcbsys.nirvana.nAdminAPI.nDataGroupsContainer.getGroupCount | ( | ) |
Get the number of known nDataGroup objects.
- Returns:
- the total number of nDataGroup objects
| float com.pcbsys.nirvana.nAdminAPI.nDataGroupsContainer.getPublishRate | ( | ) |
The number of events published per second across all nDataGroup objects.
- Returns:
- float the rate at which events are being written to the data group
| int com.pcbsys.nirvana.nAdminAPI.nDataGroupsContainer.getStreamCount | ( | ) |
Get the number of nDataStream objects currently connected.
- Returns:
- the total number of nDataStream objects
| long com.pcbsys.nirvana.nAdminAPI.nDataGroupsContainer.getTotalConsumed | ( | ) |
Returns the total number of events that delivered to listeners across all nDataGroup objects.
- Returns:
- long the total number of consumed events
| long com.pcbsys.nirvana.nAdminAPI.nDataGroupsContainer.getTotalPublished | ( | ) |
Returns the total number of events published to this all data groups since the realm has started.
- Returns:
- long the total number of published events
| long com.pcbsys.nirvana.nAdminAPI.nDataGroupsContainer.getTotalStreamCount | ( | ) |
Returns the total number of streams that have been added to all data groups since the realm last started.
- Returns:
- long the total number of streams contained in the data group
