sptk::BufferStorage Class Reference

#include <BufferStorage.h>

Inheritance diagram for sptk::BufferStorage:

Public Member Functions
	BufferStorage ()
	BufferStorage (size_t sz)
	BufferStorage (const BufferStorage &bufferStorage)=default
	BufferStorage (BufferStorage &&bufferStorage) noexcept=default
virtual	~BufferStorage ()=default
BufferStorage &	operator= (const BufferStorage &bufferStorage)=default
BufferStorage &	operator= (BufferStorage &&bufferStorage) noexcept=default
template<typename T >
	BufferStorage (const T *data, size_t sz)
uint8_t *	data ()
const uint8_t *	data () const
const char *	c_str () const
bool	empty () const
virtual void	checkSize (size_t sz)
template<typename T >
void	set (const T *data, size_t sz)
void	set (const BufferStorage &data)
void	set (const String &data)
size_t	capacity () const
size_t	length () const
size_t	bytes () const
void	bytes (size_t b)
virtual void	append (char ch)
virtual void	append (const char *data, size_t sz=0)
virtual void	append (const uint8_t *data, size_t sz)
void	reset (size_t sz=0)
void	fill (char ch, size_t count)
void	erase (size_t offset, size_t length)

Protected Member Functions
void	adjustSize (size_t sz)
void	allocate (size_t size)
void	allocate (const uint8_t *data, size_t size)
void	reallocate (size_t size)
void	deallocate () noexcept
void	init (const uint8_t *data, size_t size, size_t bytes)

Detailed Description

Memory data buffer storage

Constructor & Destructor Documentation

BufferStorage() [1/5]

sptk::BufferStorage::BufferStorage ( )

inline

Default constructor

Creates an empty buffer.

BufferStorage() [2/5]

sptk::BufferStorage::BufferStorage ( size_t  sz )

inlineexplicit

Constructor

Creates an empty buffer. The return of the bytes() method will be 0.

Parameters

sz	Buffer size to be pre-allocated

BufferStorage() [3/5]

sptk::BufferStorage::BufferStorage ( const BufferStorage &  bufferStorage )

default

Copy constructor

Parameters

bufferStorage

Other object

BufferStorage() [4/5]

sptk::BufferStorage::BufferStorage ( BufferStorage &&  bufferStorage )

defaultnoexcept

Move constructor

Parameters

bufferStorage

Other object

~BufferStorage()

virtual sptk::BufferStorage::~BufferStorage ( )

virtualdefault

Destructor

BufferStorage() [5/5]

template<typename T >

sptk::BufferStorage::BufferStorage ( const T *  data, size_t  sz  )

inline

Constructor

Creates a buffer from void *data. The data is copied inside the buffer. The return of the bytes() method will be the input data size.

Parameters

data	Data buffer
sz	Data buffer size

Member Function Documentation

adjustSize()

void sptk::BufferStorage::adjustSize ( size_t  sz )

protected

Resizes current buffer

Parameters

sz	Required memory size

allocate() [1/2]

void sptk::BufferStorage::allocate ( const uint8_t *  data, size_t  size  )

inlineprotected

Allocate memory

Parameters

size	Number of bytes for new buffer

allocate() [2/2]

void sptk::BufferStorage::allocate ( size_t  size )

inlineprotected

Allocate memory

Parameters

size	Number of bytes for new buffer

append() [1/3]

virtual void sptk::BufferStorage::append ( char  ch )

virtual

Appends a single char to the current buffer.

Allocates memory if needed.

Parameters

ch	Single character

Reimplemented in sptk::Buffer.

Referenced by sptk::Buffer::append().

append() [2/3]

virtual void sptk::BufferStorage::append ( const char *  data, size_t  sz = 0  )

virtual

Appends the external data of size sz to the current buffer.

Allocates memory if needed.

Parameters

data	External data buffer
sz	Required memory size

Reimplemented in sptk::Buffer.

append() [3/3]

virtual void sptk::BufferStorage::append ( const uint8_t *  data, size_t  sz  )

virtual

Appends the external data of size sz to the current buffer.

Allocates memory if needed.

Parameters

data	External data buffer
sz	Required memory size

Reimplemented in sptk::Buffer.

bytes() [1/2]

size_t sptk::BufferStorage::bytes ( ) const

inline

Returns the size of data in the data buffer

Returns

data size

Referenced by sptk::Buffer::append(), sptk::ReadBuffer::available(), sptk::ReadBuffer::eof(), sptk::WSString::operator=(), sptk::QueryParameter::operator=(), and sptk::Field::operator=().

bytes() [2/2]

void sptk::BufferStorage::bytes ( size_t  b )

inline

Sets the size of the data stored

Doesn't check anything so use it this caution.

Parameters

b	New size of the buffer

c_str()

const char * sptk::BufferStorage::c_str ( ) const

inline

Returns const char pointer on the data buffer.

capacity()

size_t sptk::BufferStorage::capacity ( ) const

inline

Returns the size of memory allocated for the data buffer

Returns

buffer size

checkSize()

virtual void sptk::BufferStorage::checkSize ( size_t  sz )

inlinevirtual

Checks if the current buffer size is enough

Allocates memory if needed.

Parameters

sz	Required memory size

data() [1/2]

uint8_t * sptk::BufferStorage::data ( )

inline

Returns pointer on the data buffer.

Referenced by sptk::Buffer::append(), sptk::ReadBuffer::head(), sptk::WSString::operator=(), sptk::QueryParameter::operator=(), sptk::Field::operator=(), and sptk::ReadBuffer::read().

data() [2/2]

const uint8_t * sptk::BufferStorage::data ( ) const

inline

Returns pointer on the data buffer.

deallocate()

void sptk::BufferStorage::deallocate ( )

inlineprotectednoexcept

Free memory

empty()

bool sptk::BufferStorage::empty ( ) const

inline

Returns true if number of bytes in buffer is zero.

erase()

void sptk::BufferStorage::erase	(	size_t	offset,
		size_t	length
	)

Remove fragment from buffer's content

Parameters

offset	Fragment start offset
length	Fragment length

fill()

void sptk::BufferStorage::fill	(	char	ch,
		size_t	count
	)

Fills the bytes() characters in buffer with character ch.

Parameters

ch	The character to fill the buffer
count	How many characters are to be filled. If counter is greater than capacity, then buffer is extended.

length()

size_t sptk::BufferStorage::length ( ) const

inline

Returns the size of data in the data buffer

Returns

data size

reallocate()

void sptk::BufferStorage::reallocate ( size_t  size )

inlineprotected

Reallocate memory

Parameters

size	Number of bytes for new buffer

reset()

void sptk::BufferStorage::reset

(

size_t

sz = 0

)

Truncates the current buffer to the size sz.

Deallocates unused memory if needed.

Parameters

sz	Required data size in bytes

set() [1/3]

void sptk::BufferStorage::set ( const BufferStorage &  data )

inline

Copies the external data of size sz into the current buffer.

Allocates memory if needed.

Parameters

data	External data buffer

set() [2/3]

void sptk::BufferStorage::set ( const String &  data )

inline

Copies the external data of size sz into the current buffer.

Allocates memory if needed.

Parameters

data	External data

set() [3/3]

template<typename T >

void sptk::BufferStorage::set ( const T *  data, size_t  sz  )

inline

Copies the external data of size sz into the current buffer.

Allocates memory if needed.

Parameters

data	External data buffer
sz	Required memory size

---

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

• BufferStorage.h