YARP
Yet Another Robot Platform
 
Loading...
Searching...
No Matches
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.
 
virtual InputStreamgetInputStream ()=0
 Get an InputStream to read from.
 
virtual OutputStreamgetOutputStream ()=0
 Get an OutputStream to write to.
 
virtual const ContactgetLocalAddress () const =0
 Get the address of the local side of the stream.
 
virtual const ContactgetRemoteAddress () const =0
 Get the address of the remote side of the stream.
 
virtual bool isOk () const =0
 Check if the stream is ok or in an error state.
 
virtual void reset ()=0
 Reset the stream.
 
virtual void close ()=0
 Terminate the stream.
 
virtual void beginPacket ()=0
 Mark the beginning of a logical packet.
 
virtual void endPacket ()=0
 Mark the end of a logical packet (see beginPacket).
 

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 24 of file TwoWayStream.h.

Constructor & Destructor Documentation

◆ ~TwoWayStream()

TwoWayStream::~TwoWayStream ( )
virtualdefault

Destructor.

Member Function Documentation

◆ beginPacket()

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

◆ close()

◆ endPacket()

◆ getInputStream()

◆ getLocalAddress()

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

Get the address of the local side of the stream.

Returns
the address of the local side of the stream. The address will be tagged as invalid if the stream is not set up.

Implemented in HumanStream, MjpegStream, MpiStream, ShmemHybridStream, UnixSockTwoWayStream, WebSocketStream, yarp::os::impl::DgramTwoWayStream, yarp::os::impl::FakeTwoWayStream, yarp::os::impl::HttpTwoWayStream, yarp::os::impl::LocalCarrierStream, yarp::os::impl::NameserTwoWayStream, yarp::os::impl::SocketTwoWayStream, yarp::os::ShiftStream, and yarp::os::NullStream.

◆ getOutputStream()

◆ getRemoteAddress()

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

Get the address of the remote side of the stream.

Returns
the address of the remote side of the stream. The address will be tagged as invalid if the stream is not set up.

Implemented in HumanStream, MjpegStream, MpiStream, ShmemHybridStream, UnixSockTwoWayStream, WebSocketStream, yarp::os::impl::DgramTwoWayStream, yarp::os::impl::FakeTwoWayStream, yarp::os::impl::HttpTwoWayStream, yarp::os::impl::LocalCarrierStream, yarp::os::impl::NameserTwoWayStream, yarp::os::impl::SocketTwoWayStream, yarp::os::ShiftStream, and yarp::os::NullStream.

◆ isOk()

◆ reset()


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