MsgPack::Header Class Reference

MsgPack::Element to represent the header of a dynamical length element. More...

#include <Header.h>

Inheritance diagram for MsgPack::Header:

Public Member Functions
Type	getType () const
	Returns the MsgPack::Type.
uint32_t	getSizeInBytes () const
	Returns the size in bytes this MsgPack::Element takes if completely serialized.
virtual uint32_t	getLength () const
	Returns the content length in bytes.
Public Member Functions inherited from MsgPack::Element
virtual std::unique_ptr< Element >	copy () const =0
	Creates a deep copy of this element.
virtual void	toJSON (std::ostream &stream) const =0
	Writes a human readable JSON-like string into the given stream.
virtual Type	getType () const =0
	Returns the MsgPack::Type.
virtual uint32_t	getSizeInBytes () const
	Returns the size in bytes this MsgPack::Element takes if completely serialized.

Protected Member Functions
int64_t	startSerialize ()
	Returns the initial serializer position in bytes (negative value if there is a header)
int64_t	startDeserialize (uint8_t firstByte)
	Reads in one byte and returns the initial deserializer position in bytes (negative value if there is a header)
std::streamsize	serialize (int64_t &pos, std::basic_streambuf< char > *streamBuffer, std::streamsize bytes)
	Serializes bytes at the given serializer position pos into streamBuffer.
std::streamsize	deserialize (int64_t &pos, std::basic_streambuf< char > *streamBuffer, std::streamsize bytes)
	Deserializes bytes at the given deserializer position pos from streamBuffer.
int64_t	getEndPos () const
	Returns the first invalid (de)serializer position.
virtual int64_t	getHeaderLength () const =0
	Returns the size of the header in bytes.
Protected Member Functions inherited from MsgPack::Element
virtual int64_t	startSerialize ()
	Returns the initial serializer position in bytes (negative value if there is a header)
virtual int64_t	startDeserialize (uint8_t firstByte)=0
	Reads in one byte and returns the initial deserializer position in bytes (negative value if there is a header)
virtual std::streamsize	serialize (int64_t &pos, std::basic_streambuf< char > *streamBuffer, std::streamsize bytes)=0
	Serializes bytes at the given serializer position pos into streamBuffer.
virtual std::streamsize	deserialize (int64_t &pos, std::basic_streambuf< char > *streamBuffer, std::streamsize bytes)
	Deserializes bytes at the given deserializer position pos from streamBuffer.
virtual bool	containerDeserialized ()
	Returns true if the header of a container is deserialized and reserves the necessary space for its element vector.
virtual std::vector< std::unique_ptr< Element > > *	getElementsVector ()
	Returns a raw pointer to the element vector of a container.
virtual int64_t	getEndPos () const =0
	Returns the first invalid (de)serializer position.

Protected Attributes
char	header [5]
	Internal buffer of the header.

Friends
class	Serializer
class	Deserializer

Detailed Description

MsgPack::Element to represent the header of a dynamical length element.

Member Function Documentation

deserialize()

std::streamsize MsgPack::Header::deserialize ( int64_t &  pos, std::basic_streambuf< char > *  streamBuffer, std::streamsize  bytes  )

protectedvirtual

Deserializes bytes at the given deserializer position pos from streamBuffer.

Reimplemented from MsgPack::Element.

getEndPos()

int64_t MsgPack::Header::getEndPos ( ) const

protectedvirtual

Returns the first invalid (de)serializer position.

Implements MsgPack::Element.

Reimplemented in MsgPack::String.

getHeaderLength()

virtual int64_t MsgPack::Header::getHeaderLength ( ) const

protectedpure virtual

Returns the size of the header in bytes.

Implemented in MsgPack::ArrayHeader, MsgPack::MapHeader, MsgPack::Binary, MsgPack::Extended, and MsgPack::String.

getLength()

uint32_t MsgPack::Header::getLength ( ) const

virtual

Returns the content length in bytes.

Reimplemented in MsgPack::ArrayHeader, MsgPack::MapHeader, and MsgPack::Extended.

getSizeInBytes()

uint32_t MsgPack::Header::getSizeInBytes ( ) const

virtual

Returns the size in bytes this MsgPack::Element takes if completely serialized.

Reimplemented from MsgPack::Element.

Reimplemented in MsgPack::Map, and MsgPack::MapHeader.

getType()

Type MsgPack::Header::getType ( ) const

virtual

Returns the MsgPack::Type.

Implements MsgPack::Element.

serialize()

std::streamsize MsgPack::Header::serialize ( int64_t &  pos, std::basic_streambuf< char > *  streamBuffer, std::streamsize  bytes  )

protectedvirtual

Serializes bytes at the given serializer position pos into streamBuffer.

Implements MsgPack::Element.

startDeserialize()

int64_t MsgPack::Header::startDeserialize ( uint8_t  firstByte )

protectedvirtual

Reads in one byte and returns the initial deserializer position in bytes (negative value if there is a header)

Implements MsgPack::Element.

startSerialize()

int64_t MsgPack::Header::startSerialize ( )

protectedvirtual

Returns the initial serializer position in bytes (negative value if there is a header)

Reimplemented from MsgPack::Element.

---

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

• include/Header.h
• src/MsgPack.cpp