MessageBuffer Class Reference

#include <MessageBuffer.h>

Public Member Functions
	MessageBuffer ()
	MessageBuffer (std::size_t initialSize)
	MessageBuffer (MessageBuffer const &right)
	MessageBuffer (MessageBuffer &&right)
void	Reset ()
void	Resize (size_type bytes)
uint8 *	GetBasePointer ()
uint8 *	GetReadPointer ()
uint8 *	GetWritePointer ()
void	ReadCompleted (size_type bytes)
void	WriteCompleted (size_type bytes)
size_type	GetActiveSize () const
size_type	GetRemainingSpace () const
size_type	GetBufferSize () const
void	Normalize ()
void	EnsureFreeSpace ()
void	Write (void const *data, std::size_t size)
std::vector< uint8 > &&	Move ()
MessageBuffer &	operator= (MessageBuffer const &right)
MessageBuffer &	operator= (MessageBuffer &&right)

Private Types
typedef std::vector< uint8 > ::size_type	size_type

Private Attributes
size_type	_wpos
size_type	_rpos
std::vector< uint8 >	_storage

Member Typedef Documentation

typedef std::vector<uint8>::size_type MessageBuffer::size_type

private

Constructor & Destructor Documentation

MessageBuffer::MessageBuffer ( )

inline

 : _wpos(0), _rpos(0), _storage()
 {
 _storage.resize(4096);
 }

MessageBuffer::MessageBuffer ( std::size_t  initialSize )

inlineexplicit

 : _wpos(0), _rpos(0), _storage()
 {
 _storage.resize(initialSize);
 }

MessageBuffer::MessageBuffer ( MessageBuffer const &  right )

inline

 : _wpos(right._wpos), _rpos(right._rpos), _storage(right._storage)
 {
 }

MessageBuffer::MessageBuffer ( MessageBuffer &&  right )

inline

: _wpos(right._wpos), _rpos(right._rpos), _storage(right.Move()) { }

Member Function Documentation

void MessageBuffer::EnsureFreeSpace ( )

inline

 {
 // resize buffer if it's already full
 if (GetRemainingSpace() == 0)
 _storage.resize(_storage.size() * 3 / 2);
 }

Here is the call graph for this function:

Here is the caller graph for this function:

size_type MessageBuffer::GetActiveSize ( ) const

inline

{ return _wpos - _rpos; }

Here is the caller graph for this function:

uint8* MessageBuffer::GetBasePointer ( )

inline

{ return _storage.data(); }

Here is the caller graph for this function:

size_type MessageBuffer::GetBufferSize ( ) const

inline

{ return _storage.size(); }

uint8* MessageBuffer::GetReadPointer ( )

inline

{ return GetBasePointer() + _rpos; }

Here is the call graph for this function:

Here is the caller graph for this function:

size_type MessageBuffer::GetRemainingSpace ( ) const

inline

{ return _storage.size() - _wpos; }

Here is the caller graph for this function:

uint8* MessageBuffer::GetWritePointer ( )

inline

{ return GetBasePointer() + _wpos; }

Here is the call graph for this function:

Here is the caller graph for this function:

std::vector<uint8>&& MessageBuffer::Move ( )

inline

 {
 _wpos = 0;
 _rpos = 0;
 return std::move(_storage);
 }

void MessageBuffer::Normalize ( )

inline

 {
 if (_rpos)
 {
 if (_rpos != _wpos)
 memmove(GetBasePointer(), GetReadPointer(), GetActiveSize());
 _wpos -= _rpos;
 _rpos = 0;
 }
 }

Here is the call graph for this function:

Here is the caller graph for this function:

MessageBuffer& MessageBuffer::operator= ( MessageBuffer const &  right )

inline

 {
 if (this != &right)
 {
 _wpos = right._wpos;
 _rpos = right._rpos;
 _storage = right._storage;
 }

 return *this;
 }

MessageBuffer& MessageBuffer::operator= ( MessageBuffer &&  right )

inline

 {
 if (this != &right)
 {
 _wpos = right._wpos;
 _rpos = right._rpos;
 _storage = right.Move();
 }

 return *this;
 }

void MessageBuffer::ReadCompleted ( size_type  bytes )

inline

{ _rpos += bytes; }

Here is the caller graph for this function:

void MessageBuffer::Reset ( )

inline

 {
 _wpos = 0;
 _rpos = 0;
 }

Here is the caller graph for this function:

void MessageBuffer::Resize ( size_type  bytes )

inline

 {
 _storage.resize(bytes);
 }

Here is the caller graph for this function:

void MessageBuffer::Write ( void const *  data, std::size_t  size  )

inline

 {
 if (size)
 {
 memcpy(GetWritePointer(), data, size);
 WriteCompleted(size);
 }
 }

Here is the call graph for this function:

Here is the caller graph for this function:

void MessageBuffer::WriteCompleted ( size_type  bytes )

inline

{ _wpos += bytes; }

Here is the caller graph for this function:

Member Data Documentation

size_type MessageBuffer::_rpos

private

std::vector<uint8> MessageBuffer::_storage

private

size_type MessageBuffer::_wpos

private

---

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

• src/common/Utilities/MessageBuffer.h