com.pcbsys.nirvana.client.nChannel Class Reference

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

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

com.pcbsys.nirvana.client.nAbstractChannel

Public Member Functions

void addConnectionListener (nChannelConnectionListener listener, 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 listener)
 Adds a nChannelConnectionListener to this channel so that when new connections are made to this channel the listener is notified.
void addSubscriber (nEventListener nel, nNamedObject name, nNamedPriorityListener listener)
 Registers the specified nEventListener as a named subscriber to this channel.
void addSubscriber (nEventListener nel, nNamedObject name, string selector, bool AutoAck, nNamedPriorityListener listener)
 Registers the specified nEventListener as a named subscriber to this channel.
void addSubscriber (nEventListener nel, nNamedObject name)
 Registers the specified nEventListener as a named subscriber to this channel.
void addSubscriber (nEventListener nel, nNamedObject name, string selector, bool AutoAck)
 Registers the specified nEventListener as a named subscriber to this channel.
void addSubscriber (nEventListener nel, string selector, long eid)
 Registers the specified nEventListener as a subscriber to this channel.
void addSubscriber (nEventListener nel, string selector)
 Registers the specified nEventListener as a subscriber to this channel.
void addSubscriber (nEventListener nel, long eid)
 Registers the specified nEventListener as a subscriber to this channel.
void addSubscriber (nEventListener nel)
 Registers the specified nEventListener as a subscriber to this channel.
nChannelIterator createIterator (nNamedObject name, 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 (nNamedObject name)
 Create a default channel iterator starting at the eid specified in the channel with the events which match the selector being returned.
nChannelIterator createIterator (string selector, long startEID)
 Create a default channel iterator starting at the eid specified in the channel with the events which match the selector being returned.
nChannelIterator createIterator (long startEID)
 Create a default channel iterator starting at the EID specified.
nChannelIterator createIterator (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 ()
 Create a default channel iterator starting at the beginning of the channel.
nNamedObject createNamedObject (string name, long 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 (string name, long 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.
nNamedObject createNamedObject (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 (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 (string name, long 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 (string name, long startEID)
 Creates a named object on the channel with the given name.
nNamedObject createNamedObject (string name)
 Creates a named object on the channel with the given name.
nRegisteredEvent createRegisteredEvent (object keyValue, bool isTransactional)
 Creates a new nRegisteredEvent bound to this channel using the keyValue as its unique id.
nRegisteredEvent createRegisteredEvent (object keyValue)
 Creates a new nRegisteredEvent bound to this channel using the keyValue as its unique id.
void deleteJoin (nQueue destination)
 Deletes a join between this channel and the queue referenced in the destination parameter.
void deleteJoin (nChannel destination)
 Deletes a join between this channel and the channel referenced in the destination parameter.
void delNamedObject (string name)
 Removes all references for this name on the realm Server.
void delNamedObject (nNamedObject name)
 Removes all references for this name on the realm Server.
nJoinInformation[] getJoinInformation ()
 Returns an array of nJoinInformation objects which describe the links this channel has configured for it.
long getLastEID ()
 Gets the last event id of this channel.
long getLastStoredEID ()
 Gets the last event id of this channel.
string getName ()
 Gets the name of this channel.
nNamedObject getNamedObject (string name)
 Returns an instance of the nNamedObject referenced by the parameter.
nNamedObject[] getNamedObjects ()
 Returns an array of all known nNamedObjects registered with this channel.
int 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
.
bool isSubscribed ()
 Determines whether the underlying channel is currently being subscribed to.
void joinChannel (nQueue dest, bool isRouted, int hopCount, string selector)
 Sets a server based link between this channel and the queue defined within the provided nQueue.
void joinChannel (nQueue dest)
 Sets a server based link between this channel and the queue defined within the provided nQueue.
void joinChannel (nQueue dest, string selector)
 Sets a server based link between this channel and the queue defined by the dest parameter.
void joinChannel (nChannel dest, bool isRouted, int hopCount, string selector, bool allowPurge)
 Sets a server based link between this channel and the channel defined within the provided nChannel.
void joinChannel (nChannel dest, bool isRouted, int hopCount, string selector)
 Sets a server based link between this channel and the channel defined within the provided nChannel.
void joinChannel (nChannel dest)
 Sets a server based link between this channel and the channel defined within the provided nChannel.
void joinChannel (nChannel dest, string selector)
 Sets a server based link between this channel and the channel defined within the provided nChannel.
void joinChannelToArchive (nQueue dest, string selector)
 Sets a server based link between this channel and the queue defined within the provided nQueue.
void joinChannelToArchive (nQueue dest)
 Sets a server based link between this channel and the queue defined within the provided nQueue.
void publish (nConsumeEvent e)
 Publishes the specified nConsumeEvent to this channel.
void purgeEvent (long eidval, bool purgeJoins)
 Purges a single event from this channel.
void purgeEvent (long eidval)
 Purges a single event from this channel.
void purgeEventAsync (long eidval, bool purgeJoins)
 Purges a single event from this channel and does not wait for the response from the server.
void purgeEventAsync (long eidval)
 Purges a single event from this channel and does not wait for the response from the server.
void purgeEvents (long startEID, long endEID, string selector)
 Purges a range of events from this channel.
void purgeEvents (long startEID, long endEID)
 Purges a range of events from this channel.
void purgeEventsAsync (long startEID, long endEID, string selector)
 Purges a range of events from this channel and does not wait for the response from the server.
void purgeEventsAsync (long startEID, long endEID)
 Purges a range of events from this channel and does not wait for the response from the server.
void removeConnectionListener (nChannelConnectionListener listener)
 Removes the connection listener to this channel.
void removeConnectionListener ()
 Removes the connection listener to this channel.
void removeSubscriber (nEventListener nel)
 Unregisters the specified nEventListener as a subscriber from this channel.
void reSubscribe (nNamedObject name, string selector)
 Removes the current subscriber and registers the specified nEventListener as a named subscriber to this channel.
void reSubscribe (string selector, long eid)
 Removes the current subscriber and re-registers the nEventListener as a subscriber to this channel.
void reSubscribe (long eid)
 Removes the current subscriber and registers the specified nEventListener as a subscriber to this channel.
void reSubscribe (string selector)
 Removes the current subscriber and re-registers the nEventListener as a subscriber to this channel.
void unbindNamedObject (string name)
 Unbinds the named object from the current connection.
void unbindNamedObject (nNamedObject name)
 Unbinds the named object from the current connection.

Protected Member Functions

internal nEvent writeEvent (nEvent evt)
 Writes an event to the server using the associated session.

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  listener,
bool  isSync 
)

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

Parameters:
listener 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  listener  ) 

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

Parameters:
listener 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  nel,
nNamedObject  name,
nNamedPriorityListener  listener 
)

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  nel,
nNamedObject  name,
string  selector,
bool  AutoAck,
nNamedPriorityListener  listener 
)

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  nel,
nNamedObject  name 
)

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
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  nel,
nNamedObject  name,
string  selector,
bool  AutoAck 
)

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 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  nel,
string  selector,
long  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, apart from the ones restricted by the specified filter.

Parameters:
nel 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  nel,
string  selector 
)

Registers the specified nEventListener as a subscriber to this channel.

The subscriber will receive all events contained in this channel, apart from the ones restricted by the specified filter.

Parameters:
nel the nEventListener object to be registered as a subscriber
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
nSessionPausedException The session is currently paused

void com.pcbsys.nirvana.client.nChannel.addSubscriber ( nEventListener  nel,
long  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:
nel 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  nel  ) 

Registers the specified nEventListener as a subscriber to this channel.

The subscriber will receive all events contained in this channel.

Parameters:
nel the nEventListener object to be registered as a subscriber
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

nChannelIterator com.pcbsys.nirvana.client.nChannel.createIterator ( nNamedObject  name,
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
name Named Object reference to use for this iterator
Returns:
nChannelIterator for the current channel

nChannelIterator com.pcbsys.nirvana.client.nChannel.createIterator ( nNamedObject  name  ) 

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

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

nChannelIterator com.pcbsys.nirvana.client.nChannel.createIterator ( string  selector,
long  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

nChannelIterator com.pcbsys.nirvana.client.nChannel.createIterator ( long  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 ( 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 (  ) 

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

Returns:
nChannelIterator for the current channel

nNamedObject com.pcbsys.nirvana.client.nChannel.createNamedObject ( string  name,
long  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 ( string  name,
long  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

nNamedObject com.pcbsys.nirvana.client.nChannel.createNamedObject ( 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 ( 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 ( string  name,
long  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 ( string  name,
long  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 ( 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

nRegisteredEvent com.pcbsys.nirvana.client.nChannel.createRegisteredEvent ( object  keyValue,
bool  isTransactional 
)

Creates a new nRegisteredEvent bound to this channel using the keyValue as its unique id.

Parameters:
keyValue Unquie Id to use for the nRegisteredEvent
isTransactional Indicates that all commits on the nRegistedEvent should use transactional symantics
Returns:
nRegistedEvent
Exceptions:
nIllegalArgumentException if unable to create the nRegisteredEvent object

nRegisteredEvent com.pcbsys.nirvana.client.nChannel.createRegisteredEvent ( object  keyValue  ) 

Creates a new nRegisteredEvent bound to this channel using the keyValue as its unique id.

Parameters:
keyValue Unquie Id to use for the nRegisteredEvent
Returns:
nRegistedEvent
Exceptions:
nIllegalArgumentException if unable to create the nRegisteredEvent object

void com.pcbsys.nirvana.client.nChannel.deleteJoin ( nQueue  destination  ) 

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

Parameters:
destination 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.deleteJoin ( nChannel  destination  ) 

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

Parameters:
destination 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.delNamedObject ( 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

void com.pcbsys.nirvana.client.nChannel.delNamedObject ( nNamedObject  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

nJoinInformation [] com.pcbsys.nirvana.client.nChannel.getJoinInformation (  ) 

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

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

long 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 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

long 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 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

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 ( 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 (  ) 

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

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
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 ( nQueue  dest,
bool  isRouted,
int  hopCount,
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:
dest 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.joinChannel ( nQueue  dest  ) 

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:
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.joinChannel ( nQueue  dest,
string  selector 
)

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

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

Parameters:
dest 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 ( nChannel  dest,
bool  isRouted,
int  hopCount,
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:
dest 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 ( nChannel  dest,
bool  isRouted,
int  hopCount,
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:
dest 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  dest  ) 

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

Parameters:
dest 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  dest,
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:
dest 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.joinChannelToArchive ( nQueue  dest,
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). 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
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  dest  ) 

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 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  e  ) 

Publishes the specified nConsumeEvent to this channel.

Parameters:
e 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 ( long  eidval,
bool  purgeJoins 
)

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.purgeEvent ( long  eidval  ) 

Purges a single event from this channel.

Parameters:
eidval a long specifying the event id of the event to be purged from the 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
nSessionPausedException The session is currently paused

void com.pcbsys.nirvana.client.nChannel.purgeEventAsync ( long  eidval,
bool  purgeJoins 
)

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.purgeEventAsync ( long  eidval  ) 

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
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 ( long  startEID,
long  endEID,
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.purgeEvents ( long  startEID,
long  endEID 
)

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
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 ( long  startEID,
long  endEID,
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.purgeEventsAsync ( long  startEID,
long  endEID 
)

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
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  listener  ) 

Removes the connection listener to this channel.

Parameters:
listener 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  nel  ) 

Unregisters the specified nEventListener as a subscriber from this channel.

The subscriber will not receive any more events.

Parameters:
nel 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 ( nNamedObject  name,
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:
name 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.reSubscribe ( string  selector,
long  eid 
)

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 ( long  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 ( string  selector  ) 

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

The subscriber will receive all events on the channel apart from the ones restricted by the specified filter.

Parameters:
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
nChannelAlreadySubscribedException A subscriber is already registered with this channel on this session

void com.pcbsys.nirvana.client.nChannel.unbindNamedObject ( 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

void com.pcbsys.nirvana.client.nChannel.unbindNamedObject ( nNamedObject  name  ) 

Unbinds the named object from the current connection.

Parameters:
name 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

internal nEvent com.pcbsys.nirvana.client.nChannel.writeEvent ( nEvent  evt  )  [protected]

Writes an event to the server using the associated session.

Parameters:
evt The nEvent object that is written to the server
Returns:
The nEvent object that the server responds with if the event is synchronous, null otherwise
Exceptions:
nRequestTimedOutException if the request exceeded the timeout value
nSessionNotConnectedException The session is not connected to the server
nSessionPausedException The session is currently paused