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

Public Member Functions

void close ()
 Closes the OOB session with the remote P2P service.
void deregisterListener (nEventServiceListener listener)
 Removes the registered nEventServiceListener from this service.
nConsumeEvent read (long timeout)
 Waits for a new nConsumeEvent to be received from the remote service or the timeout to be reached.
nConsumeEvent read ()
 Waits for a new nConsumeEvent to be received from the remote service.
void registerListener (nEventServiceListener listener)
 Registers an nEventServiceListener with this class.
void write (nConsumeEvent evt)
 Writes an nConsumeEvent to the remote P2P service.

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

Reimplemented from com.pcbsys.nirvana.client.p2p.nService.

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:
listener an nEventServiceListener to stop getting the callbacks
Exceptions:
Exception if Service is closed or listener is null

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:
timeout Time in milliseconds to wait for the event to be received
Returns:
nConsumeEvent received from the remote service
Exceptions:
Exception if the lower streams have an error, See the message or more information

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:
Exception if 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:
listener an nEventServiceListener to receive the callbacks
Exceptions:
Exception if 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:
evt An nConsumeEvent to send to the remote service
Exceptions:
Exception if the lower streams have an error, See the message or more information