An interface for writing to a network connection. More...

#include <yarp/os/ConnectionWriter.h>

Inheritance diagram for yarp::os::ConnectionWriter:

Public Member Functions
virtual	~ConnectionWriter ()
	Destructor. More...

virtual void	appendBlock (const char *data, size_t len)=0
	Send a block of data to the network connection. More...

virtual void	appendInt (int data) final
	Send a representation of an integer to the network connection. More...

virtual void	appendInt8 (std::int8_t data)=0
	Send a representation of a 8-bit integer to the network connection. More...

virtual void	appendInt16 (std::int16_t data)=0
	Send a representation of a 16-bit integer to the network connection. More...

virtual void	appendInt32 (std::int32_t data)=0
	Send a representation of a 32-bit integer to the network connection. More...

virtual void	appendInt64 (std::int64_t data)=0
	Send a representation of a 64-bit integer to the network connection. More...

virtual void	appendDouble (double data)
	Send a representation of a floating point number to the network connection. More...

virtual void	appendFloat32 (yarp::conf::float32_t data)=0
	Send a representation of a 32-bit floating point number to the network connection. More...

virtual void	appendFloat64 (yarp::conf::float64_t data)=0
	Send a representation of a 64-bit floating point number to the network connection. More...

virtual void	appendString (const char *str, const char terminate='\n') final
	Send a character sequence to the network connection. More...

virtual void	appendText (const std::string &str, const char terminate='\n')=0
	Send a terminated string to the network connection. More...

virtual void	appendRawString (const std::string &str) final

void	appendString (const std::string &str)
	Send a string to the network connection. More...

virtual void	appendExternalBlock (const char *data, size_t len)=0
	Send a block of data to the network connection, without making a copy. More...

virtual bool	isTextMode () const =0
	Check if the connection is text mode. More...

virtual bool	isBareMode () const =0
	Check if the connection is bare mode. More...

virtual void	declareSizes (int argc, int *argv)=0
	If you can easily determine how many blocks there are in a message, call this first, before anything else. More...

virtual void	setReplyHandler (PortReader &reader)=0
	This sets a handler to deal with replies to the message. More...

virtual void	setReference (Portable *obj)=0
	Stores a direct pointer to the object being sent. More...

virtual bool	convertTextMode ()=0
	Converts a standard description in binary into a textual description, if the connection is in text-mode. More...

virtual bool	isValid () const =0

virtual bool	isActive () const =0

virtual bool	isError () const =0

virtual void	requestDrop ()=0
	Tag the connection to be dropped after the current message. More...

virtual bool	isNull () const

virtual SizedWriter *	getBuffer () const =0

Static Public Member Functions
static ConnectionWriter *	createBufferedConnectionWriter ()
	Create a connection writer implementation that stores to a buffer which can be read later using getBuffer() More...

static bool	writeToStream (PortWriter &portable, OutputStream &os)

Detailed Description

An interface for writing to a network connection.

See also: Port, PortWriter, ConnectionReader

Examples: port_power/ex0402_port_callback_reply.cpp, port_power/ex0403_bufferedport_callback_reply.cpp, port_power/TargetVer2.h, and port_power/TargetVer3.h.

Definition at line 39 of file ConnectionWriter.h.

Constructor & Destructor Documentation

◆ ~ConnectionWriter()

ConnectionWriter::~ConnectionWriter ( )

virtualdefault

Destructor.

Member Function Documentation

◆ appendBlock()

virtual void yarp::os::ConnectionWriter::appendBlock	(	const char *	data,
		size_t	len
	)

pure virtual

Send a block of data to the network connection.

Since communication may not happen immediately, or may happen multiple times, a copy of this data is made. If you know the block of data will remain valid, and it is a large block of data, please call ConnectionWriter::appendExternalBlock instead.

Parameters

data	the start of the data block
len	the length of the data block

Implemented in yarp::os::NullConnectionWriter, yarp::os::impl::ConnectionRecorder, and yarp::os::impl::BufferedConnectionWriter.

◆ appendDouble()

virtual void yarp::os::ConnectionWriter::appendDouble ( double data )

inlinevirtual

Send a representation of a floating point number to the network connection.

Parameters

data	the floating point number to send

Warning: Unsafe, sizeof(double) is platform dependent. Use appendFloat64 instead.

Definition at line 102 of file ConnectionWriter.h.

◆ appendExternalBlock()

virtual void yarp::os::ConnectionWriter::appendExternalBlock	(	const char *	data,
		size_t	len
	)

pure virtual

Send a block of data to the network connection, without making a copy.

If you are not confident that the block of data will remain valid throughout transmission, call ConnectionWriter::appendBlock instead.

Parameters

data	the start of the data block
len	the length of the data block

Implemented in yarp::os::NullConnectionWriter, yarp::os::impl::ConnectionRecorder, and yarp::os::impl::BufferedConnectionWriter.

◆ appendFloat32()

virtual void yarp::os::ConnectionWriter::appendFloat32 ( yarp::conf::float32_t data )

pure virtual

Send a representation of a 32-bit floating point number to the network connection.

Parameters

data	the floating point number to send

Implemented in yarp::os::NullConnectionWriter, yarp::os::impl::ConnectionRecorder, and yarp::os::impl::BufferedConnectionWriter.

◆ appendFloat64()

virtual void yarp::os::ConnectionWriter::appendFloat64 ( yarp::conf::float64_t data )

pure virtual

Send a representation of a 64-bit floating point number to the network connection.

Parameters

data	the floating point number to send

Implemented in yarp::os::NullConnectionWriter, yarp::os::impl::ConnectionRecorder, and yarp::os::impl::BufferedConnectionWriter.

◆ appendInt()

virtual void yarp::os::ConnectionWriter::appendInt ( int data )

inlinefinalvirtual

Send a representation of an integer to the network connection.

Parameters

data	the integer to send

Warning: Unsafe, sizeof(int) is platform dependent. Use appendInt32 instead.

Definition at line 65 of file ConnectionWriter.h.

◆ appendInt16()

virtual void yarp::os::ConnectionWriter::appendInt16 ( std::int16_t data )

pure virtual

Send a representation of a 16-bit integer to the network connection.

Parameters

data	the integer to send

Implemented in yarp::os::NullConnectionWriter, yarp::os::impl::ConnectionRecorder, and yarp::os::impl::BufferedConnectionWriter.

◆ appendInt32()

virtual void yarp::os::ConnectionWriter::appendInt32 ( std::int32_t data )

pure virtual

Send a representation of a 32-bit integer to the network connection.

Parameters

data	the integer to send

Implemented in yarp::os::NullConnectionWriter, yarp::os::impl::ConnectionRecorder, and yarp::os::impl::BufferedConnectionWriter.

Examples: port_power/TargetVer2.h, and port_power/TargetVer3.h.

◆ appendInt64()

virtual void yarp::os::ConnectionWriter::appendInt64 ( std::int64_t data )

pure virtual

Send a representation of a 64-bit integer to the network connection.

Parameters

data	the integer to send

Implemented in yarp::os::NullConnectionWriter, yarp::os::impl::ConnectionRecorder, and yarp::os::impl::BufferedConnectionWriter.

◆ appendInt8()

virtual void yarp::os::ConnectionWriter::appendInt8 ( std::int8_t data )

pure virtual

Send a representation of a 8-bit integer to the network connection.

Parameters

data	the integer to send

Implemented in yarp::os::NullConnectionWriter, yarp::os::impl::ConnectionRecorder, and yarp::os::impl::BufferedConnectionWriter.

◆ appendRawString()

virtual void yarp::os::ConnectionWriter::appendRawString ( const std::string & str )

inlinefinalvirtual

Definition at line 150 of file ConnectionWriter.h.

◆ appendString() [1/2]

virtual void yarp::os::ConnectionWriter::appendString	(	const char *	str,
		const char	terminate = `'\n'`
	)

inlinefinalvirtual

Send a character sequence to the network connection.

Parameters

str	the character sequence to send
terminate	the terminating character to use

Deprecated:: since YARP 3.2

Definition at line 131 of file ConnectionWriter.h.

◆ appendString() [2/2]

void yarp::os::ConnectionWriter::appendString ( const std::string & str )

inline

Send a string to the network connection.

The lenght of string is not specified in advance, therefore the reader should read the number of bytes specified by the first integer. The string terminating character (normally '\0') is not transmitted.

Parameters

str	the string to send

Definition at line 165 of file ConnectionWriter.h.

◆ appendText()

virtual void yarp::os::ConnectionWriter::appendText	(	const std::string &	str,
		const char	terminate = `'\n'`
	)

pure virtual

Send a terminated string to the network connection.

The lenght of string is not specified in advance, therefore the reader should read until the terminating character is found.

Parameters

str	the string to send
terminate	the terminating character to use

Implemented in yarp::os::NullConnectionWriter, yarp::os::impl::BufferedConnectionWriter, and yarp::os::impl::ConnectionRecorder.

◆ convertTextMode()

virtual bool yarp::os::ConnectionWriter::convertTextMode ( )

pure virtual

Converts a standard description in binary into a textual description, if the connection is in text-mode.

Useful if you only operate on the binary description usually, and just want to permit text mode for command-line interaction. If isTextMode would return false, no conversion is done.

Returns: true if the conversion was possible

Implemented in yarp::os::NullConnectionWriter, yarp::os::impl::ConnectionRecorder, and yarp::os::impl::BufferedConnectionWriter.

Examples: port_power/TargetVer3.h.

◆ createBufferedConnectionWriter()

ConnectionWriter * ConnectionWriter::createBufferedConnectionWriter ( )

static

Create a connection writer implementation that stores to a buffer which can be read later using getBuffer()

Definition at line 25 of file ConnectionWriter.cpp.

◆ declareSizes()

virtual void yarp::os::ConnectionWriter::declareSizes	(	int	argc,
		int *	argv
	)

pure virtual

If you can easily determine how many blocks there are in a message, call this first, before anything else.

This may improve efficiency in some situations.

Parameters

argc	Number of blocks
argv	An array of integers, giving the length of each block

Implemented in yarp::os::NullConnectionWriter, yarp::os::impl::ConnectionRecorder, and yarp::os::impl::BufferedConnectionWriter.

◆ getBuffer()

virtual SizedWriter* yarp::os::ConnectionWriter::getBuffer ( ) const

pure virtual

Returns: a buffer if one is present.

Implemented in yarp::os::NullConnectionWriter, yarp::os::impl::ConnectionRecorder, and yarp::os::impl::BufferedConnectionWriter.

◆ isActive()

virtual bool yarp::os::ConnectionWriter::isActive ( ) const

pure virtual

Returns: true if the writer is active. Writers may become inactive if the connection they are associated with breaks.

Implemented in yarp::os::NullConnectionWriter, yarp::os::impl::ConnectionRecorder, and yarp::os::impl::BufferedConnectionWriter.

◆ isBareMode()

virtual bool yarp::os::ConnectionWriter::isBareMode ( ) const

pure virtual

Check if the connection is bare mode.

If it is, you are encouraged to omit type information from your serialization.

Returns: true if the connection is bare

Implemented in yarp::os::NullConnectionWriter, yarp::os::impl::ConnectionRecorder, and yarp::os::impl::BufferedConnectionWriter.

◆ isError()

virtual bool yarp::os::ConnectionWriter::isError ( ) const

pure virtual

Returns: true if the writer encountered an error. Writers can encounter an error if there is some data loss. For unreliable protocols like UDP/Multicast, where losses are not unexpected, this error flag will be reset for the next incoming message.

Implemented in yarp::os::NullConnectionWriter, yarp::os::impl::ConnectionRecorder, and yarp::os::impl::BufferedConnectionWriter.

◆ isNull()

bool ConnectionWriter::isNull ( ) const

virtual

Returns: true if writer goes nowhere.

Reimplemented in yarp::os::NullConnectionWriter.

Definition at line 19 of file ConnectionWriter.cpp.

◆ isTextMode()

virtual bool yarp::os::ConnectionWriter::isTextMode ( ) const

pure virtual

Check if the connection is text mode.

If it is, you are encouraged (but by no means required) to use a human-readable representation of your data structure.

Returns: true if the connection is text mode (as opposed to binary)

Implemented in yarp::os::NullConnectionWriter, yarp::os::impl::ConnectionRecorder, and yarp::os::impl::BufferedConnectionWriter.

◆ isValid()

virtual bool yarp::os::ConnectionWriter::isValid ( ) const

pure virtual

Returns: true if the writer is valid. A writer may be invalid if a connection has closed.

Implemented in yarp::os::NullConnectionWriter, yarp::os::impl::ConnectionRecorder, and yarp::os::impl::BufferedConnectionWriter.

◆ requestDrop()

virtual void yarp::os::ConnectionWriter::requestDrop ( )

pure virtual

Tag the connection to be dropped after the current message.

Implemented in yarp::os::NullConnectionWriter, yarp::os::impl::ConnectionRecorder, and yarp::os::impl::BufferedConnectionWriter.

◆ setReference()

virtual void yarp::os::ConnectionWriter::setReference ( Portable * obj )

pure virtual

Stores a direct pointer to the object being sent.

This is useful for local communication, to bypass serialization.

Implemented in yarp::os::impl::ConnectionRecorder, yarp::os::impl::BufferedConnectionWriter, and yarp::os::NullConnectionWriter.

◆ setReplyHandler()

virtual void yarp::os::ConnectionWriter::setReplyHandler ( PortReader & reader )

pure virtual

This sets a handler to deal with replies to the message.

The handler will be called once per connection. There will be problems for connections using carriers that don't support replies.

Parameters

reader the object that handles replies.

Implemented in yarp::os::impl::ConnectionRecorder, yarp::os::NullConnectionWriter, and yarp::os::impl::BufferedConnectionWriter.

◆ writeToStream()

bool ConnectionWriter::writeToStream	(	PortWriter &	portable,
		OutputStream &	os
	)

static

Definition at line 30 of file ConnectionWriter.cpp.

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

src/libYARP_os/src/yarp/os/ConnectionWriter.h
src/libYARP_os/src/yarp/os/ConnectionWriter.cpp

Public Member Functions

Static Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ ~ConnectionWriter()

Member Function Documentation

◆ appendBlock()

◆ appendDouble()

◆ appendExternalBlock()

◆ appendFloat32()

◆ appendFloat64()

◆ appendInt()

◆ appendInt16()

◆ appendInt32()

◆ appendInt64()

◆ appendInt8()

◆ appendRawString()

◆ appendString() [1/2]

◆ appendString() [2/2]

◆ appendText()

◆ convertTextMode()

◆ createBufferedConnectionWriter()

◆ declareSizes()

◆ getBuffer()

◆ isActive()

◆ isBareMode()

◆ isError()

◆ isNull()

◆ isTextMode()

◆ isValid()

◆ requestDrop()

◆ setReference()

◆ setReplyHandler()

◆ writeToStream()