MsgPack::Header representing only the header of a map. More...
#include <ContainerHeader.h>
Inheritance diagram for MsgPack::MapHeader:
Public Member Functions | |
| MapHeader (uint32_t len) | |
| Initialize with len key/value pairs to follow. | |
| 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. | |
| uint32_t | getSizeInBytes () const |
| Returns the size in bytes this MsgPack::Element takes if completely serialized. | |
| uint32_t | getLength () const |
| Returns the count of elements in the container. | |
 Public Member Functions inherited from MsgPack::Header | |
| 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. | |
| 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 | getHeaderLength () const |
| Returns the size of the header in bytes. | |
| Protected Member Functions inherited from MsgPack::Header | |
| 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. | |
Friends | |
| class | Serializer |
| class | Deserializer |
Additional Inherited Members | |
| Protected Attributes inherited from MsgPack::Header | |
| char | header [5] |
| Internal buffer of the header. | |
Detailed Description
MsgPack::Header representing only the header of a map.
Member Function Documentation
◆ copy()
|
virtual |
Creates a deep copy of this element.
Implements MsgPack::Element.
◆ getHeaderLength()
|
protectedvirtual |
Returns the size of the header in bytes.
Implements MsgPack::Header.
◆ getLength()
|
virtual |
Returns the count of elements in the container.
Reimplemented from MsgPack::Header.
◆ getSizeInBytes()
|
virtual |
Returns the size in bytes this MsgPack::Element takes if completely serialized.
Reimplemented from MsgPack::Header.
◆ toJSON()
|
virtual |
Writes a human readable JSON-like string into the given stream.
Implements MsgPack::Element.
The documentation for this class was generated from the following files:
- include/ContainerHeader.h
- src/MsgPack.cpp
