MsgPack::Primitive Class Reference

MsgPack::Element to represent one byte primitives like booleans and null. More...

#include <Primitive.h>

Inheritance diagram for MsgPack::Primitive:

Public Member Functions
	Primitive (bool value)
	Initialize from boolean.
std::unique_ptr< Element >	copy () const
	Creates a deep copy of this element.
void	toJSON (std::ostream &stream) const
	Writes a human readable JSON-like string into the given stream.
Type	getType () const
	Returns the MsgPack::Type.
bool	isNull () const
	Returns if type is NIL.
bool	getValue () const
	Returns the boolean value.
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
	Primitive (Type type)
	Internal initialize from type.
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.
int64_t	getEndPos () const
	Returns the first invalid (de)serializer position.
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
uint8_t	type

Friends
class	Serializer
class	Deserializer

Detailed Description

MsgPack::Element to represent one byte primitives like booleans and null.

Member Function Documentation

copy()

std::unique_ptr< Element > MsgPack::Primitive::copy ( ) const

virtual

Creates a deep copy of this element.

Implements MsgPack::Element.

getEndPos()

int64_t MsgPack::Primitive::getEndPos ( ) const

protectedvirtual

Returns the first invalid (de)serializer position.

Implements MsgPack::Element.

getType()

Type MsgPack::Primitive::getType ( ) const

virtual

Returns the MsgPack::Type.

Implements MsgPack::Element.

serialize()

std::streamsize MsgPack::Primitive::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::Primitive::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.

toJSON()

void MsgPack::Primitive::toJSON ( std::ostream &  stream ) const

virtual

Writes a human readable JSON-like string into the given stream.

Implements MsgPack::Element.

Member Data Documentation

type

uint8_t MsgPack::Primitive::type

protected

Internal type field

---

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

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