yarp::os::TwoWayStream Class Reference

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 InputStream &	getInputStream ()=0
	Get an InputStream to read from.
virtual OutputStream &	getOutputStream ()=0
	Get an OutputStream to write to.
virtual const Contact &	getLocalAddress () const =0
	Get the address of the local side of the stream.
virtual const Contact &	getRemoteAddress () 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

Mark the beginning of a logical packet.

This is a unit that should be treated in an atomic fashion by YARP. If any part is corrupted, the whole should be dropped.

Implemented in GstreamerStream, 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.

close()

virtual void yarp::os::TwoWayStream::close ( )

pure virtual

Terminate the stream.

Implemented in GstreamerStream, HumanStream, MjpegStream, MpiBcastStream, MpiP2PStream, 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, yarp::os::NullStream, and MpiStream.

endPacket()

virtual void yarp::os::TwoWayStream::endPacket ( )

pure virtual

Mark the end of a logical packet (see beginPacket).

Implemented in GstreamerStream, 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.

getInputStream()

virtual InputStream & yarp::os::TwoWayStream::getInputStream ( )

pure virtual

Get an InputStream to read from.

Returns

the InputStream associated with this object.

Implemented in GstreamerStream, 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.

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 GstreamerStream, 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()

virtual OutputStream & yarp::os::TwoWayStream::getOutputStream ( )

pure virtual

Get an OutputStream to write to.

Returns

the InputStream associated with this object.

Implemented in GstreamerStream, 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.

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 GstreamerStream, 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()

virtual bool yarp::os::TwoWayStream::isOk ( ) const

pure virtual

Check if the stream is ok or in an error state.

Returns

true iff the stream is ok

Implemented in GstreamerStream, 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.

reset()

virtual void yarp::os::TwoWayStream::reset ( )

pure virtual

Reset the stream.

Implemented in GstreamerStream, 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.

---

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

• src/libYARP_os/src/yarp/os/TwoWayStream.h
• src/libYARP_os/src/yarp/os/TwoWayStream.cpp