com::pcbsys::nirvana::client::p2p::nStreamService Class Reference

This class implements the end point of a stream based P2P connection. More...

#include <nStreamService.h>

Inheritance diagram for com::pcbsys::nirvana::client::p2p::nStreamService:
com::pcbsys::nirvana::client::p2p::nService

Public Member Functions

void close ()
 Closes the service and informs the remote service that it has been closed. More...
 
Stream * getInputStream ()
 Returns the input stream that can be used to read from the remote service. More...
 
nOutOfBandServicegetOutOfBandService ()
 This function returns an nOutOfBandService. More...
 
Stream * getOutputStream ()
 Returns the output stream that can be used to write to the remote 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...
 
nServiceInfogetServiceInfo ()
 Returns the description of the service connected to. More...
 
nServiceStateListenergetStateListener ()
 Return the state listener associated with this service. More...
 
bool isClosed ()
 Returns a flag indicating if the service has been closed with the close() method. More...
 
bool isConnected ()
 Returns whether the service is physically connected to the realm. More...
 
void setStateListener (nServiceStateListener *pListener)
 Set the listener that will receive callbacks for state changes to the service. More...
 

Detailed Description

This class implements the end point of a stream based P2P connection.

It offers an InputStream and an OutputStream to enable each end of the pipe to communicate with each other.

See Also
nEventService

Member Function Documentation

void com::pcbsys::nirvana::client::p2p::nStreamService::close ( )

Closes the service and informs the remote service that it has been closed.

Exceptions
IOExceptionIf unable to perform the close, see the message for further information
Stream* com::pcbsys::nirvana::client::p2p::nStreamService::getInputStream ( )

Returns the input stream that can be used to read from the remote service.

Returns
Stream
nOutOfBandService* com::pcbsys::nirvana::client::p2p::nStreamService::getOutOfBandService ( )

This function returns an nOutOfBandService.

An out of band (OOB) service can be used to pass flow/control information between the remote P2P service.

Returns
Returns a new nOutOfBandService object connected with the remote service
See Also
nOutOfBandService
Stream* com::pcbsys::nirvana::client::p2p::nStreamService::getOutputStream ( )

Returns the output stream that can be used to write to the remote service.

Returns
Stream