MessageBuffer Class Reference

#include <MessageBuffer.hpp>

Public Member Functions
	MessageBuffer ()
	MessageBuffer (std::size_t initial_size)
	MessageBuffer (MessageBuffer const &right)
	MessageBuffer (MessageBuffer &&right)
void	reset ()
void	resize (size_type bytes)
std::string	to_string ()
uint8_t *	get_base_pointer ()
uint8_t *	get_read_pointer ()
uint8_t *	get_write_pointer ()
void	read_completed (size_type bytes)
void	write_completed (size_type bytes)
size_type	get_active_size () const
size_type	get_remaining_space () const
size_type	get_buffer_size () const
void	normalize ()
void	ensure_free_space ()
void	write (void const *data, std::size_t size)
std::vector< uint8_t > &&	move ()
const std::vector< uint8_t > &	copy ()
MessageBuffer &	operator= (MessageBuffer const &right)
MessageBuffer &	operator= (MessageBuffer &&right)

Public Attributes
uint32_t	MAX_BUFFER_LENGTH {1536}

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

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

Member Typedef Documentation

size_type

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

private

Constructor & Destructor Documentation

MessageBuffer() [1/4]

MessageBuffer::MessageBuffer ( )

inline

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

References _storage, and MAX_BUFFER_LENGTH.

MessageBuffer() [2/4]

MessageBuffer::MessageBuffer ( std::size_t  initial_size )

inlineexplicit

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

References _storage.

MessageBuffer() [3/4]

MessageBuffer::MessageBuffer ( MessageBuffer const &  right )

inline

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

MessageBuffer() [4/4]

MessageBuffer::MessageBuffer ( MessageBuffer &&  right )

inline

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

Member Function Documentation

copy()

const std::vector< uint8_t > & MessageBuffer::copy ( )

inline

{ return _storage; }

References _storage.

ensure_free_space()

void MessageBuffer::ensure_free_space ( )

inline

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

References _storage, and get_remaining_space().

Here is the call graph for this function:

get_active_size()

size_type MessageBuffer::get_active_size ( ) const

inline

{ return _wpos - _rpos; }

References _rpos, and _wpos.

Referenced by normalize().

Here is the caller graph for this function:

get_base_pointer()

uint8_t * MessageBuffer::get_base_pointer ( )

inline

{ return _storage.data(); }

References _storage.

Referenced by get_read_pointer(), get_write_pointer(), and normalize().

Here is the caller graph for this function:

get_buffer_size()

size_type MessageBuffer::get_buffer_size ( ) const

inline

{ return _storage.size(); }

References _storage.

get_read_pointer()

uint8_t * MessageBuffer::get_read_pointer ( )

inline

{ return get_base_pointer() + _rpos; }

References _rpos, and get_base_pointer().

Referenced by normalize(), and to_string().

Here is the call graph for this function:

Here is the caller graph for this function:

get_remaining_space()

size_type MessageBuffer::get_remaining_space ( ) const

inline

{ return _storage.size() - _wpos; }

References _storage, and _wpos.

Referenced by ensure_free_space().

Here is the caller graph for this function:

get_write_pointer()

uint8_t * MessageBuffer::get_write_pointer ( )

inline

{ return get_base_pointer() + _wpos; }

References _wpos, and get_base_pointer().

Referenced by to_string(), and write().

Here is the call graph for this function:

Here is the caller graph for this function:

move()

std::vector< uint8_t > && MessageBuffer::move ( )

inline

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

References _rpos, _storage, and _wpos.

normalize()

void MessageBuffer::normalize ( )

inline

    {
        if (_rpos) {
            if (_rpos != _wpos)
                memmove(get_base_pointer(), get_read_pointer(), get_active_size());
            _wpos -= _rpos;
            _rpos = 0;
        }
    }

References _rpos, _wpos, get_active_size(), get_base_pointer(), and get_read_pointer().

Here is the call graph for this function:

operator=() [1/2]

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

inline

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

References _rpos, _storage, and _wpos.

operator=() [2/2]

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

inline

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

References _rpos, _storage, and _wpos.

read_completed()

void MessageBuffer::read_completed ( size_type  bytes )

inline

{ _rpos += bytes; }

References _rpos.

reset()

void MessageBuffer::reset ( )

inline

    {
        _wpos = 0;
        _rpos = 0;
    }

References _rpos, and _wpos.

resize()

void MessageBuffer::resize ( size_type  bytes )

inline

    {
        _storage.resize(bytes);
    }

References _storage.

to_string()

std::string MessageBuffer::to_string ( )

inline

    {
        return std::string(get_read_pointer(), get_write_pointer());
    }

References get_read_pointer(), and get_write_pointer().

Here is the call graph for this function:

write()

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

inline

    {
        if (size) {
            memcpy(get_write_pointer(), data, size);
            write_completed(size);
        }
    }

References get_write_pointer(), and write_completed().

Here is the call graph for this function:

write_completed()

void MessageBuffer::write_completed ( size_type  bytes )

inline

{ _wpos += bytes; }

References _wpos.

Referenced by write().

Here is the caller graph for this function:

Member Data Documentation

_rpos

size_type MessageBuffer::_rpos

private

Referenced by get_active_size(), get_read_pointer(), move(), normalize(), operator=(), read_completed(), and reset().

_storage

std::vector<uint8_t> MessageBuffer::_storage

private

Referenced by copy(), ensure_free_space(), get_base_pointer(), get_buffer_size(), get_remaining_space(), MessageBuffer(), move(), operator=(), and resize().

_wpos

size_type MessageBuffer::_wpos

private

Referenced by get_active_size(), get_remaining_space(), get_write_pointer(), move(), normalize(), operator=(), reset(), and write_completed().

MAX_BUFFER_LENGTH

uint32_t MessageBuffer::MAX_BUFFER_LENGTH {1536}

Referenced by MessageBuffer().

---

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

• src/Libraries/Networking/Buffer/MessageBuffer.hpp