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. More...

virtual void	write (char ch)
	Write a single byte to the stream. More...

virtual void	write (const Bytes &b, int offset, int len)
	Write a block of bytes to the stream. More...

virtual void	write (const yarp::os::Bytes &b)=0
	Write a block of bytes to the stream. More...

virtual void	close ()=0
	Terminate the stream. More...

virtual void	flush ()
	Make sure all pending write operations are finished. More...

virtual void	writeLine (const char *data, int len)
	Write some text followed by a line feed. More...

virtual bool	isOk () const =0
	Check if the stream is ok or in an error state. More...

virtual bool	setWriteTimeout (double timeout)
	Set activity timeout. More...

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 24 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 MpiStream, yarp::os::NullStream, yarp::os::StringOutputStream, yarp::os::impl::SocketTwoWayStream, yarp::os::impl::MemoryOutputStream, yarp::os::impl::LocalCarrierStream, yarp::os::impl::HttpTwoWayStream, yarp::os::impl::DgramTwoWayStream, XmlRpcStream, UnixSockTwoWayStream, TcpRosStream, ShmemHybridStream, MpiP2PStream, MpiBcastStream, MjpegStream, and HumanStream.

◆ flush()

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

virtual

Make sure all pending write operations are finished.

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

Definition at line 28 of file OutputStream.cpp.

◆ getTypeOfService()

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

virtual

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

Definition at line 51 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 yarp::os::NullStream, yarp::os::StringOutputStream, yarp::os::impl::SocketTwoWayStream, yarp::os::impl::MemoryOutputStream, yarp::os::impl::LocalCarrierStream, yarp::os::impl::HttpTwoWayStream, yarp::os::impl::DgramTwoWayStream, XmlRpcStream, UnixSockTwoWayStream, TcpRosStream, ShmemHybridStream, MpiStream, MjpegStream, and HumanStream.

◆ setTypeOfService()

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

virtual

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

Definition at line 45 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 39 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

Definition at line 17 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

Definition at line 22 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 MpiStream, yarp::os::impl::MemoryOutputStream, yarp::os::impl::LocalCarrierStream, yarp::os::impl::DgramTwoWayStream, XmlRpcStream, UnixSockTwoWayStream, TcpRosStream, ShmemHybridStream, MpiP2PStream, MpiBcastStream, MjpegStream, H264Stream, yarp::os::NullStream, yarp::os::StringOutputStream, yarp::os::impl::SocketTwoWayStream, yarp::os::impl::HttpTwoWayStream, and HumanStream.

◆ 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 32 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

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ ~OutputStream()

Member Function Documentation

◆ close()

◆ flush()

◆ getTypeOfService()

◆ isOk()

◆ setTypeOfService()

◆ setWriteTimeout()

◆ write() [1/3]

◆ write() [2/3]

◆ write() [3/3]

◆ writeLine()