#include <Fw/Buffer/Buffer.hpp>

Inheritance diagram for Fw::Buffer:

Public Types
enum	OwnershipState { OwnershipState::NOT_OWNED, OwnershipState::OWNED }

enum	{ SERIALIZED_SIZE = 3 * sizeof(SizeType) + sizeof(U32) + sizeof(U8*), NO_CONTEXT = 0xFFFFFFFF }

using	SizeType = FwSizeType
	The size type for a buffer - for backwards compatibility. More...

Public Types inherited from Fw::Serializable
using	SizeType = FwSizeType

Public Member Functions
	Buffer ()

	Buffer (const Buffer &src)

	Buffer (U8 *data, FwSizeType size, U32 context=NO_CONTEXT)

Buffer &	operator= (const Buffer &src)

bool	operator== (const Buffer &src) const

	DEPRECATED (LinearBufferBase &getSerializeRepr(), "Switch to .getSerializer() and .getDeserializer()")

ExternalSerializeBufferWithMemberCopy	getSerializer ()

ExternalSerializeBufferWithMemberCopy	getDeserializer ()

Fw::SerializeStatus	serializeTo (Fw::SerialBufferBase &serialBuffer, Fw::Endianness mode=Fw::Endianness::BIG) const

Fw::SerializeStatus	deserializeFrom (Fw::SerialBufferBase &buffer, Fw::Endianness mode=Fw::Endianness::BIG)

bool	isValid () const

U8 *	getData () const

U8 *	getOriginalData () const

FwSizeType	getSize () const

FwSizeType	getCapacity () const

FwSizeType	getOffset () const

U32	getContext () const

void	advance (FwSignedSizeType amount)

void	setData (U8 *data)

void	setSize (FwSizeType size)

void	setContext (U32 context)

void	set (U8 *data, FwSizeType size, U32 context=NO_CONTEXT)

Public Member Functions inherited from Fw::Serializable
	DEPRECATED (SerializeStatus serialize(SerialBufferBase &buffer) const, "Use serializeTo(SerialBufferBase& buffer) instead")

	DEPRECATED (SerializeStatus deserialize(SerialBufferBase &buffer), "Use deserializeFrom(SerialBufferBase& buffer) instead")

Friends
class	Fw::BufferTester

Additional Inherited Members
Protected Member Functions inherited from Fw::Serializable
	Serializable ()
	Default constructor. More...

virtual	~Serializable ()
	Virtual destructor. More...

Detailed Description

Buffer used for wrapping pointer to data for efficient transmission

Fw::Buffer is a wrapper for a pointer to data. It allows for data to be passed around the system without a copy of the data itself. However, it comes with the expectation that the user maintain and protect this memory as it moves about the system until such a time as it is returned.

Fw::Buffer is composed of several elements: a U8* pointer to the original allocation, an offset into that allocation, a size of the represented data, a capacity recording the original allocation size, and a U32 context describing the origin of that data, such that it may be freed at some later point. The default context of 0xFFFFFFFF should not be used for tracking purposes, as it represents a context-free buffer.

The original allocation pointer is always recoverable via getOriginalData(). Consuming leading bytes (e.g. a header) is done with advance(), which adjusts the offset and size without losing the original pointer. setData() and setSize() are bounds-checked against the original allocation: to wrap unrelated memory, construct a new Fw::Buffer or call set().

Fw::Buffer also comes with functions to return a representation of the data as a LinearBufferBase. These two functions allow easy access to the data as if it were a serialize or deserialize buffer. This can aid in writing and reading the wrapped data whereas the standard serialize and deserialize methods treat the data as a pointer to prevent excessive copying.

Definition at line 53 of file Buffer.hpp.

Member Typedef Documentation

◆ SizeType

using Fw::Buffer::SizeType = FwSizeType

The size type for a buffer - for backwards compatibility.

Definition at line 67 of file Buffer.hpp.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

Enumerator
SERIALIZED_SIZE	Size of Fw::Buffer when serialized.
NO_CONTEXT	Value representing no context.

Definition at line 69 of file Buffer.hpp.

◆ OwnershipState

enum Fw::Buffer::OwnershipState

strong

Buffer ownership state

A convenience enumeration to help users implement ownership tracking of buffers.

Enumerator
NOT_OWNED	The buffer is currently not owned.
OWNED	The buffer is currently owned.

Definition at line 60 of file Buffer.hpp.

Constructor & Destructor Documentation

◆ Buffer() [1/3]

Fw::Buffer::Buffer ( )

Construct a buffer with no context nor data

Constructs a buffer setting the context to the default no-context value of 0xffffffff. In addition, the size and data pointers are zeroed-out.

Definition at line 23 of file Buffer.cpp.

◆ Buffer() [2/3]

Fw::Buffer::Buffer ( const Buffer & src )

Construct a buffer by copying members from a reference to another buffer. Does not copy wrapped data.

Definition at line 32 of file Buffer.cpp.

◆ Buffer() [3/3]

Fw::Buffer::Buffer	(	U8 *	data,
		FwSizeType	size,
		U32	context = `NO_CONTEXT`
	)

Construct a buffer to wrap the given data pointer of given size

Wraps the given data pointer with given size in a buffer. The context by default is set to NO_CONTEXT but can be set to specify a specific context.

Parameters

data	data pointer to wrap
size	size of data located at data pointer
context	user-specified context to track creation. Default: no context

Definition at line 45 of file Buffer.cpp.

Member Function Documentation

◆ advance()

void Fw::Buffer::advance ( FwSignedSizeType amount )

Moves the offset forward (positive) or backward (negative) by the given amount

The size is updated such that the end of the represented data is unchanged. Asserts if the resulting offset is outside [0, capacity] or the resulting size would be negative.

Parameters

amount signed number of bytes to move the offset by

Definition at line 106 of file Buffer.cpp.

◆ DEPRECATED()

Fw::Buffer::DEPRECATED	(	LinearBufferBase &	getSerializeRepr(),
		"Switch to .getSerializer() and .getDeserializer()"
	)

Returns a LinearBufferBase representation of the wrapped data for serializing

Returns a LinearBufferBase representation of the wrapped data allowing for serializing other types of data to the wrapped buffer. Once obtained the user should call one of two functions: sbb.resetSer(); to setup for serialization, or sbb.setBuffLen(buffer.getSize()); to setup for deserializing.

Returns: representation of the wrapped data to aid in serializing to it

◆ deserializeFrom()

Fw::SerializeStatus Fw::Buffer::deserializeFrom	(	Fw::SerialBufferBase &	buffer,
		Fw::Endianness	mode = `Fw::Endianness::BIG`
	)

virtual

Deserializes this buffer from a LinearBufferBase

This deserializes the buffer from a LinearBufferBase, however, it DOES NOT handle serialized data. It only deserializes the pointer to said data, the size, and context. This is done for efficiency in moving around data, and is the primary usage of Fw::Buffer. To deserialize the wrapped data, use either the data pointer accessor or the serialize buffer base representation and deserialize from that.

Parameters

buffer serialize buffer to read data into

Returns: : status of serialization

Implements Fw::Serializable.

Definition at line 201 of file Buffer.cpp.

◆ getCapacity()

FwSizeType Fw::Buffer::getCapacity ( ) const

Returns the capacity (size of the original allocation)

Definition at line 94 of file Buffer.cpp.

◆ getContext()

U32 Fw::Buffer::getContext ( ) const

Returns creation context

Definition at line 102 of file Buffer.cpp.

◆ getData()

U8 * Fw::Buffer::getData ( ) const

Returns pointer to the current data (original allocation pointer plus offset)

Definition at line 82 of file Buffer.cpp.

◆ getDeserializer()

Fw::ExternalSerializeBufferWithMemberCopy Fw::Buffer::getDeserializer ( )

Returns a ExternalSerializeBufferWithMemberCopy representation of the wrapped data for deserializing

Warning: The entire buffer (up to getSize) is available for deserialization.

Returns: representation of the wrapped data to aid in deserializing to it

Definition at line 165 of file Buffer.cpp.

◆ getOffset()

FwSizeType Fw::Buffer::getOffset ( ) const

Returns the current offset from the original allocation pointer

Definition at line 98 of file Buffer.cpp.

◆ getOriginalData()

U8 * Fw::Buffer::getOriginalData ( ) const

Returns the original allocation pointer, regardless of any advance/setData adjustments

Definition at line 86 of file Buffer.cpp.

◆ getSerializer()

Fw::ExternalSerializeBufferWithMemberCopy Fw::Buffer::getSerializer ( )

Returns a ExternalSerializeBufferWithMemberCopy representation of the wrapped data for serializing

Warning: The serialization pointer of the returned ExternalSerializeBufferWithMemberCopy object is set to zero; so that serialization will start at the beginning of the memory pointed to by the Fw::Buffer. If that; behavior is not desired the caller may manipulate the serialization offsets with moveSerToOffset; and serializeSkip methods prior to serialization.

Returns: representation of the wrapped data to aid in serializing to it

Definition at line 155 of file Buffer.cpp.

◆ getSize()

FwSizeType Fw::Buffer::getSize ( ) const

Returns size of wrapped data

Definition at line 90 of file Buffer.cpp.

◆ isValid()

bool Fw::Buffer::isValid ( ) const

Returns true if the buffer is valid (data pointer != nullptr and size > 0)

Definition at line 78 of file Buffer.cpp.

◆ operator=()

Buffer & Fw::Buffer::operator= ( const Buffer & src )

Assignment operator to set given buffer's members from another without copying wrapped data

Definition at line 58 of file Buffer.cpp.

◆ operator==()

bool Fw::Buffer::operator== ( const Buffer & src ) const

Equality operator returning true when buffers are equivalent

Buffers are deemed equivalent if they contain a pointer to the same data, with the same size, and the same context. The representation of that buffer for use with serialization and deserialization need not be equivalent.

Parameters

src	buffer to test against

Returns: : true if equivalent, false otherwise

Definition at line 73 of file Buffer.cpp.

◆ serializeTo()

Fw::SerializeStatus Fw::Buffer::serializeTo	(	Fw::SerialBufferBase &	serialBuffer,
		Fw::Endianness	mode = `Fw::Endianness::BIG`
	)		const

virtual

Serializes this buffer to a LinearBufferBase

This serializes the buffer to a LinearBufferBase, however, it DOES NOT serialize the wrapped data. It only serializes the pointer to said data, the size, and context. This is done for efficiency in moving around data, and is the primary usage of Fw::Buffer. To serialize the wrapped data, use either the data pointer accessor or the serialize buffer base representation and serialize from that.

Parameters

serialBuffer serialize buffer to write data into

Returns: : status of serialization

Implements Fw::Serializable.

Definition at line 176 of file Buffer.cpp.

◆ set()

void Fw::Buffer::set	(	U8 *	data,
		FwSizeType	size,
		U32	context = `NO_CONTEXT`
	)

Sets all values, resetting the original allocation pointer, with capacity = size and offset = 0

Parameters

data	data pointer to wrap
size	size of data located at data pointer
context	user-specified context to track creation. Default: no context

Definition at line 144 of file Buffer.cpp.

◆ setContext()

void Fw::Buffer::setContext ( U32 context )

Sets creation context

Definition at line 140 of file Buffer.cpp.

◆ setData()

void Fw::Buffer::setData ( U8 * data )

Sets pointer to current data within the original allocation

The supplied pointer must lie within the original allocation (original pointer + capacity); the offset is updated accordingly and the size is adjusted such that the end of the represented data is unchanged. Asserts when the pointer is outside the original allocation. To wrap unrelated memory, construct a new Fw::Buffer or call set().

Parameters

data	pointer within the original allocation

Definition at line 125 of file Buffer.cpp.

◆ setSize()

void Fw::Buffer::setSize ( FwSizeType size )

Sets size of wrapped data

Asserts unless offset + size <= capacity.

Parameters

size	new size of the represented data

Definition at line 131 of file Buffer.cpp.

Friends And Related Function Documentation

◆ Fw::BufferTester

friend class Fw::BufferTester

friend

Definition at line 54 of file Buffer.hpp.

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

Fw/Buffer/Buffer.hpp
Fw/Buffer/Buffer.cpp

Public Types

Public Member Functions

Friends

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ SizeType

Member Enumeration Documentation

◆ anonymous enum

◆ OwnershipState

Constructor & Destructor Documentation

◆ Buffer() [1/3]

◆ Buffer() [2/3]

◆ Buffer() [3/3]

Member Function Documentation

◆ advance()

◆ DEPRECATED()

◆ deserializeFrom()

◆ getCapacity()

◆ getContext()

◆ getData()

◆ getDeserializer()

◆ getOffset()

◆ getOriginalData()

◆ getSerializer()

◆ getSize()

◆ isValid()

◆ operator=()

◆ operator==()

◆ serializeTo()

◆ set()

◆ setContext()

◆ setData()

◆ setSize()

Friends And Related Function Documentation

◆ Fw::BufferTester