ByteBuffer Class Reference

#include <ByteBuffer.h>

Inheritance diagram for ByteBuffer:

Classes
struct	Reserve
struct	Resize

Public Member Functions
	ByteBuffer ()
	ByteBuffer (size_t size, Reserve)
	ByteBuffer (size_t size, Resize)
	ByteBuffer (ByteBuffer const &right)=default
	ByteBuffer (ByteBuffer &&buf) noexcept
	ByteBuffer (std::vector< uint8 > &&buffer) noexcept
std::vector< uint8 > &&	Release () &&noexcept
ByteBuffer &	operator= (ByteBuffer const &right)=default
ByteBuffer &	operator= (ByteBuffer &&right) noexcept
virtual	~ByteBuffer ()=default
void	clear ()
template<ByteBufferNumeric T>
void	append (T value)
bool	HasUnfinishedBitPack () const
void	FlushBits ()
void	ResetBitPos ()
bool	WriteBit (bool bit)
bool	ReadBit ()
void	WriteBits (uint64 value, int32 bits)
uint32	ReadBits (int32 bits)
template<ByteBufferNumeric T>
void	put (std::size_t pos, T value)

Static Public Attributes
static constexpr size_t	DEFAULT_SIZE = 0x1000
static constexpr uint8	InitialBitPos = 8

PutBits
Places specified amount of bits of value at specified position in packet. To ensure all bits are correctly written, only call this method after bit flush has been performed Parameters pos Position to place the value at, in bits. The entire value must fit in the packet It is advised to obtain the position using bitwpos() function. value Data to write. bitCount Number of bits to store the value on.
size_t	_rpos
size_t	_wpos
uint8	_bitpos
uint8	_curbitval
std::vector< uint8 >	_storage
void	PutBits (std::size_t pos, std::size_t value, uint32 bitCount)
ByteBuffer &	operator<< (bool)=delete
ByteBuffer &	operator<< (char value)
ByteBuffer &	operator<< (uint8 value)
ByteBuffer &	operator<< (uint16 value)
ByteBuffer &	operator<< (uint32 value)
ByteBuffer &	operator<< (uint64 value)
ByteBuffer &	operator<< (int8 value)
ByteBuffer &	operator<< (int16 value)
ByteBuffer &	operator<< (int32 value)
ByteBuffer &	operator<< (int64 value)
ByteBuffer &	operator<< (float value)
ByteBuffer &	operator<< (double value)
ByteBuffer &	operator<< (std::string_view value)
ByteBuffer &	operator<< (std::string const &str)
ByteBuffer &	operator<< (char const *str)
ByteBuffer &	operator>> (bool &)=delete
ByteBuffer &	operator>> (char &value)
ByteBuffer &	operator>> (uint8 &value)
ByteBuffer &	operator>> (uint16 &value)
ByteBuffer &	operator>> (uint32 &value)
ByteBuffer &	operator>> (uint64 &value)
ByteBuffer &	operator>> (int8 &value)
ByteBuffer &	operator>> (int16 &value)
ByteBuffer &	operator>> (int32 &value)
ByteBuffer &	operator>> (int64 &value)
ByteBuffer &	operator>> (float &value)
ByteBuffer &	operator>> (double &value)
ByteBuffer &	operator>> (std::string &value)
uint8 &	operator[] (size_t const pos)
uint8 const &	operator[] (size_t const pos) const
size_t	rpos () const
size_t	rpos (size_t rpos_)
void	rfinish ()
size_t	wpos () const
size_t	wpos (size_t wpos_)
size_t	bitwpos () const
	Returns position of last written bit.
size_t	bitwpos (size_t newPos)
template<ByteBufferNumeric T>
void	read_skip ()
void	read_skip (size_t skip)
template<ByteBufferNumeric T>
T	read ()
template<ByteBufferNumeric T>
T	read (size_t pos) const
template<ByteBufferNumeric T>
void	read (T *dest, size_t count)
void	read (uint8 *dest, size_t len)
template<ByteBufferNumeric T, size_t Size>
void	read (std::array< T, Size > &arr)
void	WriteString (std::string const &str)
void	WriteString (std::string_view str)
void	WriteString (char const *str, size_t len)
void	ReadSkipCString (bool requireValidUtf8=true)
std::string_view	ReadCString (bool requireValidUtf8=true)
std::string_view	ReadString (uint32 length, bool requireValidUtf8=true)
uint8 *	data ()
uint8 const *	data () const
size_t	size () const
bool	empty () const
void	resize (size_t newsize)
void	reserve (size_t ressize)
void	shrink_to_fit ()
template<ByteBufferNumeric T>
void	append (T const *src, size_t cnt)
void	append (uint8 const *src, size_t cnt)
void	append (ByteBuffer const &buffer)
template<ByteBufferNumeric T, std::size_t Size>
void	append (std::array< T, Size > const &arr)
void	put (size_t pos, uint8 const *src, size_t cnt)
void	print_storage () const
void	textlike () const
void	hexlike () const
void	OnInvalidPosition (size_t pos, size_t valueSize) const

Detailed Description

Definition at line 62 of file ByteBuffer.h.

Constructor & Destructor Documentation

ByteBuffer() [1/6]

ByteBuffer::ByteBuffer ( )

inlineexplicit

Definition at line 73 of file ByteBuffer.h.

ByteBuffer() [2/6]

ByteBuffer::ByteBuffer ( size_t  size, Reserve    )

inlineexplicit

Definition at line 75 of file ByteBuffer.h.

ByteBuffer() [3/6]

ByteBuffer::ByteBuffer ( size_t  size, Resize    )

inlineexplicit

Definition at line 80 of file ByteBuffer.h.

ByteBuffer() [4/6]

ByteBuffer::ByteBuffer ( ByteBuffer const &  right )

default

ByteBuffer() [5/6]

ByteBuffer::ByteBuffer ( ByteBuffer &&  buf )

inlinenoexcept

Definition at line 87 of file ByteBuffer.h.

ByteBuffer() [6/6]

ByteBuffer::ByteBuffer ( std::vector< uint8 > &&  buffer )

inlineexplicitnoexcept

Definition at line 90 of file ByteBuffer.h.

~ByteBuffer()

virtual ByteBuffer::~ByteBuffer ( )

virtualdefault

Member Function Documentation

append() [1/5]

void ByteBuffer::append ( ByteBuffer const &  buffer )

inline

Definition at line 602 of file ByteBuffer.h.

Here is the call graph for this function:

append() [2/5]

template<ByteBufferNumeric T, std::size_t Size>

void ByteBuffer::append ( std::array< T, Size > const &  arr )

inline

Definition at line 609 of file ByteBuffer.h.

append() [3/5]

template<ByteBufferNumeric T>

void ByteBuffer::append ( T const *  src, size_t  cnt  )

inline

Definition at line 590 of file ByteBuffer.h.

append() [4/5]

template<ByteBufferNumeric T>

void ByteBuffer::append ( T  value )

inline

Definition at line 130 of file ByteBuffer.h.

Here is the call graph for this function:

Here is the caller graph for this function:

append() [5/5]

void ByteBuffer::append	(	uint8 const *	src,
		size_t	cnt
	)

Definition at line 88 of file ByteBuffer.cpp.

Here is the call graph for this function:

bitwpos() [1/2]

size_t ByteBuffer::bitwpos ( ) const

inline

Returns position of last written bit.

Definition at line 470 of file ByteBuffer.h.

bitwpos() [2/2]

size_t ByteBuffer::bitwpos ( size_t  newPos )

inline

Definition at line 472 of file ByteBuffer.h.

clear()

void ByteBuffer::clear ( )

inline

Definition at line 120 of file ByteBuffer.h.

Here is the caller graph for this function:

data() [1/2]

uint8 * ByteBuffer::data ( )

inline

Definition at line 565 of file ByteBuffer.h.

Here is the caller graph for this function:

data() [2/2]

uint8 const * ByteBuffer::data ( ) const

inline

Definition at line 566 of file ByteBuffer.h.

empty()

bool ByteBuffer::empty ( ) const

inline

Definition at line 569 of file ByteBuffer.h.

Here is the caller graph for this function:

FlushBits()

void ByteBuffer::FlushBits ( )

inline

Definition at line 141 of file ByteBuffer.h.

HasUnfinishedBitPack()

bool ByteBuffer::HasUnfinishedBitPack ( ) const

inline

Definition at line 136 of file ByteBuffer.h.

Here is the caller graph for this function:

hexlike()

void ByteBuffer::hexlike

(

)

const

Definition at line 166 of file ByteBuffer.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

OnInvalidPosition()

void ByteBuffer::OnInvalidPosition	(	size_t	pos,
		size_t	valueSize
	)		const

Definition at line 196 of file ByteBuffer.cpp.

operator<<() [1/15]

ByteBuffer & ByteBuffer::operator<< ( bool  )

delete

operator<<() [2/15]

ByteBuffer & ByteBuffer::operator<< ( char const *  str )

inline

Definition at line 363 of file ByteBuffer.h.

Here is the call graph for this function:

operator<<() [3/15]

ByteBuffer & ByteBuffer::operator<< ( char  value )

inline

Definition at line 282 of file ByteBuffer.h.

operator<<() [4/15]

ByteBuffer & ByteBuffer::operator<< ( double  value )

inline

Definition at line 344 of file ByteBuffer.h.

operator<<() [5/15]

ByteBuffer & ByteBuffer::operator<< ( float  value )

inline

Definition at line 338 of file ByteBuffer.h.

operator<<() [6/15]

ByteBuffer & ByteBuffer::operator<< ( int16  value )

inline

Definition at line 319 of file ByteBuffer.h.

operator<<() [7/15]

ByteBuffer & ByteBuffer::operator<< ( int32  value )

inline

Definition at line 325 of file ByteBuffer.h.

operator<<() [8/15]

ByteBuffer & ByteBuffer::operator<< ( int64  value )

inline

Definition at line 331 of file ByteBuffer.h.

operator<<() [9/15]

ByteBuffer & ByteBuffer::operator<< ( int8  value )

inline

Definition at line 313 of file ByteBuffer.h.

operator<<() [10/15]

ByteBuffer & ByteBuffer::operator<< ( std::string const &  str )

inline

Definition at line 358 of file ByteBuffer.h.

Here is the call graph for this function:

operator<<() [11/15]

ByteBuffer & ByteBuffer::operator<< ( std::string_view  value )

inline

Definition at line 350 of file ByteBuffer.h.

operator<<() [12/15]

ByteBuffer & ByteBuffer::operator<< ( uint16  value )

inline

Definition at line 294 of file ByteBuffer.h.

operator<<() [13/15]

ByteBuffer & ByteBuffer::operator<< ( uint32  value )

inline

Definition at line 300 of file ByteBuffer.h.

operator<<() [14/15]

ByteBuffer & ByteBuffer::operator<< ( uint64  value )

inline

Definition at line 306 of file ByteBuffer.h.

operator<<() [15/15]

ByteBuffer & ByteBuffer::operator<< ( uint8  value )

inline

Definition at line 288 of file ByteBuffer.h.

operator=() [1/2]

ByteBuffer & ByteBuffer::operator= ( ByteBuffer &&  right )

inlinenoexcept

Definition at line 104 of file ByteBuffer.h.

operator=() [2/2]

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

default

Here is the caller graph for this function:

operator>>() [1/13]

ByteBuffer & ByteBuffer::operator>> ( bool &  )

delete

operator>>() [2/13]

ByteBuffer & ByteBuffer::operator>> ( char &  value )

inline

Definition at line 370 of file ByteBuffer.h.

operator>>() [3/13]

ByteBuffer & ByteBuffer::operator>>

(

double &

value

)

Definition at line 44 of file ByteBuffer.cpp.

Here is the call graph for this function:

operator>>() [4/13]

ByteBuffer & ByteBuffer::operator>>

(

float &

value

)

Definition at line 36 of file ByteBuffer.cpp.

Here is the call graph for this function:

operator>>() [5/13]

ByteBuffer & ByteBuffer::operator>> ( int16 &  value )

inline

Definition at line 407 of file ByteBuffer.h.

operator>>() [6/13]

ByteBuffer & ByteBuffer::operator>> ( int32 &  value )

inline

Definition at line 413 of file ByteBuffer.h.

operator>>() [7/13]

ByteBuffer & ByteBuffer::operator>> ( int64 &  value )

inline

Definition at line 419 of file ByteBuffer.h.

operator>>() [8/13]

ByteBuffer & ByteBuffer::operator>> ( int8 &  value )

inline

Definition at line 401 of file ByteBuffer.h.

operator>>() [9/13]

ByteBuffer & ByteBuffer::operator>> ( std::string &  value )

inline

Definition at line 428 of file ByteBuffer.h.

operator>>() [10/13]

ByteBuffer & ByteBuffer::operator>> ( uint16 &  value )

inline

Definition at line 382 of file ByteBuffer.h.

operator>>() [11/13]

ByteBuffer & ByteBuffer::operator>> ( uint32 &  value )

inline

Definition at line 388 of file ByteBuffer.h.

operator>>() [12/13]

ByteBuffer & ByteBuffer::operator>> ( uint64 &  value )

inline

Definition at line 394 of file ByteBuffer.h.

operator>>() [13/13]

ByteBuffer & ByteBuffer::operator>> ( uint8 &  value )

inline

Definition at line 376 of file ByteBuffer.h.

operator[]() [1/2]

uint8 & ByteBuffer::operator[] ( size_t const  pos )

inline

Definition at line 434 of file ByteBuffer.h.

operator[]() [2/2]

uint8 const & ByteBuffer::operator[] ( size_t const  pos ) const

inline

Definition at line 441 of file ByteBuffer.h.

print_storage()

void ByteBuffer::print_storage

(

)

const

Definition at line 140 of file ByteBuffer.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

put() [1/2]

void ByteBuffer::put	(	size_t	pos,
		uint8 const *	src,
		size_t	cnt
	)

Definition at line 115 of file ByteBuffer.cpp.

Here is the call graph for this function:

put() [2/2]

template<ByteBufferNumeric T>

void ByteBuffer::put ( std::size_t  pos, T  value  )

inline

Definition at line 260 of file ByteBuffer.h.

Here is the call graph for this function:

Here is the caller graph for this function:

PutBits()

void ByteBuffer::PutBits	(	std::size_t	pos,
		std::size_t	value,
		uint32	bitCount
	)

Definition at line 124 of file ByteBuffer.cpp.

Here is the call graph for this function:

read() [1/5]

template<ByteBufferNumeric T>

template double ByteBuffer::read< double > ( )

inline

Definition at line 492 of file ByteBuffer.h.

Here is the caller graph for this function:

read() [2/5]

template<ByteBufferNumeric T>

T ByteBuffer::read ( size_t  pos ) const

inline

Definition at line 501 of file ByteBuffer.h.

Here is the call graph for this function:

read() [3/5]

template<ByteBufferNumeric T, size_t Size>

void ByteBuffer::read ( std::array< T, Size > &  arr )

inline

Definition at line 534 of file ByteBuffer.h.

read() [4/5]

template<ByteBufferNumeric T>

void ByteBuffer::read ( T *  dest, size_t  count  )

inline

Definition at line 513 of file ByteBuffer.h.

Here is the call graph for this function:

read() [5/5]

void ByteBuffer::read ( uint8 *  dest, size_t  len  )

inline

Definition at line 523 of file ByteBuffer.h.

read_skip() [1/2]

template<ByteBufferNumeric T>

void ByteBuffer::read_skip ( )

inline

Definition at line 480 of file ByteBuffer.h.

Here is the call graph for this function:

Here is the caller graph for this function:

read_skip() [2/2]

void ByteBuffer::read_skip ( size_t  skip )

inline

Definition at line 482 of file ByteBuffer.h.

ReadBit()

bool ByteBuffer::ReadBit ( )

inline

Definition at line 174 of file ByteBuffer.h.

Here is the caller graph for this function:

ReadBits()

uint32 ByteBuffer::ReadBits ( int32  bits )

inline

Definition at line 224 of file ByteBuffer.h.

ReadCString()

std::string_view ByteBuffer::ReadCString

(

bool

requireValidUtf8 = true

)

Definition at line 52 of file ByteBuffer.cpp.

Here is the call graph for this function:

ReadSkipCString()

void ByteBuffer::ReadSkipCString ( bool  requireValidUtf8 = true )

inline

Definition at line 559 of file ByteBuffer.h.

ReadString()

std::string_view ByteBuffer::ReadString	(	uint32	length,
		bool	requireValidUtf8 = true
	)

Definition at line 72 of file ByteBuffer.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

Release()

std::vector< uint8 > && ByteBuffer::Release ( ) &&

inlinenoexcept

Definition at line 93 of file ByteBuffer.h.

reserve()

void ByteBuffer::reserve ( size_t  ressize )

inline

Definition at line 578 of file ByteBuffer.h.

Here is the caller graph for this function:

ResetBitPos()

void ByteBuffer::ResetBitPos ( )

inline

Definition at line 152 of file ByteBuffer.h.

Here is the caller graph for this function:

resize()

void ByteBuffer::resize ( size_t  newsize )

inline

Definition at line 571 of file ByteBuffer.h.

Here is the caller graph for this function:

rfinish()

void ByteBuffer::rfinish ( )

inline

Definition at line 456 of file ByteBuffer.h.

Here is the caller graph for this function:

rpos() [1/2]

size_t ByteBuffer::rpos ( ) const

inline

Definition at line 448 of file ByteBuffer.h.

Here is the caller graph for this function:

rpos() [2/2]

size_t ByteBuffer::rpos ( size_t  rpos_ )

inline

Definition at line 450 of file ByteBuffer.h.

shrink_to_fit()

void ByteBuffer::shrink_to_fit ( )

inline

Definition at line 584 of file ByteBuffer.h.

Here is the caller graph for this function:

size()

size_t ByteBuffer::size ( ) const

inline

Definition at line 568 of file ByteBuffer.h.

Here is the caller graph for this function:

textlike()

void ByteBuffer::textlike

(

)

const

Definition at line 153 of file ByteBuffer.cpp.

Here is the call graph for this function:

wpos() [1/2]

size_t ByteBuffer::wpos ( ) const

inline

Definition at line 461 of file ByteBuffer.h.

Here is the caller graph for this function:

wpos() [2/2]

size_t ByteBuffer::wpos ( size_t  wpos_ )

inline

Definition at line 463 of file ByteBuffer.h.

WriteBit()

bool ByteBuffer::WriteBit ( bool  bit )

inline

Definition at line 158 of file ByteBuffer.h.

Here is the caller graph for this function:

WriteBits()

void ByteBuffer::WriteBits ( uint64  value, int32  bits  )

inline

Definition at line 185 of file ByteBuffer.h.

Here is the caller graph for this function:

WriteString() [1/3]

void ByteBuffer::WriteString ( char const *  str, size_t  len  )

inline

Definition at line 553 of file ByteBuffer.h.

WriteString() [2/3]

void ByteBuffer::WriteString ( std::string const &  str )

inline

Method for writing strings that have their length sent separately in packet without null-terminating the string

Definition at line 541 of file ByteBuffer.h.

WriteString() [3/3]

void ByteBuffer::WriteString ( std::string_view  str )

inline

Definition at line 547 of file ByteBuffer.h.

Member Data Documentation

_bitpos

uint8 ByteBuffer::_bitpos

protected

Definition at line 626 of file ByteBuffer.h.

_curbitval

uint8 ByteBuffer::_curbitval

protected

Definition at line 627 of file ByteBuffer.h.

_rpos

size_t ByteBuffer::_rpos

protected

Definition at line 625 of file ByteBuffer.h.

_storage

std::vector<uint8> ByteBuffer::_storage

protected

Definition at line 628 of file ByteBuffer.h.

_wpos

size_t ByteBuffer::_wpos

protected

Definition at line 625 of file ByteBuffer.h.

DEFAULT_SIZE

constexpr size_t ByteBuffer::DEFAULT_SIZE = 0x1000

staticconstexpr

Definition at line 65 of file ByteBuffer.h.

InitialBitPos

constexpr uint8 ByteBuffer::InitialBitPos = 8

staticconstexpr

Definition at line 66 of file ByteBuffer.h.

---

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

• server/shared/Packets/ByteBuffer.h
• server/shared/Packets/ByteBuffer.cpp