A helper for creating cached object descriptions. More...

#include <yarp/os/impl/BufferedConnectionWriter.h>

Inheritance diagram for yarp::os::impl::BufferedConnectionWriter:

Public Member Functions
	BufferedConnectionWriter (bool textMode=false, bool bareMode=false)
	Constructor.

	~BufferedConnectionWriter () override
	Destructor.

void	reset (bool textMode)
	Completely clear the writer and start afresh.

void	restart ()
	Tell the writer that we will be serializing a new object, but to keep any cached buffers that already exist.

void	clear () override
	Clear all cached data.

bool	addPool (const yarp::os::Bytes &data)
	Add the specified bytes to the current pool buffer.

void	stopPool ()
	Stop adding to the current pool buffer.

void	push (const Bytes &data, bool copy)
	Add the specified buffer to the list of buffers to be written.

bool	isTextMode () const override
	Check if the connection is text mode.

bool	isBareMode () const override
	Check if the connection is bare mode.

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

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

void	setReplyHandler (PortReader &reader) override
	This sets a handler to deal with replies to the message.

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

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

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

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

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

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

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

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

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

virtual void	appendBlock (const yarp::os::Bytes &data)
	Add a buffer by recording a reference to it, without copying it.

virtual void	appendBlockCopy (const Bytes &data)
	Add a buffer by copying its contents.

virtual void	appendLine (const std::string &data)
	Send a string along with a carriage-return-line-feed sequence.

size_t	length () const override

size_t	headerLength () const override

size_t	length (size_t index) const override

const char *	data (size_t index) const override

bool	write (ConnectionWriter &connection) const override
	Write this object to a network connection.

void	write (OutputStream &os) override

bool	write (PortReader &obj)
	Write message to a receiving object.

virtual size_t	dataSize () const

size_t	bufferCount () const

PortReader *	getReplyHandler () override

void	addToHeader ()
	Switch to storing a header.

yarp::os::Portable *	getReference () override

void	setReference (yarp::os::Portable *obj) override
	Stores a direct pointer to the object being sent.

bool	isValid () const override

bool	isActive () const override

bool	isError () const override

void	requestDrop () override
	Tag the connection to be dropped after the current message.

bool	dropRequested () override

void	startWrite () const override
	Call when writing is about to begin.

void	stopWrite () const override
	Call when all writing is finished.

SizedWriter *	getBuffer () override

const SizedWriter *	getBuffer () const override

void	setInitialPoolSize (size_t size)
	Set a custom initial pool size, which affects the size of buffers created for temporary data storage.

std::string	toString () const

Public Member Functions inherited from yarp::os::ConnectionWriter
virtual	~ConnectionWriter ()
	Destructor.

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

virtual bool	isNull () const

Public Member Functions inherited from yarp::os::SizedWriter
virtual	~SizedWriter ()

bool	write (ConnectionWriter &connection) const override
	Write this object to a network connection.

Public Member Functions inherited from yarp::os::PortWriter
virtual	~PortWriter ()
	Destructor.

virtual void	onCompletion () const
	This is called when the port has finished all writing operations.

virtual void	onCommencement () const
	This is called when the port is about to begin writing operations.

virtual yarp::os::Type	getWriteType () const

Additional Inherited Members
Static Public Member Functions inherited from yarp::os::ConnectionWriter
static ConnectionWriter *	createBufferedConnectionWriter ()
	Create a connection writer implementation that stores to a buffer which can be read later using getBuffer()

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

Detailed Description

A helper for creating cached object descriptions.

When a object is to be sent from one port to another, and we have multiple connections but don't want to serialize the object multiple times, a BufferedConnectionWriter is useful. It will create buffer space for any parts serialized on the fly, and keep track of any external blocks (e.g. arrays of pixel data) that we want to include verbatim in the message. This class plays no role in management of the lifecycle of external blocks (e.g. when they are created/destroyed, or when they may change in value). If you use external blocks, be sure to pay attention to onCompletion() events on your object.

Definition at line 45 of file BufferedConnectionWriter.h.

Constructor & Destructor Documentation

◆ BufferedConnectionWriter()

BufferedConnectionWriter::BufferedConnectionWriter	(	bool	textMode = `false`,
		bool	bareMode = `false`
	)

Constructor.

Parameters

textMode	suggest that the object be serialized in a human readable format. BufferedConnectionWriter simply passes this flag along to read/write methods, it takes on action on it.
bareMode	suggest that the object be serialized with the assumption that all type information is known by recipient. BufferedConnectionWriter simply passes this flag along to read/write methods, it takes on action on it.

Definition at line 30 of file BufferedConnectionWriter.cpp.

◆ ~BufferedConnectionWriter()

BufferedConnectionWriter::~BufferedConnectionWriter ( )

override

Destructor.

Definition at line 48 of file BufferedConnectionWriter.cpp.

Member Function Documentation

◆ addPool()

bool BufferedConnectionWriter::addPool ( const yarp::os::Bytes & data )

Add the specified bytes to the current pool buffer.

The pool buffer is a place to concatenate small blocks of data that are not being held externally. This requires a memory copy, so for large blocks of data consider adding these separately. A pool buffer will be created if none already exists.

Returns: true on success

Definition at line 94 of file BufferedConnectionWriter.cpp.

◆ addToHeader()

void BufferedConnectionWriter::addToHeader ( )

Switch to storing a header.

Buffers are tracked separately for the header.

Definition at line 408 of file BufferedConnectionWriter.cpp.

◆ appendBlock() [1/2]

void BufferedConnectionWriter::appendBlock	(	const char *	data,
		size_t	len
	)

overridevirtual

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

str	the string to send
terminate	the terminating character to use

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

void BufferedConnectionWriter::push	(	const Bytes &	data,
		bool	copy
	)

data	the buffer to add
copy	whether the data should be copied, or a reference stored

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ BufferedConnectionWriter()

◆ ~BufferedConnectionWriter()

Member Function Documentation

◆ addPool()

◆ addToHeader()

◆ appendBlock() [1/2]

◆ appendBlock() [2/2]

◆ appendBlockCopy()

◆ appendExternalBlock()

◆ appendFloat32()

◆ appendFloat64()

◆ appendInt16()

◆ appendInt32()

◆ appendInt64()

◆ appendInt8()

◆ appendLine()

◆ appendText()

◆ bufferCount()

◆ clear()

◆ convertTextMode()

◆ data()

◆ dataSize()

◆ declareSizes()

◆ dropRequested()

◆ getBuffer() [1/2]

◆ getBuffer() [2/2]

◆ getReference()

◆ getReplyHandler()

◆ headerLength()

◆ isActive()

◆ isBareMode()

◆ isError()

◆ isTextMode()

◆ isValid()

◆ length() [1/2]

◆ length() [2/2]

◆ push()

◆ requestDrop()

◆ reset()

◆ restart()

◆ setInitialPoolSize()

◆ setReference()

◆ setReplyHandler()

◆ startWrite()

◆ stopPool()

◆ stopWrite()

◆ toString()

◆ write() [1/3]

◆ write() [2/3]

◆ write() [3/3]