com.pcbsys.nirvana.client.nAbstractChannel Class Reference

This is the base class for all nirvana channel types, including queues and normal pub/sub channels and as such has no public methods. More...

Inheritance diagram for com.pcbsys.nirvana.client.nAbstractChannel:
com.pcbsys.nirvana.client.nChannel com.pcbsys.nirvana.client.nQueue

Public Member Functions

int getQueueSize ()
 Returns the size of the underlying event queue waiting for delivery via the go method. More...
 
nSession getSession ()
 Returns the nSession used to create/find this channel. More...
 
nChannelAttributes getStoreAttributes ()
 The attributes about this channel and how it is configured. More...
 
boolean isStoreObjectInvalid ()
 When a store is removed (or modified which entails a remove and create) then these logical representations can become invalid Once they are invalid you must perform a findChannel again on the nSession to acquire the latest object. More...
 
void updateProtobufDefinitions (byte[][] descriptors) throws nIllegalArgumentException, nSessionNotConnectedException, nRequestTimedOutException, nSessionPausedException
 Update the Protocol Buffer definition for the store. More...
 

Detailed Description

This is the base class for all nirvana channel types, including queues and normal pub/sub channels and as such has no public methods.

See Also
nChannel
nQueue

Member Function Documentation

int com.pcbsys.nirvana.client.nAbstractChannel.getQueueSize ( )

Returns the size of the underlying event queue waiting for delivery via the go method.

Returns
number of events to be delivered
nSession com.pcbsys.nirvana.client.nAbstractChannel.getSession ( )

Returns the nSession used to create/find this channel.

Returns
the nSession associated with this channel
nChannelAttributes com.pcbsys.nirvana.client.nAbstractChannel.getStoreAttributes ( )

The attributes about this channel and how it is configured.

Returns
nChannelAttributes of this store
boolean com.pcbsys.nirvana.client.nAbstractChannel.isStoreObjectInvalid ( )

When a store is removed (or modified which entails a remove and create) then these logical representations can become invalid Once they are invalid you must perform a findChannel again on the nSession to acquire the latest object.

Returns
true if this store is no longer valid
void com.pcbsys.nirvana.client.nAbstractChannel.updateProtobufDefinitions ( byte  descriptors[][]) throws nIllegalArgumentException, nSessionNotConnectedException, nRequestTimedOutException, nSessionPausedException

Update the Protocol Buffer definition for the store.

Parameters
descriptorsAn array of descriptors as byte[] to set as the new channel's descriptors.
Exceptions
nIllegalArgumentExceptiondescriptors cannot be sent to the realm.
nSessionNotConnectedExceptionif the session for this store is not currently connected
nRequestTimedOutExceptionif there is no response to the request to set the store's descriptors within the timeout period.
nSessionPausedExceptionif the session for this store is currently paused