A DataWriter which writes data to a CircularByteBuffer. More...

#include <CircularByteBufferDataWriter.h++>

Inheritance diagram for CircularByteBufferDataWriter:

Collaboration diagram for CircularByteBufferDataWriter:

Public Member Functions
	CircularByteBufferDataWriter (CircularByteBuffer &buffer)
	Construct a new CircularByteBufferDataWriter for the given CircularByteBuffer. More...

	~CircularByteBufferDataWriter ()
	Destructor. More...

void	skip (uint_t count)

void	skip (uint_t count, byte_t fillByte)

void	flush ()
	Flush any buffered but not yet written data to the output destination. More...

void	reset ()
	Reset the encoder. More...

void	setOffset (int64_t offset)
	Set the current reading/writing offset. More...

virtual void	skip (size_t count)=0
	Skip past the given number of bytes in the data stream. More...

virtual void	skip (size_t count, byte_t fillByte)=0
	Skip past the given number of bytes, filling the bytes with the given value. More...

DataWriter &	operator<< (bool v)
	Write operator. More...

DataWriter &	operator<< (byte_t v)
	Write operator. More...

DataWriter &	operator<< (const byte_t *v)
	Write operator. More...

DataWriter &	operator<< (char v)
	Write operator. More...

DataWriter &	operator<< (const char *v)
	Write operator. More...

DataWriter &	operator<< (int16_t v)
	Write operator. More...

DataWriter &	operator<< (const int16_t *v)
	Write operator. More...

DataWriter &	operator<< (uint16_t v)
	Write operator. More...

DataWriter &	operator<< (const uint16_t *v)
	Write operator. More...

DataWriter &	operator<< (int32_t v)
	Write operator. More...

DataWriter &	operator<< (const int32_t *v)
	Write operator. More...

DataWriter &	operator<< (uint32_t v)
	Write operator. More...

DataWriter &	operator<< (const uint32_t *v)
	Write operator. More...

DataWriter &	operator<< (const int64_t &v)
	Write operator. More...

DataWriter &	operator<< (const int64_t *v)
	Write operator. More...

DataWriter &	operator<< (const uint64_t &v)
	Write operator. More...

DataWriter &	operator<< (const uint64_t *v)
	Write operator. More...

DataWriter &	operator<< (float v)
	Write operator. More...

DataWriter &	operator<< (const float *v)
	Write operator. More...

DataWriter &	operator<< (const double &v)
	Write operator. More...

DataWriter &	operator<< (const double *v)
	Write operator. More...

DataWriter &	operator<< (const Blob &v)
	Write operator. More...

DataWriter &	operator<< (const String &v)
	Write operator. More...

DataWriter &	operator<< (const Manipulator &manip)
	Write operator. More...

void	pushContext ()
	Push a new encoder context. More...

void	popContext ()
	Pop the active encoder context. More...

bool	isTopContext () const
	Determine if the active context is the topmost (and only) context. More...

uint_t	getContextDepth () const
	Get the current context depth. More...

void	setEndianness (Endianness endianness)
	Specify the byte-endianness for reading/writing primitive integer types in the active context. More...

Endianness	getEndianness () const
	Get the byte-endianness in the active context. More...

void	setLength (size_t length)
	Specify the length of String, Blob, and array values for subsequent reading/writing in the active context. More...

size_t	getLength () const
	Get the current length for string values. More...

void	setLimit (int64_t limit)
	Specify the maximum number of bytes that can be read/written in the active context. More...

int64_t	getLimit () const
	Get the current limit. More...

int64_t	getOffset () const
	Get the current encoding/decoding offset. More...

int64_t	getCumulativeOffset () const
	Get the cumulative reading/writing offset. More...

int64_t	getRemaining () const
	Get the number of bytes between the current offset and the limit, i.e., the number of bytes remaining to be read or written. More...

void	align (size_t size)
	Skip past enough bytes to re-align the data stream at a specified boundary. More...

Protected Member Functions
size_t	write (const byte_t *buf, size_t count)
	Write raw data to the output destination. More...

bool	isSameEndianness () const
	Test if the endianness of the encoder is the same as the endianness of the host system. More...

Context &	currentContext ()
	Get a reference to the current context. More...

const Context &	currentContext () const
	Get a reference to the current context. More...

void	checkRemaining (const Context &ctx, size_t count) const
	Check if at least the given number of bytes are available to be read or written. More...

Detailed Description

A DataWriter which writes data to a CircularByteBuffer.

Author: Mark Lindner

Constructor & Destructor Documentation

◆ CircularByteBufferDataWriter()

CircularByteBufferDataWriter ( CircularByteBuffer & buffer )

Construct a new CircularByteBufferDataWriter for the given CircularByteBuffer.

Parameters

buffer The buffer.

◆ ~CircularByteBufferDataWriter()

~CircularByteBufferDataWriter ( )

Destructor.

Member Function Documentation

◆ align()

void align ( size_t size )

inherited

Skip past enough bytes to re-align the data stream at a specified boundary.

When reading, the bytes are simply skipped over; when writing, the bytes are filled with NULs.

Parameters

size	The alignment size. Typical values include 2, 4, or 8. Other values are allowed but are of limited usefulness.

Exceptions

IOException If an I/O error occurs.

◆ checkRemaining()

void checkRemaining	(	const Context &	ctx,
		size_t	count
	)		const

protectedinherited

Check if at least the given number of bytes are available to be read or written.

Parameters

ctx	The context to check.
count	The number of bytes.

Exceptions

IOException If there are not enough bytes remaining.

◆ currentContext() [1/2]

DataEncoder::Context & currentContext ( )

protectedinherited

Get a reference to the current context.

◆ currentContext() [2/2]

const DataEncoder::Context & currentContext ( ) const

protectedinherited

Get a reference to the current context.

◆ flush()

void flush ( )

virtual

Flush any buffered but not yet written data to the output destination.

Exceptions

IOException If an I/O error occurs.

Implements DataWriter.

◆ getContextDepth()

uint_t getContextDepth ( ) const

inherited

Get the current context depth.

◆ getCumulativeOffset()

int64_t getCumulativeOffset ( ) const

inherited

Get the cumulative reading/writing offset.

This is a sum of the offsets across all contexts.

◆ getEndianness()

Endianness getEndianness ( ) const

inherited

Get the byte-endianness in the active context.

◆ getLength()

size_t getLength ( ) const

inherited

Get the current length for string values.

◆ getLimit()

int64_t getLimit ( ) const

inherited

Get the current limit.

◆ getOffset()

int64_t getOffset ( ) const

inherited

Get the current encoding/decoding offset.

◆ getRemaining()

int64_t getRemaining ( ) const

inherited

Get the number of bytes between the current offset and the limit, i.e., the number of bytes remaining to be read or written.

◆ isSameEndianness()

bool isSameEndianness ( ) const

protectedinherited

Test if the endianness of the encoder is the same as the endianness of the host system.

◆ isTopContext()

bool isTopContext ( ) const

inherited

Determine if the active context is the topmost (and only) context.

◆ operator<<() [1/24]

DataWriter & operator<< ( bool v )

inherited

Write operator.

Exceptions

IOException If an I/O error occurs.

◆ operator<<() [2/24]

DataWriter & operator<< ( byte_t v )

inherited

Write operator.

Exceptions

IOException If an I/O error occurs.

◆ operator<<() [3/24]

DataWriter & operator<< ( const byte_t * v )

inherited

Write operator.

Exceptions

IOException If an I/O error occurs.

◆ operator<<() [4/24]

DataWriter & operator<< ( char v )

inherited

Write operator.

Exceptions

IOException If an I/O error occurs.

◆ operator<<() [5/24]

DataWriter & operator<< ( const char * v )

inherited

Write operator.

Exceptions

IOException If an I/O error occurs.

◆ operator<<() [6/24]

DataWriter & operator<< ( int16_t v )

inherited

Write operator.

Exceptions

IOException If an I/O error occurs.

◆ operator<<() [7/24]

DataWriter & operator<< ( const int16_t * v )

inherited

Write operator.

Exceptions

IOException If an I/O error occurs.

◆ operator<<() [8/24]

DataWriter & operator<< ( uint16_t v )

inherited

Write operator.

Exceptions

IOException If an I/O error occurs.

◆ operator<<() [9/24]

DataWriter & operator<< ( const uint16_t * v )

inherited

Write operator.

Exceptions

IOException If an I/O error occurs.

◆ operator<<() [10/24]

DataWriter & operator<< ( int32_t v )

inherited

Write operator.

Exceptions

IOException If an I/O error occurs.

◆ operator<<() [11/24]

DataWriter & operator<< ( const int32_t * v )

inherited

Write operator.

Exceptions

IOException If an I/O error occurs.

◆ operator<<() [12/24]

DataWriter & operator<< ( uint32_t v )

inherited

Write operator.

Exceptions

IOException If an I/O error occurs.

◆ operator<<() [13/24]

DataWriter & operator<< ( const uint32_t * v )

inherited

Write operator.

Exceptions

IOException If an I/O error occurs.

◆ operator<<() [14/24]

DataWriter & operator<< ( const int64_t & v )

inherited

Write operator.

Exceptions

IOException If an I/O error occurs.

◆ operator<<() [15/24]

DataWriter & operator<< ( const int64_t * v )

inherited

Write operator.

Exceptions

IOException If an I/O error occurs.

◆ operator<<() [16/24]

DataWriter & operator<< ( const uint64_t & v )

inherited

Write operator.

Exceptions

IOException If an I/O error occurs.

◆ operator<<() [17/24]

DataWriter & operator<< ( const uint64_t * v )

inherited

Write operator.

Exceptions

IOException If an I/O error occurs.

◆ operator<<() [18/24]

DataWriter & operator<< ( float v )

inherited

Write operator.

Exceptions

IOException If an I/O error occurs.

◆ operator<<() [19/24]

DataWriter & operator<< ( const float * v )

inherited

Write operator.

Exceptions

IOException If an I/O error occurs.

◆ operator<<() [20/24]

DataWriter & operator<< ( const double & v )

inherited

Write operator.

Exceptions

IOException If an I/O error occurs.

◆ operator<<() [21/24]

DataWriter & operator<< ( const double * v )

inherited

Write operator.

Exceptions

IOException If an I/O error occurs.

◆ operator<<() [22/24]

DataWriter & operator<< ( const Blob & v )

inherited

Write operator.

Exceptions

IOException If an I/O error occurs.

◆ operator<<() [23/24]

DataWriter & operator<< ( const String & v )

inherited

Write operator.

Exceptions

IOException If an I/O error occurs.

◆ operator<<() [24/24]

DataWriter & operator<< ( const Manipulator & manip )

inherited

Write operator.

Exceptions

IOException If an I/O error occurs.

◆ popContext()

void popContext ( )

inherited

Pop the active encoder context.

The previous context becomes the active context, and the offset in the current context is incremented by the offset of the popped context.

◆ pushContext()

void pushContext ( )

inherited

Push a new encoder context.

◆ reset()

void reset ( )

virtual

Reset the encoder.

Discards all but the topmost context, and resets the topmost context to default values.

Exceptions

IOException If an I/O error occurs.

Reimplemented from DataEncoder.

◆ setEndianness()

void setEndianness ( Endianness endianness )

inherited

Specify the byte-endianness for reading/writing primitive integer types in the active context.

◆ setLength()

void setLength ( size_t length )

inherited

Specify the length of String, Blob, and array values for subsequent reading/writing in the active context.

◆ setLimit()

void setLimit ( int64_t limit )

inherited

Specify the maximum number of bytes that can be read/written in the active context.

Attempts to read/write past this limit will raise an IOException.

Exceptions

IOException If an I/O error occurs.

◆ setOffset()

void setOffset ( int64_t offset )

virtual

Set the current reading/writing offset.

Exceptions

IOException If an I/O error occurs.

Implements DataEncoder.

◆ skip() [1/4]

virtual void skip ( size_t count )

pure virtualinherited

Skip past the given number of bytes in the data stream.

When reading, the bytes are simply skipped over; when writing, the bytes are filled with NULs.

Parameters

count The number of bytes to skip.

Exceptions

IOException If an I/O error occurs.

Implements DataEncoder.

Implemented in StreamDataWriter, ByteArrayDataWriter, and ByteBufferDataWriter.

◆ skip() [2/4]

void skip ( uint_t count )

◆ skip() [3/4]

void skip	(	uint_t	count,
		byte_t	fillByte
	)

◆ skip() [4/4]

virtual void skip	(	size_t	count,
		byte_t	fillByte
	)

pure virtualinherited

Skip past the given number of bytes, filling the bytes with the given value.

Parameters

count	The number of bytes to skip.
fillByte	The value to write to all the skipped bytes.

Exceptions

IOException If an I/O error occurs.

Implemented in StreamDataWriter, ByteArrayDataWriter, and ByteBufferDataWriter.

◆ write()

size_t write	(	const byte_t *	buf,
		size_t	count
	)

protectedvirtual

Write raw data to the output destination.

Exceptions

IOException If an I/O error occurs.

Implements DataWriter.

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

Public Member Functions

Protected Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ CircularByteBufferDataWriter()

◆ ~CircularByteBufferDataWriter()

Member Function Documentation

◆ align()

◆ checkRemaining()

◆ currentContext() [1/2]

◆ currentContext() [2/2]

◆ flush()

◆ getContextDepth()

◆ getCumulativeOffset()

◆ getEndianness()

◆ getLength()

◆ getLimit()

◆ getOffset()

◆ getRemaining()

◆ isSameEndianness()

◆ isTopContext()

◆ operator<<() [1/24]

◆ operator<<() [2/24]

◆ operator<<() [3/24]

◆ operator<<() [4/24]

◆ operator<<() [5/24]

◆ operator<<() [6/24]

◆ operator<<() [7/24]

◆ operator<<() [8/24]

◆ operator<<() [9/24]

◆ operator<<() [10/24]

◆ operator<<() [11/24]

◆ operator<<() [12/24]

◆ operator<<() [13/24]

◆ operator<<() [14/24]

◆ operator<<() [15/24]

◆ operator<<() [16/24]

◆ operator<<() [17/24]

◆ operator<<() [18/24]

◆ operator<<() [19/24]

◆ operator<<() [20/24]

◆ operator<<() [21/24]

◆ operator<<() [22/24]

◆ operator<<() [23/24]

◆ operator<<() [24/24]

◆ popContext()

◆ pushContext()

◆ reset()

◆ setEndianness()

◆ setLength()

◆ setLimit()

◆ setOffset()

◆ skip() [1/4]

◆ skip() [2/4]

◆ skip() [3/4]

◆ skip() [4/4]

◆ write()