com.pcbsys.nirvana.client.nChannel Class Reference

This class is a Nirvana channel, offering the Nirvana channel related services. More...

#include <nChannel.h>

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

com.pcbsys.nirvana.client.nAbstractChannel

Public Member Functions

void addConnectionListener (nChannelConnectionListener *pListener, bool isSync)
 Adds a nChannelConnectionListener to this channel so that when new connections are made to this channel the listener is notified.
void addConnectionListener (nChannelConnectionListener *pListener)
 Adds a nChannelConnectionListener to this channel so that when new connections are made to this channel the listener is notified.
void addSubscriber (nEventListener *pNel, nNamedObject *pName, const std::string &selector, bool bAutoAck, nNamedPriorityListener *pListener)
 Registers the specified nEventListener as a named subscriber to this channel.
void addSubscriber (nEventListener *pNel, nNamedObject *pName, nNamedPriorityListener *pListener)
 Registers the specified nEventListener as a named subscriber to this channel.
void addSubscriber (nEventListener *pNel, nNamedObject *pName, const std::string &selector, bool bAutoAck)
 Registers the specified nEventListener as a named subscriber to this channel.
void addSubscriber (nEventListener *pNel, nNamedObject *pName)
 Registers the specified nEventListener as a named subscriber to this channel.
void addSubscriber (nEventListener *pNel, const std::string &selector, longlong eid=-1)
 Registers the specified nEventListener as a subscriber to this channel.
void addSubscriber (nEventListener *pNel, longlong eid)
 Registers the specified nEventListener as a subscriber to this channel.
void addSubscriber (nEventListener *pNel)
 Registers the specified nEventListener as a subscriber to this channel.
nChannelIterator * createIterator ()
 Create a default channel iterator starting at the beginning of the channel.
nChannelIterator * createIterator (const std::string &selector)
 Create a default channel iterator starting at the beginning of the channel with the events which match the selector being returned.
nChannelIterator * createIterator (longlong startEID)
 Create a default channel iterator starting at the EID specified.
nChannelIterator * createIterator (nNamedObject *pName)
 Create a default channel iterator starting at the eid specified in the channel with the events which match the selector being returned.
nChannelIterator * createIterator (nNamedObject *pName, const std::string &selector)
 Create a default channel iterator starting at the eid specified in the channel with the events which match the selector being returned.
nChannelIterator * createIterator (const std::string &selector, longlong startEID)
 Create a default channel iterator starting at the eid specified in the channel with the events which match the selector being returned.
nNamedObject * createNamedObject (const std::string &name, longlong startEID, bool persistent, bool clusterWide, bool enablePriority)
 Creates a named object on the channel with the given name and depending on the persistent flag informs the server to store the name and value to disk or not.
nNamedObject * createNamedObject (const std::string &name)
 Creates a named object on the channel with the given name.
nNamedObject * createNamedObject (const std::string &name, longlong startEID)
 Creates a named object on the channel with the given name.
nNamedObject * createNamedObject (const std::string &name, longlong startEID, bool persistent)
 Creates a named object on the channel with the given name and depending on the persistent flag informs the server to store the name and value to disk or not.
nNamedObject * createNamedObject (const std::string &name, bool persistent)
 Creates a named object on the channel with the given name and depending on the persistent flag informs the server to store the name and value to disk or not.
nNamedObject * createNamedObject (const std::string &name, bool persistent, bool clusterWide)
 Creates a named object on the channel with the given name and depending on the persistent flag informs the server to store the name and value to disk or not.
nNamedObject * createNamedObject (const std::string &name, longlong startEID, bool persistent, bool clusterWide)
 Creates a named object on the channel with the given name and depending on the persistent flag informs the server to store the name and value to disk or not.
void deleteJoin (nChannel *pDestination)
 Deletes a join between this channel and the channel referenced in the destination parameter.
void deleteJoin (nQueue *pDestination)
 Deletes a join between this channel and the queue referenced in the destination parameter.
void delNamedObject (nNamedObject *pName)
 Removes all references for this name on the realm Server.
void delNamedObject (const std::string &name)
 Removes all references for this name on the realm Server.
nChannelAttributes * getChannelAttributes ()
 Gets the channels local attributes.
nJoinInformation ** getJoinInformation (int &numJoin)
 Returns an array of nJoinInformation objects which describe the links this channel has configured for it.
longlong getLastEID ()
 Gets the last event id of this channel.
longlong getLastStoredEID ()
 Gets the last event id of this channel.
std::string getName ()
 Gets the name of this channel.
nNamedObject * getNamedObject (const std::string &name)
 Returns an instance of the nNamedObject referenced by the parameter.
nNamedObject ** getNamedObjects (int &numObject)
 Returns an array of all known nNamedObjects registered with this channel.
int getType ()
 Gets the type of this channel.
bool isSubscribed ()
 Determines whether the underlying channel is currently being subscribed to.
void joinChannel (nChannel *pDest, const std::string &selector)
 Sets a server based link between this channel and the channel defined within the provided nChannel.
void joinChannel (nChannel *pDest)
 Sets a server based link between this channel and the channel defined within the provided nChannel.
void joinChannel (nChannel *pDest, bool isRouted, int hopCount, const std::string &selector)
 Sets a server based link between this channel and the channel defined within the provided nChannel.
void joinChannel (nChannel *pDest, bool isRouted, int hopCount, const std::string &selector, bool allowPurge)
 Sets a server based link between this channel and the channel defined within the provided nChannel.
void joinChannel (nQueue *pDest, const std::string &selector)
 Sets a server based link between this channel and the queue defined by the *pDest parameter.
void joinChannel (nQueue *pDest)
 Sets a server based link between this channel and the queue defined within the provided nQueue.
void joinChannel (nQueue *pDest, bool isRouted, int hopCount, const std::string &selector)
 Sets a server based link between this channel and the queue defined within the provided nQueue.
void joinChannelToArchive (nQueue *pDest, const std::string &selector)
 Sets a server based link between this channel and the queue defined within the provided nQueue.
void publish (nConsumeEvent *pEvent)
 Publishes the specified nConsumeEvent to this channel.
void purgeEvent (longlong eidval, bool purgeJoins=false)
 Purges a single event from this channel.
void purgeEventAsync (longlong eidval, bool purgeJoins=false)
 Purges a single event from this channel and does not wait for the response from the server.
void purgeEvents (longlong startEID, longlong endEID, const std::string &selector="")
 Purges a range of events from this channel.
void purgeEventsAsync (longlong startEID, longlong endEID, const std::string &selector="")
 Purges a range of events from this channel and does not wait for the response from the server.
void removeConnectionListener (nChannelConnectionListener *pListener)
 Removes the connection listener to this channel.
void removeConnectionListener ()
 Removes the connection listener to this channel.
void removeSubscriber (nEventListener *pNel)
 Unregisters the specified nEventListener as a subscriber from this channel.
void reSubscribe (longlong eid)
 Removes the current subscriber and registers the specified nEventListener as a subscriber to this channel.
void reSubscribe (const std::string &selector, longlong eid=-1)
 Removes the current subscriber and re-registers the nEventListener as a subscriber to this channel.
void reSubscribe (nNamedObject *pName, const std::string &selector)
 Removes the current subscriber and registers the specified nEventListener as a named subscriber to this channel.
void unbindNamedObject (nNamedObject *pName)
 Unbinds the named object from the current connection.
void unbindNamedObject (const std::string &name)
 Unbinds the named object from the current connection.

Detailed Description

This class is a Nirvana channel, offering the Nirvana channel related services.

Member Function Documentation

void com.pcbsys.nirvana.client.nChannel.addConnectionListener ( nChannelConnectionListener *  pListener,
bool  isSync 
)

Adds a nChannelConnectionListener to this channel so that when new connections are made to this channel the listener is notified.

Parameters:
*pListener to add
isSync the call is synchronous
Exceptions:
nRequestTimedOutException if the request exceeded the timeout value
nSessionNotConnectedException The session is not currently connected to the server
nUnexpectedResponseException Received a response from the server for which we can not deal with, see the message for further information
nIllegalArgumentException Passed am illegal argument. This means the value passed is outside expected limits, or has already been set.
nSessionPausedException The session is currently paused, please resume

void com.pcbsys.nirvana.client.nChannel.addConnectionListener ( nChannelConnectionListener *  pListener  ) 

Adds a nChannelConnectionListener to this channel so that when new connections are made to this channel the listener is notified.

Parameters:
*pListener to add
Exceptions:
nRequestTimedOutException if the request exceeded the timeout value
nSessionNotConnectedException The session is not currently connected to the server
nUnexpectedResponseException Received a response from the server for which we can not deal with, see the message for further information
nIllegalArgumentException Passed am illegal argument. This means the value passed is outside expected limits, or has already been set.
nSessionPausedException The session is currently paused, please resume

void com.pcbsys.nirvana.client.nChannel.addSubscriber ( nEventListener *  pNel,
nNamedObject *  pName,
const std::string &  selector,
bool  bAutoAck,
nNamedPriorityListener *  pListener 
)

Registers the specified nEventListener as a named subscriber to this channel.

The subscriber will receive all events from the last acknowledged event for the name supplied If the name is new it will start from the END of the channel.

Parameters:
nel the nEventListener object to be registered as a subscriber
name an nNamedObject specifying a name for this subscription
selector a string specifying a filter to this subscription request
AutoAck a boolean used to control whether the nirvana client will automatically ack events or if the user will ack events later
listener a nNamedPriorityListener which is called back when this subscription reaches the top of the queue and is now the top priority to receive events
Exceptions:
nSecurityException is thrown if the caller has unsufficient permissions
nChannelNotFoundException if the channel no longer exists
nRequestTimedOutException if the request exceeded the timeout value
nSessionNotConnectedException The session is not currently connected to the server
nUnexpectedResponseException Received a response from the server for which we can not deal with, see the message for further information
nIllegalArgumentException Passed am illegal argument. This means the value passed is outside expected limits
nSelectorParserException The selector has syntax errors
nChannelAlreadySubscribedException A subscriber is already registered with this channel on this session
nNameAlreadyBoundException The name is already bound and used by another client
nSessionPausedException The session is currently paused
nNameDoesNotExistException if the server does not know about the named object

void com.pcbsys.nirvana.client.nChannel.addSubscriber ( nEventListener *  pNel,
nNamedObject *  pName,
nNamedPriorityListener *  pListener 
)

Registers the specified nEventListener as a named subscriber to this channel.

The subscriber will receive all events from the last acknowledged event for the name supplied If the name is new it will start from the END of the channel.

Parameters:
nel the nEventListener object to be registered as a subscriber
name a nNamedObject specifying a name for this subscription
listener a nNamedPriorityListener which is called back when this subscription reaches the top of the queue and is now the top priority to receive events
Exceptions:
nSecurityException is thrown if the caller has unsufficient permissions
nChannelNotFoundException if the channel no longer exists
nRequestTimedOutException if the request exceeded the timeout value
nSessionNotConnectedException The session is not currently connected to the server
nUnexpectedResponseException Received a response from the server for which we can not deal with, see the message for further information
nIllegalArgumentException Passed am illegal argument. This means the value passed is outside expected limits
nSelectorParserException The selector has syntax errors
nChannelAlreadySubscribedException A subscriber is already registered with this channel on this session
nNameAlreadyBoundException The name is already bound and used by another client
nSessionPausedException The session is currently paused
nNameDoesNotExistException if the server does not know about the named object

void com.pcbsys.nirvana.client.nChannel.addSubscriber ( nEventListener *  pNel,
nNamedObject *  pName,
const std::string &  selector,
bool  bAutoAck 
)

Registers the specified nEventListener as a named subscriber to this channel.

The subscriber will receive all events from the last acknowledged event for the name supplied If the name is new it will start from the END of the channel.

Parameters:
*pNel the nEventListener object to be registered as a subscriber
*pName an nNamedObject specifying a name for this subscription
selector a string specifying a filter to this subscription request
bAutoAck a bool used to control whether the nirvana client will automatically ack events or if the user will ack events later
Exceptions:
nSecurityException is thrown if the caller has insufficient permissions
nChannelNotFoundException if the channel no longer exists
nRequestTimedOutException if the request exceeded the timeout value
nSessionNotConnectedException The session is not currently connected to the server
nUnexpectedResponseException Received a response from the server for which we can not deal with, see the message for further information
nIllegalArgumentException Passed am illegal argument. This means the value passed is outside expected limits
nSelectorParserException The selector has syntax errors
nChannelAlreadySubscribedException A subscriber is already registered with this channel on this session
nNameAlreadyBoundException The name is already bound and used by another client
nSessionPausedException The session is currently paused
nNameDoesNotExistException if the server does not know about the named object

void com.pcbsys.nirvana.client.nChannel.addSubscriber ( nEventListener *  pNel,
nNamedObject *  pName 
)

Registers the specified nEventListener as a named subscriber to this channel.

The subscriber will receive all events from the last acknowledged event for the name supplied If the name is new it will start from the END of the channel.

Parameters:
*pNel the nEventListener object to be registered as a subscriber
*pName a nNamedObject specifying a name for this subscription
Exceptions:
nSecurityException is thrown if the caller has insufficient permissions
nChannelNotFoundException if the channel no longer exists
nRequestTimedOutException if the request exceeded the timeout value
nSessionNotConnectedException The session is not currently connected to the server
nUnexpectedResponseException Received a response from the server for which we can not deal with, see the message for further information
nIllegalArgumentException Passed am illegal argument. This means the value passed is outside expected limits
nSelectorParserException The selector has syntax errors
nChannelAlreadySubscribedException A subscriber is already registered with this channel on this session
nNameAlreadyBoundException The name is already bound and used by another client
nSessionPausedException The session is currently paused
nNameDoesNotExistException if the server does not know about the named object

void com.pcbsys.nirvana.client.nChannel.addSubscriber ( nEventListener *  pNel,
const std::string &  selector,
longlong  eid = -1 
)

Registers the specified nEventListener as a subscriber to this channel.

The subscriber will receive all events with event id greater than or equal to the one specified, apart from the ones restricted by the specified filter.

Parameters:
*pNel the nEventListener object to be registered as a subscriber
selector a string specifying a filter to this subscription request
eid a long specifying the subscription's start eid
Exceptions:
nSecurityException is thrown if the caller has insufficient permissions
nChannelNotFoundException if the channel no longer exists
nRequestTimedOutException if the request exceeded the timeout value
nSessionNotConnectedException The session is not currently connected to the server
nUnexpectedResponseException Received a response from the server for which we can not deal with, see the message for further information
nIllegalArgumentException Passed am illegal argument. This means the value passed is outside expected limits
nSelectorParserException The selector has syntax errors
nChannelAlreadySubscribedException A subscriber is already registered with this channel on this session
nSessionPausedException The session is currently paused

void com.pcbsys.nirvana.client.nChannel.addSubscriber ( nEventListener *  pNel,
longlong  eid 
)

Registers the specified nEventListener as a subscriber to this channel.

The subscriber will receive all events with event id greater than or equal to the one specified.

Parameters:
*pNel the nEventListener object to be registered as a subscriber
eid a long specifying the subscription's start eid
Exceptions:
nSecurityException is thrown if the caller has insufficient permissions
nChannelNotFoundException if the channel no longer exists
nRequestTimedOutException if the request exceeded the timeout value
nSessionNotConnectedException The session is not currently connected to the server
nUnexpectedResponseException Received a response from the server for which we can not deal with, see the message for further information
nIllegalArgumentException Passed am illegal argument. This means the value passed is outside expected limits
nChannelAlreadySubscribedException A subscriber is already registered with this channel on this session
nSessionPausedException The session is currently paused

void com.pcbsys.nirvana.client.nChannel.addSubscriber ( nEventListener *  pNel  ) 

Registers the specified nEventListener as a subscriber to this channel.

The subscriber will receive all events contained in this channel.

Parameters:
*pNel the nEventListener object to be registered as a subscriber
Exceptions:
nSecurityException is thrown if the caller has unsufficient permissions
nChannelNotFoundException if the channel no longer exists
nRequestTimedOutException if the request exceeded the timeout value
nSessionNotConnectedException The session is not currently connected to the server
nUnexpectedResponseException Received a response from the server for which we can not deal with, see the message for further information
nIllegalArgumentException Passed am illegal argument. This means the value passed is outside expected limits
nChannelAlreadySubscribedException A subscriber is already registered with this channel on this session

nChannelIterator* com.pcbsys.nirvana.client.nChannel.createIterator (  ) 

Create a default channel iterator starting at the beginning of the channel.

Returns:
nChannelIterator for the current channel

nChannelIterator* com.pcbsys.nirvana.client.nChannel.createIterator ( const std::string &  selector  ) 

Create a default channel iterator starting at the beginning of the channel with the events which match the selector being returned.

Parameters:
selector Used to specify a sub set of the current channel events
Returns:
nChannelIterator for the current channel

nChannelIterator* com.pcbsys.nirvana.client.nChannel.createIterator ( longlong  startEID  ) 

Create a default channel iterator starting at the EID specified.

Parameters:
startEID The event to start iterating the channel from
Returns:
nChannelIterator for the current channel

nChannelIterator* com.pcbsys.nirvana.client.nChannel.createIterator ( nNamedObject *  pName  ) 

Create a default channel iterator starting at the eid specified in the channel with the events which match the selector being returned.

Parameters:
*pName Named Object reference to use for this iterator
Returns:
nChannelIterator for the current channel

nChannelIterator* com.pcbsys.nirvana.client.nChannel.createIterator ( nNamedObject *  pName,
const std::string &  selector 
)

Create a default channel iterator starting at the eid specified in the channel with the events which match the selector being returned.

Parameters:
selector Used to specify a sub set of the current channel events
*pName Named Object reference to use for this iterator
Returns:
nChannelIterator for the current channel

nChannelIterator* com.pcbsys.nirvana.client.nChannel.createIterator ( const std::string &  selector,
longlong  startEID 
)

Create a default channel iterator starting at the eid specified in the channel with the events which match the selector being returned.

Parameters:
selector Used to specify a sub set of the current channel events
startEID The event to start iterating the channel from
Returns:
nChannelIterator for the current channel

nNamedObject* com.pcbsys.nirvana.client.nChannel.createNamedObject ( const std::string &  name,
longlong  startEID,
bool  persistent,
bool  clusterWide,
bool  enablePriority 
)

Creates a named object on the channel with the given name and depending on the persistent flag informs the server to store the name and value to disk or not.

Parameters:
name to create
startEID event EID to start the named object from
persistent flag to indicate to the server where to store it
clusterWide flag to indicate if this named object is valid in the entire cluster
enablePriority flag to indicate if multiple subscriptions will be prioritized on this object
Returns:
the nNamedObject created
Exceptions:
nSecurityException is thrown if the caller has unsufficient permissions
nChannelNotFoundException if the channel no longer exists
nRequestTimedOutException if the request exceeded the timeout value
nSessionNotConnectedException The session is not currently connected to the server
nNameAlreadyBoundException If the name is already in use
nUnexpectedResponseException Received a response from the server for which we can not deal with, see the message for further information
nIllegalArgumentException Passed am illegal argument. This means the value passed is outside expected limits
nSessionPausedException The session is currently paused, please resume

nNamedObject* com.pcbsys.nirvana.client.nChannel.createNamedObject ( const std::string &  name  ) 

Creates a named object on the channel with the given name.

Parameters:
name to create
Returns:
the nNamedObject created
Exceptions:
nSecurityException is thrown if the caller has insufficient permissions
nChannelNotFoundException if the channel no longer exists
nRequestTimedOutException if the request exceeded the timeout value
nSessionNotConnectedException The session is not currently connected to the server
nNameAlreadyBoundException If the name is already in use
nUnexpectedResponseException Received a response from the server for which we can not deal with, see the message for further information
nIllegalArgumentException Passed am illegal argument. This means the value passed is outside expected limits
nSessionPausedException The session is currently paused, please resume

nNamedObject* com.pcbsys.nirvana.client.nChannel.createNamedObject ( const std::string &  name,
longlong  startEID 
)

Creates a named object on the channel with the given name.

Parameters:
name to create
startEID event EID to start the named object from
Returns:
the nNamedObject created
Exceptions:
nSecurityException is thrown if the caller has insufficient permissions
nChannelNotFoundException if the channel no longer exists
nRequestTimedOutException if the request exceeded the timeout value
nSessionNotConnectedException The session is not currently connected to the server
nNameAlreadyBoundException If the name is already in use
nUnexpectedResponseException Received a response from the server for which we can not deal with, see the message for further information
nIllegalArgumentException Passed am illegal argument. This means the value passed is outside expected limits
nSessionPausedException The session is currently paused, please resume

nNamedObject* com.pcbsys.nirvana.client.nChannel.createNamedObject ( const std::string &  name,
longlong  startEID,
bool  persistent 
)

Creates a named object on the channel with the given name and depending on the persistent flag informs the server to store the name and value to disk or not.

Parameters:
name to create
startEID event EID to start the named object from
persistent flag to indicate to the server where to store it
Returns:
the nNamedObject created
Exceptions:
nSecurityException is thrown if the caller has insufficient permissions
nChannelNotFoundException if the channel no longer exists
nRequestTimedOutException if the request exceeded the timeout value
nSessionNotConnectedException The session is not currently connected to the server
nNameAlreadyBoundException If the name is already in use
nUnexpectedResponseException Received a response from the server for which we can not deal with, see the message for further information
nIllegalArgumentException Passed am illegal argument. This means the value passed is outside expected limits
nSessionPausedException The session is currently paused, please resume

nNamedObject* com.pcbsys.nirvana.client.nChannel.createNamedObject ( const std::string &  name,
bool  persistent 
)

Creates a named object on the channel with the given name and depending on the persistent flag informs the server to store the name and value to disk or not.

Parameters:
name to create
persistent flag to indicate to the server where to store it
Returns:
the nNamedObject created
Exceptions:
nSecurityException is thrown if the caller has insufficient permissions
nChannelNotFoundException if the channel no longer exists
nRequestTimedOutException if the request exceeded the timeout value
nSessionNotConnectedException The session is not currently connected to the server
nNameAlreadyBoundException If the name is already in use
nUnexpectedResponseException Received a response from the server for which we can not deal with, see the message for further information
nIllegalArgumentException Passed am illegal argument. This means the value passed is outside expected limits
nSessionPausedException The session is currently paused, please resume

nNamedObject* com.pcbsys.nirvana.client.nChannel.createNamedObject ( const std::string &  name,
bool  persistent,
bool  clusterWide 
)

Creates a named object on the channel with the given name and depending on the persistent flag informs the server to store the name and value to disk or not.

Parameters:
name to create
persistent flag to indicate to the server where to store it
clusterWide flag to indicate if this named object is valid in the entire cluster
Returns:
the nNamedObject created
Exceptions:
nSecurityException is thrown if the caller has insufficient permissions
nChannelNotFoundException if the channel no longer exists
nRequestTimedOutException if the request exceeded the timeout value
nSessionNotConnectedException The session is not currently connected to the server
nNameAlreadyBoundException If the name is already in use
nUnexpectedResponseException Received a response from the server for which we can not deal with, see the message for further information
nIllegalArgumentException Passed am illegal argument. This means the value passed is outside expected limits
nSessionPausedException The session is currently paused, please resume

nNamedObject* com.pcbsys.nirvana.client.nChannel.createNamedObject ( const std::string &  name,
longlong  startEID,
bool  persistent,
bool  clusterWide 
)

Creates a named object on the channel with the given name and depending on the persistent flag informs the server to store the name and value to disk or not.

Parameters:
name to create
startEID event EID to start the named object from
persistent flag to indicate to the server where to store it
clusterWide flag to indicate if this named object is valid in the entire cluster
Returns:
the nNamedObject created
Exceptions:
nSecurityException is thrown if the caller has insufficient permissions
nChannelNotFoundException if the channel no longer exists
nRequestTimedOutException if the request exceeded the timeout value
nSessionNotConnectedException The session is not currently connected to the server
nNameAlreadyBoundException If the name is already in use
nUnexpectedResponseException Received a response from the server for which we can not deal with, see the message for further information
nIllegalArgumentException Passed am illegal argument. This means the value passed is outside expected limits
nSessionPausedException The session is currently paused, please resume

void com.pcbsys.nirvana.client.nChannel.deleteJoin ( nChannel *  pDestination  ) 

Deletes a join between this channel and the channel referenced in the destination parameter.

Parameters:
*pDestination This is an nChannel object referencing the destination channel
Exceptions:
nSecurityException is thrown if the caller has insufficient permissions
nChannelNotFoundException if the channel no longer exists
nRequestTimedOutException if the request exceeded the timeout value
nSessionNotConnectedException The session is not currently connected to the server
nUnexpectedResponseException Received a response from the server for which we can not deal with, see the message for further information
nIllegalArgumentException Passed am illegal argument. This means the value passed is outside expected limits
nRealmNotFoundException The remote realm could not be found
nSessionPausedException The session is currently paused

void com.pcbsys.nirvana.client.nChannel.deleteJoin ( nQueue *  pDestination  ) 

Deletes a join between this channel and the queue referenced in the destination parameter.

Parameters:
*pDestination This is an nQueue object referencing the destination queue
Exceptions:
nSecurityException is thrown if the caller has insufficient permissions
nChannelNotFoundException if the queue no longer exists
nRequestTimedOutException if the request exceeded the timeout value
nSessionNotConnectedException The session is not currently connected to the server
nUnexpectedResponseException Received a response from the server for which we can not deal with, see the message for further information
nIllegalArgumentException Passed am illegal argument. This means the value passed is outside expected limits
nRealmNotFoundException The remote realm could not be found
nSessionPausedException The session is currently paused

void com.pcbsys.nirvana.client.nChannel.delNamedObject ( nNamedObject *  pName  ) 

Removes all references for this name on the realm Server.

Parameters:
*pName the name to be removed from the server
Exceptions:
nSecurityException is thrown if the caller has insufficient permissions
nChannelNotFoundException if the channel no longer exists
nRequestTimedOutException if the request exceeded the timeout value
nSessionNotConnectedException The session is not currently connected to the server
nUnexpectedResponseException Received a response from the server for which we can not deal with, see the message for further information
nIllegalArgumentException Passed am illegal argument. This means the value passed is outside expected limits
nNameDoesNotExistException The name specified does not exist on the server
nSessionPausedException The session is currently paused, please resume

void com.pcbsys.nirvana.client.nChannel.delNamedObject ( const std::string &  name  ) 

Removes all references for this name on the realm Server.

Parameters:
name the name to be removed from the server
Exceptions:
nSecurityException is thrown if the caller has insufficient permissions
nChannelNotFoundException if the channel no longer exists
nRequestTimedOutException if the request exceeded the timeout value
nSessionNotConnectedException The session is not currently connected to the server
nUnexpectedResponseException Received a response from the server for which we can not deal with, see the message for further information
nIllegalArgumentException Passed am illegal argument. This means the value passed is outside expected limits
nNameDoesNotExistException The name specified does not exist on the server
nSessionPausedException The session is currently paused, please resume

nChannelAttributes* com.pcbsys.nirvana.client.nChannel.getChannelAttributes (  ) 

Gets the channels local attributes.

Returns:
The associated nChannelAttributes object specifying the channel attributes

nJoinInformation** com.pcbsys.nirvana.client.nChannel.getJoinInformation ( int &  numJoin  ) 

Returns an array of nJoinInformation objects which describe the links this channel has configured for it.

Parameters:
numJoin number of nJoinInformation objects
Returns:
array of nJoinInformation objects
Exceptions:
nSecurityException is thrown if the caller has insufficient permissions
nChannelNotFoundException if the channel no longer exists
nRequestTimedOutException if the request exceeded the timeout value
nSessionNotConnectedException The session is not currently connected to the server
nUnexpectedResponseException Received a response from the server for which we can not deal with, see the message for further information
nRealmNotFoundException The remote realm could not be found
nSessionPausedException The session is currently paused

longlong com.pcbsys.nirvana.client.nChannel.getLastEID (  ) 

Gets the last event id of this channel.

Returns:
a long specifying the last event id of this channel
Exceptions:
nSecurityException is thrown if the caller has unsufficient permissions
nChannelNotFoundException if the channel no longer exists
nRequestTimedOutException if the request exceeded the timeout value
nSessionNotConnectedException The session is not currently connected to the server
nUnexpectedResponseException Received a response from the server for which we can not deal with, see the message for further information
nSessionPausedException The session is currently paused

longlong com.pcbsys.nirvana.client.nChannel.getLastStoredEID (  ) 

Gets the last event id of this channel.

Returns:
a long specifying the last event id stored on this channel
Exceptions:
nSecurityException is thrown if the caller has unsufficient permissions
nChannelNotFoundException if the channel no longer exists
nRequestTimedOutException if the request exceeded the timeout value
nSessionNotConnectedException The session is not currently connected to the server
nUnexpectedResponseException Received a response from the server for which we can not deal with, see the message for further information
nSessionPausedException The session is currently paused

std::string com.pcbsys.nirvana.client.nChannel.getName (  ) 

Gets the name of this channel.

Returns:
a string specifying the name of this channel

nNamedObject* com.pcbsys.nirvana.client.nChannel.getNamedObject ( const std::string &  name  ) 

Returns an instance of the nNamedObject referenced by the parameter.

Parameters:
name of the nNamedObject
Returns:
nNamedObject
Exceptions:
nSecurityException is thrown if the caller has insufficient permissions
nChannelNotFoundException if the channel no longer exists
nRequestTimedOutException if the request exceeded the timeout value
nSessionNotConnectedException The session is not currently connected to the server
nUnexpectedResponseException Received a response from the server for which we can not deal with, see the message for further information
nIllegalArgumentException Passed am illegal argument. This means the value passed is outside expected limits
nNameDoesNotExistException The name specified does not exist on the server
nSessionPausedException The session is currently paused, please resume

nNamedObject** com.pcbsys.nirvana.client.nChannel.getNamedObjects ( int &  numObject  ) 

Returns an array of all known nNamedObjects registered with this channel.

Parameters:
numObject number of nNamedObjects returned
Returns:
nNamedObject[] named objects
Exceptions:
nSecurityException is thrown if the caller has insufficient permissions
nChannelNotFoundException if the channel no longer exists
nRequestTimedOutException if the request exceeded the timeout value
nSessionNotConnectedException The session is not currently connected to the server
nUnexpectedResponseException Received a response from the server for which we can not deal with, see the message for further information
nSessionPausedException The session is currently paused, please resume

int com.pcbsys.nirvana.client.nChannel.getType (  ) 

Gets the type of this channel.

Currently supported types are:

nChanneAttributes.MIXED_TYPE
nChanneAttributes.SIMPLE_TYPE
nChanneAttributes.PERSISTENT_TYPE
nChanneAttributes.RELIABLE_TYPE
nChanneAttributes.TRANSIENT_TYPE

Returns:
an int specifying the channel's type, which will be equal to one of :
nChanneAttributes.MIXED_TYPE
nChanneAttributes.SIMPLE_TYPE
nChanneAttributes.PERSISTENT_TYPE
nChanneAttributes.RELIABLE_TYPE
nChanneAttributes.TRANSIENT_TYPE

See also:
nChannelAttributes

bool com.pcbsys.nirvana.client.nChannel.isSubscribed (  ) 

Determines whether the underlying channel is currently being subscribed to.

Returns:
true if the channel object is currently subscribed to

void com.pcbsys.nirvana.client.nChannel.joinChannel ( nChannel *  pDest,
const std::string &  selector 
)

Sets a server based link between this channel and the channel defined within the provided nChannel.

The link has a filter applied to it, defined by the provided selector string

Parameters:
*pDest a nChannel object defining the channel to be joined (linked) to this channel
selector A string defining a filter that will be applied in the join (link) of these 2 channels
Exceptions:
nSecurityException is thrown if the caller has insufficient permissions
nChannelNotFoundException if the channel no longer exists
nRequestTimedOutException if the request exceeded the timeout value
nSessionNotConnectedException The session is not currently connected to the server
nUnexpectedResponseException Received a response from the server for which we can not deal with, see the message for further information
nIllegalArgumentException Passed am illegal argument. This means the value passed is outside expected limits
nSelectorParserException The selector has syntax errors
nDuplicateJoinException The join already exists on the server
nRealmNotFoundException The remote realm could not be found
nSessionPausedException The session is currently paused

void com.pcbsys.nirvana.client.nChannel.joinChannel ( nChannel *  pDest  ) 

Sets a server based link between this channel and the channel defined within the provided nChannel.

Parameters:
*pDest a nChannel object defining the channel to be joined (linked) to this channel
Exceptions:
nSecurityException is thrown if the caller has insufficient permissions
nChannelNotFoundException if the channel no longer exists
nRequestTimedOutException if the request exceeded the timeout value
nSessionNotConnectedException The session is not currently connected to the server
nUnexpectedResponseException Received a response from the server for which we can not deal with, see the message for further information
nIllegalArgumentException Passed am illegal argument. This means the value passed is outside expected limits
nDuplicateJoinException The join already exists on the server
nRealmNotFoundException The remote realm could not be found
nSessionPausedException The session is currently paused

void com.pcbsys.nirvana.client.nChannel.joinChannel ( nChannel *  pDest,
bool  isRouted,
int  hopCount,
const std::string &  selector 
)

Sets a server based link between this channel and the channel defined within the provided nChannel.

Additional parameters specify whether the event is routable or not, the maximum number of hops the event can pass through and the filter applied to the join (link).

Parameters:
*pDest a nChannel object defining the channel to be joined (linked) to this channel
isRouted a bool flag specifying whether the event will be routed or not
hopCount an int specifying the maximum number of hops the event can pass through
selector A string defining a filter that will be applied in the join (link) of these 2 channels
Exceptions:
nSecurityException is thrown if the caller has insufficient permissions
nChannelNotFoundException if the channel no longer exists
nRequestTimedOutException if the request exceeded the timeout value
nSessionNotConnectedException The session is not currently connected to the server
nUnexpectedResponseException Received a response from the server for which we can not deal with, see the message for further information
nIllegalArgumentException Passed am illegal argument. This means the value passed is outside expected limits
nSelectorParserException The selector has syntax errors
nDuplicateJoinException The join already exists on the server
nRealmNotFoundException The remote realm could not be found
nSessionPausedException The session is currently paused

void com.pcbsys.nirvana.client.nChannel.joinChannel ( nChannel *  pDest,
bool  isRouted,
int  hopCount,
const std::string &  selector,
bool  allowPurge 
)

Sets a server based link between this channel and the channel defined within the provided nChannel.

Additional parameters specify whether the event is routable or not, the maximum number of hops the event can pass through and the filter applied to the join (link).

Parameters:
*pDest a nChannel object defining the channel to be joined (linked) to this channel
isRouted a bool flag specifying whether the event will be routed or not
hopCount an int specifying the maximum number of hops the event can pass through
selector A string defining a filter that will be applied in the join (link) of these 2 channels
allowPurge if allow purge is true then when the source channel is purged events source from it will also be purged
Exceptions:
nSecurityException is thrown if the caller has insufficient permissions
nChannelNotFoundException if the channel no longer exists
nRequestTimedOutException if the request exceeded the timeout value
nSessionNotConnectedException The session is not currently connected to the server
nUnexpectedResponseException Received a response from the server for which we can not deal with, see the message for further information
nIllegalArgumentException Passed am illegal argument. This means the value passed is outside expected limits
nSelectorParserException The selector has syntax errors
nDuplicateJoinException The join already exists on the server
nRealmNotFoundException The remote realm could not be found
nSessionPausedException The session is currently paused

void com.pcbsys.nirvana.client.nChannel.joinChannel ( nQueue *  pDest,
const std::string &  selector 
)

Sets a server based link between this channel and the queue defined by the *pDest parameter.

Additional parameter specifies the filter applied to the join (link).

Parameters:
*pDest a nQueue object defining the queue to be joined (linked) to this channel
selector A string defining a filter that will be applied in the join (link) from the source channel
Exceptions:
nSecurityException is thrown if the caller has insufficient permissions
nChannelNotFoundException if the channel no longer exists
nRequestTimedOutException if the request exceeded the timeout value
nSessionNotConnectedException The session is not currently connected to the server
nUnexpectedResponseException Received a response from the server for which we can not deal with, see the message for further information
nIllegalArgumentException Passed am illegal argument. This means the value passed is outside expected limits
nSelectorParserException The selector has syntax errors
nDuplicateJoinException The join already exists on the server
nRealmNotFoundException The remote realm could not be found
nSessionPausedException The session is currently paused

void com.pcbsys.nirvana.client.nChannel.joinChannel ( nQueue *  pDest  ) 

Sets a server based link between this channel and the queue defined within the provided nQueue.

The link has a filter applied to it, defined by the provided selector string

Parameters:
*pDest a nQueue object defining the queue to be joined (linked) to this channel
Exceptions:
nSecurityException is thrown if the caller has insufficient permissions
nChannelNotFoundException if the channel no longer exists
nRequestTimedOutException if the request exceeded the timeout value
nSessionNotConnectedException The session is not currently connected to the server
nUnexpectedResponseException Received a response from the server for which we can not deal with, see the message for further information
nIllegalArgumentException Passed am illegal argument. This means the value passed is outside expected limits
nDuplicateJoinException The join already exists on the server
nRealmNotFoundException The remote realm could not be found
nSessionPausedException The session is currently paused

void com.pcbsys.nirvana.client.nChannel.joinChannel ( nQueue *  pDest,
bool  isRouted,
int  hopCount,
const std::string &  selector 
)

Sets a server based link between this channel and the queue defined within the provided nQueue.

Additional parameters specify whether the event is routable or not, the maximum number of hops the event can pass through and the filter applied to the join (link).

Parameters:
*pDest a nQueue object defining the queue to be joined (linked) to this channel
isRouted a bool flag specifying whether the event will be routed or not
hopCount an int specifying the maximum number of hops the event can pass through
selector A string defining a filter that will be applied in the join (link) from the source channel
Exceptions:
nSecurityException is thrown if the caller has insufficient permissions
nChannelNotFoundException if the channel no longer exists
nRequestTimedOutException if the request exceeded the timeout value
nSessionNotConnectedException The session is not currently connected to the server
nUnexpectedResponseException Received a response from the server for which we can not deal with, see the message for further information
nIllegalArgumentException Passed am illegal argument. This means the value passed is outside expected limits
nSelectorParserException The selector has syntax errors
nDuplicateJoinException The join already exists on the server
nRealmNotFoundException The remote realm could not be found
nSessionPausedException The session is currently paused

void com.pcbsys.nirvana.client.nChannel.joinChannelToArchive ( nQueue *  pDest,
const std::string &  selector 
)

Sets a server based link between this channel and the queue defined within the provided nQueue.

Events will NOT be checked for duplicates since this is an archive join, any events that are published to the source will appear in the destination queue. This may result in duplicate events in the queue if the queue has multiple sources. This is by design.

Parameters:
dest a nQueue object defining the queue to be joined (linked) to this channel
Exceptions:
nSecurityException is thrown if the caller has insufficient permissions
nChannelNotFoundException if the channel no longer exists
nRequestTimedOutException if the request exceeded the timeout value
nSessionNotConnectedException The session is not currently connected to the server
nUnexpectedResponseException Received a response from the server for which we can not deal with, see the message for further information
nIllegalArgumentException Passed am illegal argument. This means the value passed is outside expected limits
nDuplicateJoinException The join already exists on the server
nRealmNotFoundException The remote realm could not be found
nSessionPausedException The session is currently paused

void com.pcbsys.nirvana.client.nChannel.publish ( nConsumeEvent *  pEvent  ) 

Publishes the specified nConsumeEvent to this channel.

Parameters:
*pEvent the nConsumeEvent object to be published to this channel
Exceptions:
nSecurityException is thrown if the caller has insufficient permissions
nSessionNotConnectedException The session is not currently connected to the server
nIllegalArgumentException Passed am illegal argument. This means the value passed is outside expected limits
nSessionPausedException The session is currently paused

void com.pcbsys.nirvana.client.nChannel.purgeEvent ( longlong  eidval,
bool  purgeJoins = false 
)

Purges a single event from this channel.

Parameters:
eidval a long specifying the event id of the event to be purged from the channel
purgeJoins a bool specifying if the event will be removed from all subsequent joins
Exceptions:
nSecurityException is thrown if the caller has insufficient permissions
nChannelNotFoundException if the channel no longer exists
nRequestTimedOutException if the request exceeded the timeout value
nSessionNotConnectedException The session is not currently connected to the server
nUnexpectedResponseException Received a response from the server for which we can not deal with, see the message for further information
nIllegalArgumentException Passed am illegal argument. This means the value passed is outside expected limits
nSessionPausedException The session is currently paused

void com.pcbsys.nirvana.client.nChannel.purgeEventAsync ( longlong  eidval,
bool  purgeJoins = false 
)

Purges a single event from this channel and does not wait for the response from the server.

Parameters:
eidval a long specifying the event id of the event to be purged from the channel
purgeJoins a bool specifying if the event will be removed from all subsequent joins
Exceptions:
nSecurityException is thrown if the caller has insufficient permissions
nChannelNotFoundException if the channel no longer exists
nRequestTimedOutException if the request exceeded the timeout value
nSessionNotConnectedException The session is not currently connected to the server
nUnexpectedResponseException Received a response from the server for which we can not deal with, see the message for further information
nIllegalArgumentException Passed am illegal argument. This means the value passed is outside expected limits
nSessionPausedException The session is currently paused

void com.pcbsys.nirvana.client.nChannel.purgeEvents ( longlong  startEID,
longlong  endEID,
const std::string &  selector = "" 
)

Purges a range of events from this channel.

Parameters:
startEID a long specifying the start event id of the range of events to be purged from the channel
endEID a long specifying the end event id of the range of events to be purged from the channel
selector A messages selector which will be used to filter out only the events which match this criteria
Exceptions:
nSecurityException is thrown if the caller has insufficient permissions
nChannelNotFoundException if the channel no longer exists
nRequestTimedOutException if the request exceeded the timeout value
nSessionNotConnectedException The session is not currently connected to the server
nUnexpectedResponseException Received a response from the server for which we can not deal with, see the message for further information
nIllegalArgumentException Passed am illegal argument. This means the value passed is outside expected limits
nSessionPausedException The session is currently paused

void com.pcbsys.nirvana.client.nChannel.purgeEventsAsync ( longlong  startEID,
longlong  endEID,
const std::string &  selector = "" 
)

Purges a range of events from this channel and does not wait for the response from the server.

Parameters:
startEID a long specifying the start event id of the range of events to be purged from the channel
endEID a long specifying the end event id of the range of events to be purged from the channel
selector A messages selector which will be used to filter out only the events which match this criteria
Exceptions:
nSecurityException is thrown if the caller has insufficient permissions
nChannelNotFoundException if the channel no longer exists
nRequestTimedOutException if the request exceeded the timeout value
nSessionNotConnectedException The session is not currently connected to the server
nUnexpectedResponseException Received a response from the server for which we can not deal with, see the message for further information
nIllegalArgumentException Passed am illegal argument. This means the value passed is outside expected limits
nSessionPausedException The session is currently paused

void com.pcbsys.nirvana.client.nChannel.removeConnectionListener ( nChannelConnectionListener *  pListener  ) 

Removes the connection listener to this channel.

Parameters:
*pListener remove the listener
Exceptions:
nRequestTimedOutException if the request exceeded the timeout value
nSessionNotConnectedException The session is not currently connected to the server
nUnexpectedResponseException Received a response from the server for which we can not deal with, see the message for further information
nSessionPausedException The session is currently paused, please resume

void com.pcbsys.nirvana.client.nChannel.removeConnectionListener (  ) 

Removes the connection listener to this channel.

Exceptions:
nRequestTimedOutException if the request exceeded the timeout value
nSessionNotConnectedException The session is not currently connected to the server
nUnexpectedResponseException Received a response from the server for which we can not deal with, see the message for further information
nSessionPausedException The session is currently paused, please resume

void com.pcbsys.nirvana.client.nChannel.removeSubscriber ( nEventListener *  pNel  ) 

Unregisters the specified nEventListener as a subscriber from this channel.

The subscriber will not receive any more events.

Parameters:
*pNel the nEventListener object to be registered as a subscriber
Exceptions:
nRequestTimedOutException if the request exceeded the timeout value
nSessionNotConnectedException The session is not currently connected to the server
nUnexpectedResponseException Received a response from the server for which we can not deal with, see the message for further information
nIllegalArgumentException Passed am illegal argument. This means the value passed is outside expected limits
nSessionPausedException The session is currently paused, please resume

void com.pcbsys.nirvana.client.nChannel.reSubscribe ( longlong  eid  ) 

Removes the current subscriber and registers the specified nEventListener as a subscriber to this channel.

The subscriber will receive all events with event id greater than or equal to the one specified

Parameters:
eid a long specifying the subscription's start eid
Exceptions:
nSecurityException is thrown if the caller has insufficient permissions
nChannelNotFoundException if the channel no longer exists
nRequestTimedOutException if the request exceeded the timeout value
nSessionNotConnectedException The session is not currently connected to the server
nUnexpectedResponseException Received a response from the server for which we can not deal with, see the message for further information
nIllegalArgumentException Passed am illegal argument. This means the value passed is outside expected limits
nSelectorParserException The selector has syntax errors
nChannelAlreadySubscribedException A subscriber is already registered with this channel on this session
nSessionPausedException The session is currently paused

void com.pcbsys.nirvana.client.nChannel.reSubscribe ( const std::string &  selector,
longlong  eid = -1 
)

Removes the current subscriber and re-registers the nEventListener as a subscriber to this channel.

The subscriber will receive all events with event id greater than or equal to the one specified, apart from the ones restricted by the specified filter.

Parameters:
selector a string specifying a filter to this subscription request
eid a long specifying the subscription's start eid
Exceptions:
nSecurityException is thrown if the caller has insufficient permissions
nChannelNotFoundException if the channel no longer exists
nRequestTimedOutException if the request exceeded the timeout value
nSessionNotConnectedException The session is not currently connected to the server
nUnexpectedResponseException Received a response from the server for which we can not deal with, see the message for further information
nIllegalArgumentException Passed am illegal argument. This means the value passed is outside expected limits
nSelectorParserException The selector has syntax errors
nChannelAlreadySubscribedException A subscriber is already registered with this channel on this session
nSessionPausedException The session is currently paused

void com.pcbsys.nirvana.client.nChannel.reSubscribe ( nNamedObject *  pName,
const std::string &  selector 
)

Removes the current subscriber and registers the specified nEventListener as a named subscriber to this channel.

The subscriber will receive all events from the last acknowledged event for the name supplied If the name is new it will start from the END of the channel.

Parameters:
*pName a named object for this subscription
selector a string specifying a filter to this subscription request
Exceptions:
nSecurityException is thrown if the caller has insufficient permissions
nChannelNotFoundException if the channel no longer exists
nRequestTimedOutException if the request exceeded the timeout value
nSessionNotConnectedException The session is not currently connected to the server
nUnexpectedResponseException Received a response from the server for which we can not deal with, see the message for further information
nIllegalArgumentException Passed am illegal argument. This means the value passed is outside expected limits
nSelectorParserException The selector has syntax errors
nChannelAlreadySubscribedException A subscriber is already registered with this channel on this session
nNameAlreadyBoundException The name is already bound and used by another client
nSessionPausedException The session is currently paused
nNameDoesNotExistException if the server does not know about the named object

void com.pcbsys.nirvana.client.nChannel.unbindNamedObject ( nNamedObject *  pName  ) 

Unbinds the named object from the current connection.

Parameters:
*pName the named object to be unbound
Exceptions:
nSecurityException is thrown if the caller has insufficient permissions
nChannelNotFoundException if the channel no longer exists
nRequestTimedOutException if the request exceeded the timeout value
nSessionNotConnectedException The session is not currently connected to the server
nUnexpectedResponseException Received a response from the server for which we can not deal with, see the message for further information
nIllegalArgumentException Passed am illegal argument. This means the value passed is outside expected limits
nNameDoesNotExistException The name specified does not exist on the server
nSessionPausedException The session is currently paused, please resume

void com.pcbsys.nirvana.client.nChannel.unbindNamedObject ( const std::string &  name  ) 

Unbinds the named object from the current connection.

Parameters:
name the name to be unbound
Exceptions:
nSecurityException is thrown if the caller has insufficient permissions
nChannelNotFoundException if the channel no longer exists
nRequestTimedOutException if the request exceeded the timeout value
nSessionNotConnectedException The session is not currently connected to the server
nUnexpectedResponseException Received a response from the server for which we can not deal with, see the message for further information
nIllegalArgumentException Passed am illegal argument. This means the value passed is outside expected limits
nNameDoesNotExistException The name specified does not exist on the server
nSessionPausedException The session is currently paused, please resume