com.pcbsys.nirvana.client.p2p.nOutOfBandService Class Reference

This class enables services to pass flow information or control information between them. More...

Inheritance diagram for com.pcbsys.nirvana.client.p2p.nOutOfBandService:
com.pcbsys.nirvana.client.p2p.nService com.pcbsys.nirvana.client.Observable

Public Member Functions

void close ()
 Closes the OOB session with the remote P2P service. More...
 
void deregisterListener (nEventServiceListener listener)
 Removes the registered nEventServiceListener from this service. More...
 
nConsumeEvent read ()
 Waits for a new nConsumeEvent to be received from the remote service. More...
 
nConsumeEvent read (long timeout)
 Waits for a new nConsumeEvent to be received from the remote service or the timeout to be reached. More...
 
void registerListener (nEventServiceListener listener)
 Registers an nEventServiceListener with this class. More...
 
void write (nConsumeEvent evt)
 Writes an nConsumeEvent to the remote P2P service. More...
 
- Public Member Functions inherited from com.pcbsys.nirvana.client.p2p.nService
void close ()
 Closes the service and informs the remote service that it has been closed. More...
 
nServiceInfo getServiceInfo ()
 Returns the description of the service connected to. More...
 
nServiceStateListener getStateListener ()
 Return the state listener associated with this service More...
 
bool isClosed ()
 Returns a flag indicating if the service has been closed with the More...
 
bool isConnected ()
 Returns whether the service is physically connected to the realm More...
 
void setStateListener (nServiceStateListener listener)
 Set the listener that will receive callbacks for state changes to the service More...
 
- Public Member Functions inherited from com.pcbsys.nirvana.client.Observable
void addObserver (IObserver o)
 Adds an observer to the set of observers for this object, provided that it is not the same as some observer already in the set. More...
 
int countObservers ()
 Returns the number of observers of this Observable object. More...
 
void deleteObserver (IObserver o)
 Deletes an observer from the set of observers of this object. More...
 
void deleteObservers ()
 Clears the observer list so that this object no longer has any observers. More...
 
bool hasChanged ()
 Tests if this object has changed. More...
 
void notifyObservers ()
 If this object has changed, as indicated by the hasChanged method, then notify all of its observers and then call the clearChanged method to indicate that this object has no longer changed. More...
 
void notifyObservers (Object arg)
 If this object has changed, as indicated by the More...
 
 Observable ()
 Construct an Observable with zero Observers. More...
 

Additional Inherited Members

- Protected Member Functions inherited from com.pcbsys.nirvana.client.Observable
void clearChanged ()
 Indicates that this object has no longer changed, or that it has already notified all of its observers of its most recent change, so that the hasChanged method will now return false. More...
 
void setChanged ()
 Marks this Observable object as having been changed; the hasChanged method will now return true. More...
 

Detailed Description

This class enables services to pass flow information or control information between them.

It enables prioritised messaging between the services

Member Function Documentation

void com.pcbsys.nirvana.client.p2p.nOutOfBandService.close ( )

Closes the OOB session with the remote P2P service.

It does NOT close the main p2p service

void com.pcbsys.nirvana.client.p2p.nOutOfBandService.deregisterListener ( nEventServiceListener  listener)

Removes the registered nEventServiceListener from this service.

When all listeners are removed then the read() method can then be called

Parameters
listeneran nEventServiceListener to stop getting the callbacks
Exceptions
Exceptionif Service is closed or listener is null
nConsumeEvent com.pcbsys.nirvana.client.p2p.nOutOfBandService.read ( )

Waits for a new nConsumeEvent to be received from the remote service.

Returns
nConsumeEvent received from the remote service
Exceptions
Exceptionif the lower streams have an error, See the message or more information
nConsumeEvent com.pcbsys.nirvana.client.p2p.nOutOfBandService.read ( long  timeout)

Waits for a new nConsumeEvent to be received from the remote service or the timeout to be reached.

Parameters
timeoutTime in milliseconds to wait for the event to be received
Returns
nConsumeEvent received from the remote service
Exceptions
Exceptionif the lower streams have an error, See the message or more information
void com.pcbsys.nirvana.client.p2p.nOutOfBandService.registerListener ( nEventServiceListener  listener)

Registers an nEventServiceListener with this class.

This nEventServiceListener will be called whenever there is a new event received

Once this is called then this will preclude the use of the read() method

Parameters
listeneran nEventServiceListener to receive the callbacks
Exceptions
Exceptionif Service is closed or listener is null
void com.pcbsys.nirvana.client.p2p.nOutOfBandService.write ( nConsumeEvent  evt)

Writes an nConsumeEvent to the remote P2P service.

Parameters
evtAn nConsumeEvent to send to the remote service
Exceptions
Exceptionif the lower streams have an error, See the message or more information