ByteBuffer Class Reference

#include <ByteBuffer.h>

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 (std::size_t 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
size_t	_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.
size_t	bitwpos (size_t newPos)
template<typename T >
void	read_skip ()
void	read_skip (size_t skip)
template<typename T , typename Underlying = T>
T	read ()
template<typename T , typename Underlying = T>
T	read (size_t pos) const
template<class 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	ReadCString (bool requireValidUtf8=true)
std::string	ReadString (uint32 length, bool requireValidUtf8=true)
uint32	ReadPackedTime ()
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 ()
void	append (const char *src, size_t cnt)
template<class T >
void	append (const T *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	AppendPackedTime (time_t time)
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 61 of file ByteBuffer.h.

Constructor & Destructor Documentation

ByteBuffer() [1/6]

ByteBuffer::ByteBuffer ( )

inline

Definition at line 68 of file ByteBuffer.h.

 : _rpos(0), _wpos(0), _bitpos(InitialBitPos), _curbitval(0)
 {
 _storage.reserve(DEFAULT_SIZE);
 }

ByteBuffer() [2/6]

ByteBuffer::ByteBuffer ( size_t  size, Reserve    )

inline

Definition at line 77 of file ByteBuffer.h.

 : _rpos(0), _wpos(0), _bitpos(InitialBitPos), _curbitval(0)
 {
 _storage.reserve(size);
 }

ByteBuffer() [3/6]

ByteBuffer::ByteBuffer ( size_t  size, Resize    )

inline

Definition at line 82 of file ByteBuffer.h.

 : _rpos(0), _wpos(size), _bitpos(InitialBitPos), _curbitval(0)
 {
 _storage.resize(size);
 }

ByteBuffer() [4/6]

ByteBuffer::ByteBuffer ( ByteBuffer &&  buf )

inlinenoexcept

Definition at line 87 of file ByteBuffer.h.

 : _rpos(buf._rpos), _wpos(buf._wpos),
 _bitpos(buf._bitpos), _curbitval(buf._curbitval), _storage(buf.Move()) { }

ByteBuffer() [5/6]

ByteBuffer::ByteBuffer ( ByteBuffer const &  right )

default

ByteBuffer() [6/6]

ByteBuffer::ByteBuffer

(

MessageBuffer &&

buffer

)

Definition at line 28 of file ByteBuffer.cpp.

 : _rpos(0), _wpos(0), _bitpos(InitialBitPos), _curbitval(0), _storage(buffer.Move())
{
}

~ByteBuffer()

virtual ByteBuffer::~ByteBuffer ( )

virtualdefault

Member Function Documentation

append() [1/6]

void ByteBuffer::append ( ByteBuffer const &  buffer )

inline

Definition at line 572 of file ByteBuffer.h.

 {
 if (!buffer.empty())
 append(buffer.contents(), buffer.size());
 }

Here is the call graph for this function:

append() [2/6]

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

inline

Definition at line 559 of file ByteBuffer.h.

 {
 return append((const uint8 *)src, cnt);
 }

append() [3/6]

template<class T >

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

inline

Definition at line 565 of file ByteBuffer.h.

 {
 return append((const uint8 *)src, cnt * sizeof(T));
 }

append() [4/6]

template<size_t Size>

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

inline

Definition at line 579 of file ByteBuffer.h.

 {
 append(arr.data(), Size);
 }

append() [5/6]

template<typename T >

void ByteBuffer::append ( T  value )

inline

Definition at line 143 of file ByteBuffer.h.

 {
 static_assert(std::is_trivially_copyable<T>::value, "append(T) must be used with trivially copyable types");
 EndianConvert(value);
 append((uint8 *)&value, sizeof(value));
 }

Here is the call graph for this function:

Here is the caller graph for this function:

append() [6/6]

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

Definition at line 110 of file ByteBuffer.cpp.

{
 ASSERT(src, "Attempted to put a NULL-pointer in ByteBuffer (pos: " SZFMTD " size: " SZFMTD ")", _wpos, size());
 ASSERT(cnt, "Attempted to put a zero-sized value in ByteBuffer (pos: " SZFMTD " size: " SZFMTD ")", _wpos, size());
 ASSERT(size() < 10000000);
 
 FlushBits();
 
 size_t const newSize = _wpos + cnt;
 if (_storage.capacity() < newSize) // custom memory allocation rules
 {
 if (newSize < 100)
 _storage.reserve(300);
 else if (newSize < 750)
 _storage.reserve(2500);
 else if (newSize < 6000)
 _storage.reserve(10000);
 else
 _storage.reserve(400000);
 }
 
 if (_storage.size() < newSize)
 _storage.resize(newSize);
 std::memcpy(&_storage[_wpos], src, cnt);
 _wpos = newSize;
}

Here is the call graph for this function:

AppendPackedTime()

void ByteBuffer::AppendPackedTime

(

time_t

time

)

Definition at line 137 of file ByteBuffer.cpp.

{
 tm lt;
 localtime_r(&time, &lt);
 append<uint32>((lt.tm_year - 100) << 24 | lt.tm_mon << 20 | (lt.tm_mday - 1) << 14 | lt.tm_wday << 11 | lt.tm_hour << 6 | lt.tm_min);
}

Here is the caller graph for this function:

AppendPackedUInt64()

void ByteBuffer::AppendPackedUInt64 ( uint64  guid )

inline

Definition at line 594 of file ByteBuffer.h.

 {
 uint8 mask = 0;
 size_t pos = wpos();
 *this << uint8(mask);
 
 uint8 packed[8];
 if (size_t packedSize = PackUInt64(guid, &mask, packed))
 append(packed, packedSize);
 
 put<uint8>(pos, mask);
 }

appendPackXYZ()

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

inline

Definition at line 585 of file ByteBuffer.h.

 {
 uint32 packed = 0;
 packed |= ((int)(x / 0.25f) & 0x7FF);
 packed |= ((int)(y / 0.25f) & 0x7FF) << 11;
 packed |= ((int)(z / 0.25f) & 0x3FF) << 22;
 *this << packed;
 }

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 421 of file ByteBuffer.h.

{ return _wpos * 8 + 8 - _bitpos; }

bitwpos() [2/2]

size_t ByteBuffer::bitwpos ( size_t  newPos )

inline

Definition at line 423 of file ByteBuffer.h.

 {
 _wpos = newPos / 8;
 _bitpos = 8 - (newPos % 8);
 return _wpos * 8 + 8 - _bitpos;
 }

clear()

void ByteBuffer::clear ( )

inline

Definition at line 133 of file ByteBuffer.h.

 {
 _rpos = 0;
 _wpos = 0;
 _bitpos = InitialBitPos;
 _curbitval = 0;
 _storage.clear();
 }

Here is the caller graph for this function:

contents() [1/2]

uint8 * ByteBuffer::contents ( )

inline

Definition at line 524 of file ByteBuffer.h.

 {
 if (_storage.empty())
 throw ByteBufferException();
 return _storage.data();
 }

Here is the caller graph for this function:

contents() [2/2]

uint8 const * ByteBuffer::contents ( ) const

inline

Definition at line 531 of file ByteBuffer.h.

 {
 if (_storage.empty())
 throw ByteBufferException();
 return _storage.data();
 }

empty()

bool ByteBuffer::empty ( ) const

inline

Definition at line 539 of file ByteBuffer.h.

{ return _storage.empty(); }

Here is the caller graph for this function:

FlushBits()

void ByteBuffer::FlushBits ( )

inline

Definition at line 155 of file ByteBuffer.h.

 {
 if (_bitpos == 8)
 return;
 
 _bitpos = 8;
 
 append((uint8 *)&_curbitval, sizeof(uint8));
 _curbitval = 0;
 }

HasUnfinishedBitPack()

bool ByteBuffer::HasUnfinishedBitPack ( ) const

inline

Definition at line 150 of file ByteBuffer.h.

 {
 return _bitpos != 8;
 }

Here is the caller graph for this function:

hexlike()

void ByteBuffer::hexlike

(

)

const

Definition at line 200 of file ByteBuffer.cpp.

{
 if (!sLog->ShouldLog("network", LOG_LEVEL_TRACE)) // optimize disabled trace output
 return;
 
 uint32 j = 1, k = 1;
 
 std::ostringstream o;
 o << "STORAGE_SIZE: " << size();
 
 for (uint32 i = 0; i < size(); ++i)
 {
 char buf[4];
 snprintf(buf, 4, "%2X", read<uint8>(i));
 if ((i == (j * 8)) && ((i != (k * 16))))
 {
 o << "| ";
 ++j;
 }
 else if (i == (k * 16))
 {
 o << "\n";
 ++k;
 ++j;
 }
 
 o << buf;
 }
 o << " ";
 TC_LOG_TRACE("network", "{}", o.str());
}

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 94 of file ByteBuffer.h.

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

operator<<() [1/13]

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

inline

Definition at line 316 of file ByteBuffer.h.

 {
 return operator<<(std::string_view(str ? str : ""));
 }

Here is the call graph for this function:

operator<<() [2/13]

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

inline

Definition at line 297 of file ByteBuffer.h.

 {
 append<double>(value);
 return *this;
 }

operator<<() [3/13]

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

inline

Definition at line 291 of file ByteBuffer.h.

 {
 append<float>(value);
 return *this;
 }

operator<<() [4/13]

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

inline

Definition at line 272 of file ByteBuffer.h.

 {
 append<int16>(value);
 return *this;
 }

operator<<() [5/13]

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

inline

Definition at line 278 of file ByteBuffer.h.

 {
 append<int32>(value);
 return *this;
 }

operator<<() [6/13]

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

inline

Definition at line 284 of file ByteBuffer.h.

 {
 append<int64>(value);
 return *this;
 }

operator<<() [7/13]

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

inline

Definition at line 266 of file ByteBuffer.h.

 {
 append<int8>(value);
 return *this;
 }

operator<<() [8/13]

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

inline

Definition at line 311 of file ByteBuffer.h.

 {
 return operator<<(std::string_view(str));
 }

Here is the call graph for this function:

operator<<() [9/13]

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

inline

Definition at line 303 of file ByteBuffer.h.

 {
 if (size_t len = value.length())
 append(reinterpret_cast<uint8 const*>(value.data()), len);
 append(static_cast<uint8>(0));
 return *this;
 }

operator<<() [10/13]

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

inline

Definition at line 247 of file ByteBuffer.h.

 {
 append<uint16>(value);
 return *this;
 }

operator<<() [11/13]

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

inline

Definition at line 253 of file ByteBuffer.h.

 {
 append<uint32>(value);
 return *this;
 }

operator<<() [12/13]

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

inline

Definition at line 259 of file ByteBuffer.h.

 {
 append<uint64>(value);
 return *this;
 }

operator<<() [13/13]

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

inline

Definition at line 241 of file ByteBuffer.h.

 {
 append<uint8>(value);
 return *this;
 }

operator=() [1/2]

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

inlinenoexcept

Definition at line 117 of file ByteBuffer.h.

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

operator=() [2/2]

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

inline

Definition at line 103 of file ByteBuffer.h.

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

Here is the caller graph for this function:

operator>>() [1/12]

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

inline

Definition at line 321 of file ByteBuffer.h.

 {
 value = read<char>() > 0 ? true : false;
 return *this;
 }

operator>>() [2/12]

ByteBuffer & ByteBuffer::operator>>

(

double &

value

)

Definition at line 56 of file ByteBuffer.cpp.

{
 value = read<double>();
 if (!std::isfinite(value))
 throw ByteBufferInvalidValueException("double", "infinity");
 return *this;
}

operator>>() [3/12]

ByteBuffer & ByteBuffer::operator>>

(

float &

value

)

Definition at line 48 of file ByteBuffer.cpp.

{
 value = read<float>();
 if (!std::isfinite(value))
 throw ByteBufferInvalidValueException("float", "infinity");
 return *this;
}

operator>>() [4/12]

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

inline

Definition at line 358 of file ByteBuffer.h.

 {
 value = read<int16>();
 return *this;
 }

operator>>() [5/12]

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

inline

Definition at line 364 of file ByteBuffer.h.

 {
 value = read<int32>();
 return *this;
 }

operator>>() [6/12]

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

inline

Definition at line 370 of file ByteBuffer.h.

 {
 value = read<int64>();
 return *this;
 }

operator>>() [7/12]

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

inline

Definition at line 352 of file ByteBuffer.h.

 {
 value = read<int8>();
 return *this;
 }

operator>>() [8/12]

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

inline

Definition at line 379 of file ByteBuffer.h.

 {
 value = ReadCString(true);
 return *this;
 }

operator>>() [9/12]

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

inline

Definition at line 333 of file ByteBuffer.h.

 {
 value = read<uint16>();
 return *this;
 }

operator>>() [10/12]

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

inline

Definition at line 339 of file ByteBuffer.h.

 {
 value = read<uint32>();
 return *this;
 }

operator>>() [11/12]

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

inline

Definition at line 345 of file ByteBuffer.h.

 {
 value = read<uint64>();
 return *this;
 }

operator>>() [12/12]

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

inline

Definition at line 327 of file ByteBuffer.h.

 {
 value = read<uint8>();
 return *this;
 }

operator[]() [1/2]

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

inline

Definition at line 385 of file ByteBuffer.h.

 {
 if (pos >= size())
 throw ByteBufferPositionException(pos, 1, size());
 return _storage[pos];
 }

operator[]() [2/2]

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

inline

Definition at line 392 of file ByteBuffer.h.

 {
 if (pos >= size())
 throw ByteBufferPositionException(pos, 1, size());
 return _storage[pos];
 }

PackUInt64()

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

inlinestatic

Definition at line 607 of file ByteBuffer.h.

 {
 size_t resultSize = 0;
 *mask = 0;
 memset(result, 0, 8);
 
 for (uint8 i = 0; value != 0; ++i)
 {
 if (value & 0xFF)
 {
 *mask |= uint8(1 << i);
 result[resultSize++] = uint8(value & 0xFF);
 }
 
 value >>= 8;
 }
 
 return resultSize;
 }

print_storage()

void ByteBuffer::print_storage

(

)

const

Definition at line 169 of file ByteBuffer.cpp.

{
 if (!sLog->ShouldLog("network", LOG_LEVEL_TRACE)) // optimize disabled trace output
 return;
 
 std::ostringstream o;
 o << "STORAGE_SIZE: " << size();
 for (uint32 i = 0; i < size(); ++i)
 o << read<uint8>(i) << " - ";
 o << " ";
 
 TC_LOG_TRACE("network", "{}", o.str());
}

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 144 of file ByteBuffer.cpp.

{
 ASSERT(pos + cnt <= size(), "Attempted to put value with size: " SZFMTD " in ByteBuffer (pos: " SZFMTD " size: " SZFMTD ")", cnt, pos, size());
 ASSERT(src, "Attempted to put a NULL-pointer in ByteBuffer (pos: " SZFMTD " size: " SZFMTD ")", pos, size());
 ASSERT(cnt, "Attempted to put a zero-sized value in ByteBuffer (pos: " SZFMTD " size: " SZFMTD ")", pos, size());
 
 std::memcpy(&_storage[pos], src, cnt);
}

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 220 of file ByteBuffer.h.

 {
 static_assert(std::is_trivially_copyable<T>::value, "put(size_t, T) must be used with trivially copyable types");
 EndianConvert(value);
 put(pos, (uint8 *)&value, sizeof(value));
 }

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 153 of file ByteBuffer.cpp.

{
 ASSERT(pos + bitCount <= size() * 8, "Attempted to put %u bits in ByteBuffer (bitpos: " SZFMTD " size: " SZFMTD ")", bitCount, pos, size());
 ASSERT(bitCount, "Attempted to put a zero bits in ByteBuffer");
 
 for (uint32 i = 0; i < bitCount; ++i)
 {
 std::size_t wp = (pos + i) / 8;
 std::size_t bit = (pos + i) % 8;
 if ((value >> (bitCount - i - 1)) & 1)
 _storage[wp] |= 1 << (7 - bit);
 else
 _storage[wp] &= ~(1 << (7 - bit));
 }
}

Here is the call graph for this function:

read() [1/5]

template<typename T , typename Underlying = T>

T ByteBuffer::read ( )

inline

Definition at line 443 of file ByteBuffer.h.

 {
 ResetBitPos();
 T r = read<T, Underlying>(_rpos);
 _rpos += sizeof(Underlying);
 return r;
 }

Here is the caller graph for this function:

read() [2/5]

template<typename T , typename Underlying = T>

T ByteBuffer::read ( size_t  pos ) const

inline

Definition at line 452 of file ByteBuffer.h.

 {
 if (pos + sizeof(Underlying) > size())
 throw ByteBufferPositionException(pos, sizeof(Underlying), size());
 Underlying val;
 std::memcpy(&val, &_storage[pos], sizeof(Underlying));
 EndianConvert(val);
 return static_cast<T>(val);
 }

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 480 of file ByteBuffer.h.

 {
 read(arr.data(), Size);
 }

read() [4/5]

template<class T >

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

inline

Definition at line 463 of file ByteBuffer.h.

 {
 static_assert(std::is_trivially_copyable<T>::value, "read(T*, size_t) must be used with trivially copyable types");
 return read(reinterpret_cast<uint8*>(dest), count * sizeof(T));
 }

read() [5/5]

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

inline

Definition at line 469 of file ByteBuffer.h.

 {
 if (_rpos + len > size())
 throw ByteBufferPositionException(_rpos, len, size());
 
 ResetBitPos();
 std::memcpy(dest, &_storage[_rpos], len);
 _rpos += len;
 }

read_skip() [1/4]

template<typename T >

void ByteBuffer::read_skip ( )

inline

Definition at line 431 of file ByteBuffer.h.

{ read_skip(sizeof(T)); }

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 652 of file ByteBuffer.h.

{
 std::string temp;
 *this >> temp;
}

read_skip() [3/4]

template<>

void ByteBuffer::read_skip ( )

inline

Definition at line 659 of file ByteBuffer.h.

{
 read_skip<char*>();
}

read_skip() [4/4]

void ByteBuffer::read_skip ( size_t  skip )

inline

Definition at line 433 of file ByteBuffer.h.

 {
 if (_rpos + skip > size())
 throw ByteBufferPositionException(_rpos, skip, size());
 
 ResetBitPos();
 _rpos += skip;
 }

ReadBit()

bool ByteBuffer::ReadBit ( )

inline

Definition at line 191 of file ByteBuffer.h.

 {
 ++_bitpos;
 if (_bitpos > 7)
 {
 _curbitval = read<uint8>();
 _bitpos = 0;
 }
 
 return ((_curbitval >> (7-_bitpos)) & 1) != 0;
 }

Here is the caller graph for this function:

ReadBits()

uint32 ByteBuffer::ReadBits ( int32  bits )

inline

Definition at line 209 of file ByteBuffer.h.

 {
 uint32 value = 0;
 for (int32 i = bits - 1; i >= 0; --i)
 if (ReadBit())
 value |= (1 << (i));
 
 return value;
 }

Here is the caller graph for this function:

ReadCString()

std::string ByteBuffer::ReadCString

(

bool

requireValidUtf8 = true

)

Definition at line 64 of file ByteBuffer.cpp.

{
 std::string value;
 while (rpos() < size()) // prevent crash at wrong string format in packet
 {
 char c = read<char>();
 if (c == 0)
 break;
 value += c;
 }
 if (requireValidUtf8 && !utf8::is_valid(value.begin(), value.end()))
 throw ByteBufferInvalidValueException("string", value.c_str());
 return value;
}

Here is the call graph for this function:

ReadPackedTime()

uint32 ByteBuffer::ReadPackedTime

(

)

Definition at line 95 of file ByteBuffer.cpp.

{
 uint32 packedDate = read<uint32>();
 tm lt = tm();
 
 lt.tm_min = packedDate & 0x3F;
 lt.tm_hour = (packedDate >> 6) & 0x1F;
 //lt.tm_wday = (packedDate >> 11) & 7;
 lt.tm_mday = ((packedDate >> 14) & 0x3F) + 1;
 lt.tm_mon = (packedDate >> 20) & 0xF;
 lt.tm_year = ((packedDate >> 24) & 0x1F) + 100;
 
 return uint32(mktime(&lt));
}

Here is the caller graph for this function:

ReadPackedUInt64() [1/2]

void ByteBuffer::ReadPackedUInt64 ( uint64 &  guid )

inline

Definition at line 485 of file ByteBuffer.h.

 {
 guid = 0;
 ReadPackedUInt64(read<uint8>(), guid);
 }

ReadPackedUInt64() [2/2]

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

inline

Definition at line 491 of file ByteBuffer.h.

 {
 for (uint32 i = 0; i < 8; ++i)
 if (mask & (uint8(1) << i))
 value |= (uint64(read<uint8>()) << (i * 8));
 }

ReadString()

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

Definition at line 79 of file ByteBuffer.cpp.

{
 if (_rpos + length > size())
 throw ByteBufferPositionException(_rpos, length, size());
 
 ResetBitPos();
 if (!length)
 return std::string();
 
 std::string value(reinterpret_cast<char const*>(&_storage[_rpos]), length);
 _rpos += length;
 if (requireValidUtf8 && !utf8::is_valid(value.begin(), value.end()))
 throw ByteBufferInvalidValueException("string", value.c_str());
 return value;
}

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 548 of file ByteBuffer.h.

 {
 if (ressize > size())
 _storage.reserve(ressize);
 }

Here is the caller graph for this function:

ResetBitPos()

void ByteBuffer::ResetBitPos ( )

inline

Definition at line 166 of file ByteBuffer.h.

 {
 if (_bitpos > 7)
 return;
 
 _bitpos = 8;
 _curbitval = 0;
 }

Here is the caller graph for this function:

resize()

void ByteBuffer::resize ( size_t  newsize )

inline

Definition at line 541 of file ByteBuffer.h.

 {
 _storage.resize(newsize, 0);
 _rpos = 0;
 _wpos = size();
 }

Here is the caller graph for this function:

rfinish()

void ByteBuffer::rfinish ( )

inline

Definition at line 407 of file ByteBuffer.h.

 {
 _rpos = wpos();
 }

Here is the caller graph for this function:

rpos() [1/2]

size_t ByteBuffer::rpos ( ) const

inline

Definition at line 399 of file ByteBuffer.h.

{ return _rpos; }

Here is the caller graph for this function:

rpos() [2/2]

size_t ByteBuffer::rpos ( size_t  rpos_ )

inline

Definition at line 401 of file ByteBuffer.h.

 {
 _rpos = rpos_;
 return _rpos;
 }

shrink_to_fit()

void ByteBuffer::shrink_to_fit ( )

inline

Definition at line 554 of file ByteBuffer.h.

 {
 _storage.shrink_to_fit();
 }

size()

size_t ByteBuffer::size ( ) const

inline

Definition at line 538 of file ByteBuffer.h.

{ return _storage.size(); }

Here is the caller graph for this function:

textlike()

void ByteBuffer::textlike

(

)

const

Definition at line 183 of file ByteBuffer.cpp.

{
 if (!sLog->ShouldLog("network", LOG_LEVEL_TRACE)) // optimize disabled trace output
 return;
 
 std::ostringstream o;
 o << "STORAGE_SIZE: " << size();
 for (uint32 i = 0; i < size(); ++i)
 {
 char buf[2];
 snprintf(buf, 2, "%c", read<uint8>(i));
 o << buf;
 }
 o << " ";
 TC_LOG_TRACE("network", "{}", o.str());
}

Here is the call graph for this function:

wpos() [1/2]

size_t ByteBuffer::wpos ( ) const

inline

Definition at line 412 of file ByteBuffer.h.

{ return _wpos; }

Here is the caller graph for this function:

wpos() [2/2]

size_t ByteBuffer::wpos ( size_t  wpos_ )

inline

Definition at line 414 of file ByteBuffer.h.

 {
 _wpos = wpos_;
 return _wpos;
 }

WriteBit()

bool ByteBuffer::WriteBit ( bool  bit )

inline

Definition at line 175 of file ByteBuffer.h.

 {
 --_bitpos;
 if (bit)
 _curbitval |= (1 << (_bitpos));
 
 if (_bitpos == 0)
 {
 _bitpos = 8;
 append((uint8 *)&_curbitval, sizeof(_curbitval));
 _curbitval = 0;
 }
 
 return bit;
 }

Here is the caller graph for this function:

WriteBits()

void ByteBuffer::WriteBits ( std::size_t  value, int32  bits  )

inline

Definition at line 203 of file ByteBuffer.h.

 {
 for (int32 i = bits - 1; i >= 0; --i)
 WriteBit((value >> i) & 1);
 }

Here is the caller graph for this function:

WriteString() [1/3]

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

inline

Definition at line 512 of file ByteBuffer.h.

 {
 if (len)
 append(str, len);
 }

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 500 of file ByteBuffer.h.

 {
 if (size_t len = str.length())
 append(str.c_str(), len);
 }

Here is the caller graph for this function:

WriteString() [3/3]

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

inline

Definition at line 506 of file ByteBuffer.h.

 {
 if (size_t len = str.length())
 append(str.data(), len);
 }

Member Data Documentation

_bitpos

size_t ByteBuffer::_bitpos

protected

Definition at line 638 of file ByteBuffer.h.

_curbitval

uint8 ByteBuffer::_curbitval

protected

Definition at line 639 of file ByteBuffer.h.

_rpos

size_t ByteBuffer::_rpos

protected

Definition at line 638 of file ByteBuffer.h.

_storage

std::vector<uint8> ByteBuffer::_storage

protected

Definition at line 640 of file ByteBuffer.h.

_wpos

size_t ByteBuffer::_wpos

protected

Definition at line 638 of file ByteBuffer.h.

DEFAULT_SIZE

constexpr size_t ByteBuffer::DEFAULT_SIZE = 0x1000

staticconstexpr

Definition at line 64 of file ByteBuffer.h.

InitialBitPos

constexpr uint8 ByteBuffer::InitialBitPos = 8

staticconstexpr

Definition at line 65 of file ByteBuffer.h.

---

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

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