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 &&buf) noexcept
	ByteBuffer (ByteBuffer const &right)=default
	ByteBuffer (MessageBuffer &&buffer)
std::vector< uint8 > &&	Move () noexcept
ByteBuffer &	operator= (ByteBuffer const &right)
ByteBuffer &	operator= (ByteBuffer &&right) noexcept
virtual	~ByteBuffer ()=default
void	clear ()
template<typename 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<typename T >
void	put (std::size_t pos, T value)
template<>
void	read_skip ()
template<>
void	read_skip ()

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<< (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 &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. More...
size_t	bitwpos (size_t newPos)
template<typename T >
void	read_skip ()
void	read_skip (size_t skip)
template<typename T >
T	read ()
template<typename T >
T	read (size_t pos) const
template<typename T >
void	read (T *dest, size_t count)
void	read (uint8 *dest, size_t len)
template<size_t Size>
void	read (std::array< uint8, Size > &arr)
void	ReadPackedUInt64 (uint64 &guid)
void	ReadPackedUInt64 (uint8 mask, uint64 &value)
void	WriteString (std::string const &str)
void	WriteString (std::string_view str)
void	WriteString (char const *str, size_t len)
std::string_view	ReadCString (bool requireValidUtf8=true)
std::string_view	ReadString (uint32 length, bool requireValidUtf8=true)
uint8 *	contents ()
uint8 const *	contents () const
size_t	size () const
bool	empty () const
void	resize (size_t newsize)
void	reserve (size_t ressize)
void	shrink_to_fit ()
template<typename T >
void	append (T const *src, size_t cnt)
void	append (uint8 const *src, size_t cnt)
void	append (ByteBuffer const &buffer)
template<size_t Size>
void	append (std::array< uint8, Size > const &arr)
void	appendPackXYZ (float x, float y, float z)
void	AppendPackedUInt64 (uint64 guid)
void	put (size_t pos, uint8 const *src, size_t cnt)
void	print_storage () const
void	textlike () const
void	hexlike () const
static size_t	PackUInt64 (uint64 value, uint8 *mask, uint8 *result)

Detailed Description

Definition at line 55 of file ByteBuffer.h.

Constructor & Destructor Documentation

ByteBuffer() [1/6]

ByteBuffer::ByteBuffer ( )

inline

Definition at line 62 of file ByteBuffer.h.

ByteBuffer() [2/6]

ByteBuffer::ByteBuffer ( size_t  size, Reserve    )

inline

Definition at line 71 of file ByteBuffer.h.

Here is the call graph for this function:

ByteBuffer() [3/6]

ByteBuffer::ByteBuffer ( size_t  size, Resize    )

inline

Definition at line 76 of file ByteBuffer.h.

Here is the call graph for this function:

ByteBuffer() [4/6]

ByteBuffer::ByteBuffer ( ByteBuffer &&  buf )

inlinenoexcept

Definition at line 81 of file ByteBuffer.h.

ByteBuffer() [5/6]

ByteBuffer::ByteBuffer ( ByteBuffer const &  right )

default

ByteBuffer() [6/6]

ByteBuffer::ByteBuffer

(

MessageBuffer &&

buffer

)

Definition at line 28 of file ByteBuffer.cpp.

~ByteBuffer()

virtual ByteBuffer::~ByteBuffer ( )

virtualdefault

Member Function Documentation

append() [1/5]

void ByteBuffer::append ( ByteBuffer const &  buffer )

inline

Definition at line 600 of file ByteBuffer.h.

Here is the call graph for this function:

append() [2/5]

template<size_t Size>

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

inline

Definition at line 607 of file ByteBuffer.h.

append() [3/5]

template<typename T >

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

inline

Definition at line 588 of file ByteBuffer.h.

append() [4/5]

template<typename T >

void ByteBuffer::append ( T  value )

inline

Definition at line 137 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 94 of file ByteBuffer.cpp.

Here is the call graph for this function:

AppendPackedUInt64()

void ByteBuffer::AppendPackedUInt64 ( uint64  guid )

inline

Definition at line 622 of file ByteBuffer.h.

appendPackXYZ()

void ByteBuffer::appendPackXYZ ( float  x, float  y, float  z  )

inline

Definition at line 613 of file ByteBuffer.h.

Here is the caller graph for this function:

bitwpos() [1/2]

size_t ByteBuffer::bitwpos ( ) const

inline

Returns position of last written bit.

Definition at line 447 of file ByteBuffer.h.

bitwpos() [2/2]

size_t ByteBuffer::bitwpos ( size_t  newPos )

inline

Definition at line 449 of file ByteBuffer.h.

clear()

void ByteBuffer::clear ( )

inline

Definition at line 127 of file ByteBuffer.h.

Here is the caller graph for this function:

contents() [1/2]

uint8 * ByteBuffer::contents ( )

inline

Definition at line 552 of file ByteBuffer.h.

Here is the caller graph for this function:

contents() [2/2]

uint8 const * ByteBuffer::contents ( ) const

inline

Definition at line 559 of file ByteBuffer.h.

empty()

bool ByteBuffer::empty ( ) const

inline

Definition at line 567 of file ByteBuffer.h.

Here is the caller graph for this function:

FlushBits()

void ByteBuffer::FlushBits ( )

inline

Definition at line 149 of file ByteBuffer.h.

HasUnfinishedBitPack()

bool ByteBuffer::HasUnfinishedBitPack ( ) const

inline

Definition at line 144 of file ByteBuffer.h.

Here is the caller graph for this function:

hexlike()

void ByteBuffer::hexlike

(

)

const

Definition at line 177 of file ByteBuffer.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

Move()

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

inlinenoexcept

Definition at line 88 of file ByteBuffer.h.

operator<<() [1/13]

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

inline

Definition at line 342 of file ByteBuffer.h.

Here is the call graph for this function:

operator<<() [2/13]

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

inline

Definition at line 323 of file ByteBuffer.h.

operator<<() [3/13]

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

inline

Definition at line 317 of file ByteBuffer.h.

operator<<() [4/13]

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

inline

Definition at line 298 of file ByteBuffer.h.

operator<<() [5/13]

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

inline

Definition at line 304 of file ByteBuffer.h.

operator<<() [6/13]

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

inline

Definition at line 310 of file ByteBuffer.h.

operator<<() [7/13]

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

inline

Definition at line 292 of file ByteBuffer.h.

operator<<() [8/13]

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

inline

Definition at line 337 of file ByteBuffer.h.

Here is the call graph for this function:

operator<<() [9/13]

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

inline

Definition at line 329 of file ByteBuffer.h.

operator<<() [10/13]

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

inline

Definition at line 273 of file ByteBuffer.h.

operator<<() [11/13]

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

inline

Definition at line 279 of file ByteBuffer.h.

operator<<() [12/13]

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

inline

Definition at line 285 of file ByteBuffer.h.

operator<<() [13/13]

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

inline

Definition at line 267 of file ByteBuffer.h.

operator=() [1/2]

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

inlinenoexcept

Definition at line 111 of file ByteBuffer.h.

operator=() [2/2]

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

inline

Definition at line 97 of file ByteBuffer.h.

Here is the caller graph for this function:

operator>>() [1/12]

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

inline

Definition at line 347 of file ByteBuffer.h.

operator>>() [2/12]

ByteBuffer & ByteBuffer::operator>>

(

double &

value

)

Definition at line 50 of file ByteBuffer.cpp.

Here is the call graph for this function:

operator>>() [3/12]

ByteBuffer & ByteBuffer::operator>>

(

float &

value

)

Definition at line 42 of file ByteBuffer.cpp.

Here is the call graph for this function:

operator>>() [4/12]

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

inline

Definition at line 384 of file ByteBuffer.h.

operator>>() [5/12]

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

inline

Definition at line 390 of file ByteBuffer.h.

operator>>() [6/12]

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

inline

Definition at line 396 of file ByteBuffer.h.

operator>>() [7/12]

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

inline

Definition at line 378 of file ByteBuffer.h.

operator>>() [8/12]

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

inline

Definition at line 405 of file ByteBuffer.h.

operator>>() [9/12]

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

inline

Definition at line 359 of file ByteBuffer.h.

operator>>() [10/12]

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

inline

Definition at line 365 of file ByteBuffer.h.

operator>>() [11/12]

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

inline

Definition at line 371 of file ByteBuffer.h.

operator>>() [12/12]

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

inline

Definition at line 353 of file ByteBuffer.h.

operator[]() [1/2]

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

inline

Definition at line 411 of file ByteBuffer.h.

Here is the call graph for this function:

operator[]() [2/2]

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

inline

Definition at line 418 of file ByteBuffer.h.

Here is the call graph for this function:

PackUInt64()

static size_t ByteBuffer::PackUInt64 ( uint64  value, uint8 *  mask, uint8 *  result  )

inlinestatic

Definition at line 635 of file ByteBuffer.h.

print_storage()

void ByteBuffer::print_storage

(

)

const

Definition at line 146 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 121 of file ByteBuffer.cpp.

Here is the call graph for this function:

put() [2/2]

template<typename T >

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

inline

Definition at line 246 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 130 of file ByteBuffer.cpp.

Here is the call graph for this function:

read() [1/5]

template<typename T >

T ByteBuffer::read ( )

inline

Definition at line 469 of file ByteBuffer.h.

Here is the caller graph for this function:

read() [2/5]

template<typename T >

T ByteBuffer::read ( size_t  pos ) const

inline

Definition at line 478 of file ByteBuffer.h.

Here is the call graph for this function:

read() [3/5]

template<size_t Size>

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

inline

Definition at line 510 of file ByteBuffer.h.

read() [4/5]

template<typename T >

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

inline

Definition at line 489 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 499 of file ByteBuffer.h.

Here is the call graph for this function:

read_skip() [1/4]

template<typename T >

void ByteBuffer::read_skip ( )

inline

Definition at line 457 of file ByteBuffer.h.

Here is the call graph for this function:

Here is the caller graph for this function:

read_skip() [2/4]

template<>

void ByteBuffer::read_skip ( )

inline

Definition at line 677 of file ByteBuffer.h.

Here is the call graph for this function:

read_skip() [3/4]

template<>

void ByteBuffer::read_skip ( )

inline

Definition at line 683 of file ByteBuffer.h.

read_skip() [4/4]

void ByteBuffer::read_skip ( size_t  skip )

inline

Definition at line 459 of file ByteBuffer.h.

Here is the call graph for this function:

ReadBit()

bool ByteBuffer::ReadBit ( )

inline

Definition at line 185 of file ByteBuffer.h.

Here is the caller graph for this function:

ReadBits()

uint32 ByteBuffer::ReadBits ( int32  bits )

inline

Definition at line 236 of file ByteBuffer.h.

Here is the caller graph for this function:

ReadCString()

std::string_view ByteBuffer::ReadCString

(

bool

requireValidUtf8 = true

)

Definition at line 58 of file ByteBuffer.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

ReadPackedUInt64() [1/2]

void ByteBuffer::ReadPackedUInt64 ( uint64 &  guid )

inline

Definition at line 515 of file ByteBuffer.h.

ReadPackedUInt64() [2/2]

void ByteBuffer::ReadPackedUInt64 ( uint8  mask, uint64 &  value  )

inline

Definition at line 521 of file ByteBuffer.h.

ReadString()

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

Definition at line 78 of file ByteBuffer.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

reserve()

void ByteBuffer::reserve ( size_t  ressize )

inline

Definition at line 576 of file ByteBuffer.h.

Here is the call graph for this function:

Here is the caller graph for this function:

ResetBitPos()

void ByteBuffer::ResetBitPos ( )

inline

Definition at line 160 of file ByteBuffer.h.

Here is the caller graph for this function:

resize()

void ByteBuffer::resize ( size_t  newsize )

inline

Definition at line 569 of file ByteBuffer.h.

Here is the call graph for this function:

Here is the caller graph for this function:

rfinish()

void ByteBuffer::rfinish ( )

inline

Definition at line 433 of file ByteBuffer.h.

Here is the caller graph for this function:

rpos() [1/2]

size_t ByteBuffer::rpos ( ) const

inline

Definition at line 425 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 427 of file ByteBuffer.h.

shrink_to_fit()

void ByteBuffer::shrink_to_fit ( )

inline

Definition at line 582 of file ByteBuffer.h.

size()

size_t ByteBuffer::size ( ) const

inline

Definition at line 566 of file ByteBuffer.h.

Here is the caller graph for this function:

textlike()

void ByteBuffer::textlike

(

)

const

Definition at line 160 of file ByteBuffer.cpp.

Here is the call graph for this function:

wpos() [1/2]

size_t ByteBuffer::wpos ( ) const

inline

Definition at line 438 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 440 of file ByteBuffer.h.

WriteBit()

bool ByteBuffer::WriteBit ( bool  bit )

inline

Definition at line 169 of file ByteBuffer.h.

Here is the caller graph for this function:

WriteBits()

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

inline

Definition at line 197 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 542 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 530 of file ByteBuffer.h.

Here is the caller graph for this function:

WriteString() [3/3]

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

inline

Definition at line 536 of file ByteBuffer.h.

Member Data Documentation

_bitpos

uint8 ByteBuffer::_bitpos

protected

Definition at line 665 of file ByteBuffer.h.

_curbitval

uint8 ByteBuffer::_curbitval

protected

Definition at line 666 of file ByteBuffer.h.

_rpos

size_t ByteBuffer::_rpos

protected

Definition at line 664 of file ByteBuffer.h.

_storage

std::vector<uint8> ByteBuffer::_storage

protected

Definition at line 667 of file ByteBuffer.h.

_wpos

size_t ByteBuffer::_wpos

protected

Definition at line 664 of file ByteBuffer.h.

DEFAULT_SIZE

constexpr size_t ByteBuffer::DEFAULT_SIZE = 0x1000

staticconstexpr

Definition at line 58 of file ByteBuffer.h.

InitialBitPos

constexpr uint8 ByteBuffer::InitialBitPos = 8

staticconstexpr

Definition at line 59 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