openjaus::system::Buffer Class Reference

#include <Buffer.h>

Inherits openjaus::system::Transportable.

Inherited by openjaus::system::Packet, and openjaus::transport::AS5669::JtcpStream.

List of all members.

Public Member Functions
	Buffer ()
virtual	~Buffer ()
	Buffer (int maxSize)
unsigned char *	getPointer () const
	Accessor to get the value of pointer.
int	getMaxSize () const
	Accessor to get the value of maxSize.
bool	setMaxSize (int maxSize)
	Accessor to set value of maxSize.
unsigned char *	getBuffer () const
	Accessor to get the value of buffer.
int	append (Buffer &newBuffer)
	Operation append.
void	free ()
	Operation free.
void	increment (int byteCount)
	Operation increment.
int	remainingBytes ()
	Operation remainingBytes.
int	containedBytes ()
	Operation containedBytes.
int	clear ()
	Operation clear.
unsigned char *	reset ()
	Operation reset.
int	to (Buffer *dst, int byteCount)
	Operation to.
int	from (Buffer *src, int byteCount)
	Operation from.
int	setAllTo (unsigned char newValue)
	Operation setAllTo.
int	set (unsigned char value, int count)
	Operation set.
virtual int	to (Buffer *dst)
	Operation to.
virtual int	from (Buffer *src)
	Operation from.
virtual int	length ()
	Serializes object to internal transport buffer.
std::string	toString () const
template<typename Type >
int	peekTemplate (Type &value)
int	peek (int8_t &value)
int	peek (int16_t &value)
int	peek (int32_t &value)
int	peek (int64_t &value)
int	peek (uint8_t &value)
int	peek (uint16_t &value)
int	peek (uint32_t &value)
int	peek (uint64_t &value)
int	peek (float &value)
int	peek (double &value)
template<typename Type >
int	unpackTemplate (Type &value)
int	unpack (int8_t &value)
int	unpack (int16_t &value)
int	unpack (int32_t &value)
int	unpack (int64_t &value)
int	unpack (uint8_t &value)
int	unpack (uint16_t &value)
int	unpack (uint32_t &value)
int	unpack (uint64_t &value)
int	unpack (float &value)
int	unpack (double &value)
int	unpack (Transportable &value)
int	unpack (std::string &dst, unsigned long length)
template<typename Type >
int	packTemplate (const Type &value)
int	pack (const int8_t &value)
int	pack (const int16_t &value)
int	pack (const int32_t &value)
int	pack (const int64_t &value)
int	pack (const uint8_t &value)
int	pack (const uint16_t &value)
int	pack (const uint32_t &value)
int	pack (const uint64_t &value)
int	pack (const float &value)
int	pack (const double &value)
int	pack (Transportable &value)
int	pack (std::string &source)
int	pack (std::string &source, unsigned int length)
Protected Attributes
unsigned char *	pointer
int	maxSize
unsigned char *	buffer
Friends
std::ostream &	operator<< (std::ostream &output, const Buffer &object)

---

Constructor & Destructor Documentation

openjaus::system::Buffer::Buffer

(

)

openjaus::system::Buffer::~Buffer

(

)

[virtual]

openjaus::system::Buffer::Buffer

(

int

maxSize

)

---

Member Function Documentation

int openjaus::system::Buffer::append

(

Buffer &

newBuffer

)

Parameters:

newBuffer

int openjaus::system::Buffer::clear

(

)

int openjaus::system::Buffer::containedBytes

(

)

void openjaus::system::Buffer::free

(

)

int openjaus::system::Buffer::from

(

Buffer *

src

)

[virtual]

Parameters:

src

Implements openjaus::system::Transportable.

int openjaus::system::Buffer::from	(	Buffer *	src,
		int	byteCount
	)

Parameters:

	src
	byteCount

unsigned char * openjaus::system::Buffer::getBuffer

(

)

const

int openjaus::system::Buffer::getMaxSize

(

)

const

unsigned char * openjaus::system::Buffer::getPointer

(

)

const

void openjaus::system::Buffer::increment

(

int

byteCount

)

Parameters:

byteCount

int openjaus::system::Buffer::length

(

)

[virtual]

Implements openjaus::system::Transportable.

int openjaus::system::Buffer::pack

(

const uint32_t &

value

)

[inline]

int openjaus::system::Buffer::pack

(

const int8_t &

value

)

[inline]

int openjaus::system::Buffer::pack

(

const int16_t &

value

)

[inline]

int openjaus::system::Buffer::pack

(

const int32_t &

value

)

[inline]

int openjaus::system::Buffer::pack

(

Transportable &

value

)

[inline]

int openjaus::system::Buffer::pack

(

const int64_t &

value

)

[inline]

int openjaus::system::Buffer::pack

(

const uint8_t &

value

)

[inline]

int openjaus::system::Buffer::pack

(

const uint16_t &

value

)

[inline]

int openjaus::system::Buffer::pack

(

const uint64_t &

value

)

[inline]

int openjaus::system::Buffer::pack

(

const float &

value

)

[inline]

int openjaus::system::Buffer::pack

(

const double &

value

)

[inline]

int openjaus::system::Buffer::pack

(

std::string &

source

)

int openjaus::system::Buffer::pack	(	std::string &	source,
		unsigned int	length
	)

template<typename Type >

int openjaus::system::Buffer::packTemplate

(

const Type &

value

)

[inline]

int openjaus::system::Buffer::peek

(

uint8_t &

value

)

[inline]

int openjaus::system::Buffer::peek

(

uint32_t &

value

)

[inline]

int openjaus::system::Buffer::peek

(

uint64_t &

value

)

[inline]

int openjaus::system::Buffer::peek

(

int8_t &

value

)

[inline]

int openjaus::system::Buffer::peek

(

int16_t &

value

)

[inline]

int openjaus::system::Buffer::peek

(

int32_t &

value

)

[inline]

int openjaus::system::Buffer::peek

(

int64_t &

value

)

[inline]

int openjaus::system::Buffer::peek

(

uint16_t &

value

)

[inline]

int openjaus::system::Buffer::peek

(

float &

value

)

[inline]

int openjaus::system::Buffer::peek

(

double &

value

)

[inline]

template<typename Type >

int openjaus::system::Buffer::peekTemplate

(

Type &

value

)

[inline]

int openjaus::system::Buffer::remainingBytes

(

)

unsigned char * openjaus::system::Buffer::reset

(

)

Reimplemented in openjaus::transport::AS5669::JtcpPacket, and openjaus::transport::AS5669::JudpPacket.

int openjaus::system::Buffer::set	(	unsigned char	value,
		int	count
	)

Parameters:

	value
	count

int openjaus::system::Buffer::setAllTo

(

unsigned char

newValue

)

Parameters:

newValue

bool openjaus::system::Buffer::setMaxSize

(

int

maxSize

)

Parameters:

maxSize

The value of the new maxSize.

int openjaus::system::Buffer::to

(

Buffer *

dst

)

[virtual]

Parameters:

dst

Implements openjaus::system::Transportable.

int openjaus::system::Buffer::to	(	Buffer *	dst,
		int	byteCount
	)

Parameters:

	dst
	byteCount

std::string openjaus::system::Buffer::toString

(

)

const

Reimplemented from openjaus::system::Transportable.

Reimplemented in openjaus::system::Packet, openjaus::transport::AS5669::JtcpPacket, openjaus::transport::AS5669::JtcpStream, and openjaus::transport::AS5669::JudpPacket.

int openjaus::system::Buffer::unpack

(

float &

value

)

[inline]

int openjaus::system::Buffer::unpack

(

uint64_t &

value

)

[inline]

int openjaus::system::Buffer::unpack

(

uint32_t &

value

)

[inline]

int openjaus::system::Buffer::unpack

(

uint16_t &

value

)

[inline]

int openjaus::system::Buffer::unpack

(

double &

value

)

[inline]

int openjaus::system::Buffer::unpack

(

int32_t &

value

)

[inline]

int openjaus::system::Buffer::unpack

(

int16_t &

value

)

[inline]

int openjaus::system::Buffer::unpack	(	std::string &	dst,
		unsigned long	length
	)

int openjaus::system::Buffer::unpack

(

int64_t &

value

)

[inline]

int openjaus::system::Buffer::unpack

(

uint8_t &

value

)

[inline]

int openjaus::system::Buffer::unpack

(

int8_t &

value

)

[inline]

int openjaus::system::Buffer::unpack

(

Transportable &

value

)

[inline]

template<typename Type >

int openjaus::system::Buffer::unpackTemplate

(

Type &

value

)

[inline]

---

Friends And Related Function Documentation

std::ostream& operator<<	(	std::ostream &	output,
		const Buffer &	object
	)			[friend]

---

Member Data Documentation

unsigned char* openjaus::system::Buffer::buffer [protected]

int openjaus::system::Buffer::maxSize [protected]

unsigned char* openjaus::system::Buffer::pointer [protected]

---

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

• include/openjaus/system/Buffer.h
• src/openjaus/system/Buffer.cpp