yarp::os::OutputStream Class Reference

Simple specification of the minimum functions needed from output streams. More...

#include <yarp/os/OutputStream.h>

Inheritance diagram for yarp::os::OutputStream:

Public Member Functions
virtual	~OutputStream ()
	Destructor.
virtual void	write (char ch)
	Write a single byte to the stream.
virtual void	write (const Bytes &b, int offset, int len)
	Write a block of bytes to the stream.
virtual void	write (const yarp::os::Bytes &b)=0
	Write a block of bytes to the stream.
virtual void	close ()=0
	Terminate the stream.
virtual void	flush ()
	Make sure all pending write operations are finished.
virtual void	writeLine (const char *data, int len)
	Write some text followed by a line feed.
virtual bool	isOk () const =0
	Check if the stream is ok or in an error state.
virtual bool	setWriteTimeout (double timeout)
	Set activity timeout.
virtual bool	setTypeOfService (int tos)
virtual int	getTypeOfService ()

Detailed Description

Simple specification of the minimum functions needed from output streams.

The streams could be TCP, UDP, MCAST, ...

Definition at line 20 of file OutputStream.h.

Constructor & Destructor Documentation

~OutputStream()

yarp::os::OutputStream::~OutputStream ( )

virtualdefault

Destructor.

Member Function Documentation

close()

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

pure virtual

Terminate the stream.

Implemented in GstreamerStream, HumanStream, MjpegStream, MpiBcastStream, MpiP2PStream, ShmemHybridStream, UnixSockTwoWayStream, WebSocketStream, yarp::os::impl::DgramTwoWayStream, yarp::os::impl::HttpTwoWayStream, yarp::os::impl::LocalCarrierStream, yarp::os::impl::MemoryOutputStream, yarp::os::impl::SocketTwoWayStream, yarp::os::StringOutputStream, yarp::os::NullStream, and MpiStream.

flush()

void yarp::os::OutputStream::flush ( )

virtual

Make sure all pending write operations are finished.

Reimplemented in yarp::os::impl::DgramTwoWayStream, and yarp::os::impl::SocketTwoWayStream.

Definition at line 25 of file OutputStream.cpp.

getTypeOfService()

int yarp::os::OutputStream::getTypeOfService ( )

virtual

Reimplemented in yarp::os::impl::DgramTwoWayStream, and yarp::os::impl::SocketTwoWayStream.

Definition at line 48 of file OutputStream.cpp.

isOk()

virtual bool yarp::os::OutputStream::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::HttpTwoWayStream, yarp::os::impl::LocalCarrierStream, yarp::os::impl::MemoryOutputStream, yarp::os::impl::SocketTwoWayStream, yarp::os::StringOutputStream, and yarp::os::NullStream.

setTypeOfService()

bool yarp::os::OutputStream::setTypeOfService ( int  tos )

virtual

Reimplemented in yarp::os::impl::DgramTwoWayStream, yarp::os::impl::LocalCarrierStream, and yarp::os::impl::SocketTwoWayStream.

Definition at line 42 of file OutputStream.cpp.

setWriteTimeout()

bool yarp::os::OutputStream::setWriteTimeout ( double  timeout )

virtual

Set activity timeout.

Support for this is optional. 0 = wait forever.

Returns

true iff timeout is supported.

Reimplemented in yarp::os::impl::SocketTwoWayStream.

Definition at line 36 of file OutputStream.cpp.

write() [1/3]

void yarp::os::OutputStream::write ( char  ch )

virtual

Write a single byte to the stream.

By default, this calls write(const Bytes& b) to do its work.

Parameters

ch	the byte to write

Reimplemented in yarp::os::StringOutputStream.

Definition at line 14 of file OutputStream.cpp.

write() [2/3]

void yarp::os::OutputStream::write ( const Bytes &  b, int  offset, int  len  )

virtual

Write a block of bytes to the stream.

By default, this calls write(const Bytes& b) to do its work.

Parameters

b	the bytes to write
offset	an offset within the block to start at
len	the number of bytes to write

Reimplemented in yarp::os::StringOutputStream.

Definition at line 19 of file OutputStream.cpp.

write() [3/3]

virtual void yarp::os::OutputStream::write ( const yarp::os::Bytes &  b )

pure virtual

Write a block of bytes to the stream.

Parameters

b	the bytes to write

Implemented in HumanStream, yarp::os::impl::HttpTwoWayStream, yarp::os::impl::SocketTwoWayStream, yarp::os::StringOutputStream, yarp::os::NullStream, GstreamerStream, MjpegStream, MpiBcastStream, MpiP2PStream, ShmemHybridStream, UnixSockTwoWayStream, yarp::os::impl::DgramTwoWayStream, yarp::os::impl::LocalCarrierStream, yarp::os::impl::MemoryOutputStream, MpiBcastStream, MpiP2PStream, MpiStream, yarp::os::StringOutputStream, and WebSocketStream.

writeLine()

void yarp::os::OutputStream::writeLine ( const char *  data, int  len  )

virtual

Write some text followed by a line feed.

By default, this calls write(const Bytes& b) to do its work.

Parameters

data	the text to write

Definition at line 29 of file OutputStream.cpp.

---

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

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