This class enables services to pass flow information or control information between them. More...
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... | |
![]() | |
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... | |
This class enables services to pass flow information or control information between them.
It enables prioritised messaging between the services
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
listener | an nEventServiceListener to stop getting the callbacks |
Exception | if 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.
Exception | if 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.
timeout | Time in milliseconds to wait for the event to be received |
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
listener | an nEventServiceListener to receive the callbacks |
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.
evt | An nConsumeEvent to send to the remote service |
Exception | if the lower streams have an error, See the message or more information |