com.pcbsys.nirvana.nAdminAPI.nDataGroupNode Class Reference

This class is an Admin API wrapper for a Data Group object (nDataGroup). More...

Inheritance diagram for com.pcbsys.nirvana.nAdminAPI.nDataGroupNode:

com.pcbsys.nirvana.nAdminAPI.nContainer com.pcbsys.nirvana.nAdminAPI.nNode

Public Member Functions

void addListener (nDataGroupListener listener)
 Add an nDataGroup listener to this node.
float getConsumedRate ()
 The number of events consumed per second.
nDataGroup getDataGroup ()
 Get the client API nDataGroup object represented by this node.
float getFanoutTime ()
 The total number of milliseconds it takes to fanout each event to all consumers.
long getLastEID ()
 Returns the last EID that was used for the data group.
float getPublishRate ()
 The number of events published per second.
long getStreamCount ()
 Returns the current number of streams that have been added to this data group.
long getTotalConsumed ()
 Returns the total number of events that this data group has delivered to listeners.
long getTotalPublished ()
 Returns the total number of events published to this data group since the realm has started.
long getTotalStreamCount ()
 Returns the total number of streams that have been added to this data group.
void removeListener (nDataGroupListener listener)
 Remove the listener from the list of listeners.

Detailed Description

This class is an Admin API wrapper for a Data Group object (nDataGroup).

See also:
com.pcbsys.nirvana.client.nDataGroup

Member Function Documentation

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

Parameters:
listener the listener to notify when groups or streams are added/removed from this group
See also:
com.pcbsys.nirvana.client.nDataGroupListener

float com.pcbsys.nirvana.nAdminAPI.nDataGroupNode.getConsumedRate (  ) 

The number of events consumed per second.

Returns:
float value the rate at which messages are being consumed

nDataGroup com.pcbsys.nirvana.nAdminAPI.nDataGroupNode.getDataGroup (  ) 

Get the client API nDataGroup object represented by this node.

Returns:
the nDataGroup object

float com.pcbsys.nirvana.nAdminAPI.nDataGroupNode.getFanoutTime (  ) 

The total number of milliseconds it takes to fanout each event to all consumers.

Returns:
long the fanout time in milliseconds

long com.pcbsys.nirvana.nAdminAPI.nDataGroupNode.getLastEID (  ) 

Returns the last EID that was used for the data group.

Returns:
long the last event id used

float com.pcbsys.nirvana.nAdminAPI.nDataGroupNode.getPublishRate (  ) 

The number of events published per second.

Returns:
int number of event published per second

long com.pcbsys.nirvana.nAdminAPI.nDataGroupNode.getStreamCount (  ) 

Returns the current number of streams that have been added to this data group.

Returns:
long total number of streams

long com.pcbsys.nirvana.nAdminAPI.nDataGroupNode.getTotalConsumed (  ) 

Returns the total number of events that this data group has delivered to listeners.

Returns:
long total number of events consumed

long com.pcbsys.nirvana.nAdminAPI.nDataGroupNode.getTotalPublished (  ) 

Returns the total number of events published to this data group since the realm has started.

Returns:
long total number of events written to the group

long com.pcbsys.nirvana.nAdminAPI.nDataGroupNode.getTotalStreamCount (  ) 

Returns the total number of streams that have been added to this data group.

Returns:
long total number of streams

void com.pcbsys.nirvana.nAdminAPI.nDataGroupNode.removeListener ( nDataGroupListener  listener  ) 

Remove the listener from the list of listeners.

Parameters:
listener the listener to remove
See also:
com.pcbsys.nirvana.client.nDataGroupListener