YARP  2.3.68+272-20170522.1+git50f0ae7
Yet Another Robot Platform
yarp::os::TwoWayStream Class Referenceabstract

A stream which can be asked to perform bidirectional communication. More...

#include <yarp/os/TwoWayStream.h>

+ Inheritance diagram for yarp::os::TwoWayStream:

Public Member Functions

virtual ~TwoWayStream ()
 Destructor. More...
 
virtual InputStreamgetInputStream ()=0
 Get an InputStream to read from. More...
 
virtual OutputStreamgetOutputStream ()=0
 Get an OutputStream to write to. More...
 
virtual const ContactgetLocalAddress ()=0
 Get the address of the local side of the stream. More...
 
virtual const ContactgetRemoteAddress ()=0
 Get the address of the remote side of the stream. More...
 
virtual bool isOk ()=0
 Check if the stream is ok or in an error state. More...
 
virtual void reset ()=0
 Reset the stream. More...
 
virtual void close ()=0
 Terminate the stream. More...
 
virtual void beginPacket ()=0
 Mark the beginning of a logical packet. More...
 
virtual void endPacket ()=0
 Mark the end of a logical packet (see beginPacket). More...
 

Detailed Description

A stream which can be asked to perform bidirectional communication.

It need not actually be capable of communication in both directions, in which case it should fail if requested to communicate in an unsupported direction.

Definition at line 28 of file TwoWayStream.h.

Constructor & Destructor Documentation

◆ ~TwoWayStream()

TwoWayStream::~TwoWayStream ( )
virtual

Destructor.

Definition at line 11 of file TwoWayStream.cpp.

Member Function Documentation

◆ beginPacket()

virtual void yarp::os::TwoWayStream::beginPacket ( )
pure virtual

◆ close()

◆ endPacket()

◆ getInputStream()

◆ getLocalAddress()

virtual const Contact& yarp::os::TwoWayStream::getLocalAddress ( )
pure virtual

◆ getOutputStream()

◆ getRemoteAddress()

virtual const Contact& yarp::os::TwoWayStream::getRemoteAddress ( )
pure virtual

◆ isOk()

◆ reset()


The documentation for this class was generated from the following files: