msgpack::MsgPack Class Reference

MessagePack packing and unpacking class. More...

#include <QC_MsgPack.dox.h>

Public Member Methods
	constructor (int mode=MSGPACK_SIMPLE_MODE)
	Creates the MsgPack object.
int	getOperationMode ()
	Get module operation mode.
*binary	pack (auto value)
	Pack the passed data.
nothing	setOperationMode (int mode)
	Set operation mode.
auto	unpack (binary value)
	Unpack the passed data.

Detailed Description

MessagePack packing and unpacking class.

MessagePack module packing and unpacking class.

Member Function Documentation

constructor()

msgpack::MsgPack::constructor

(

int

mode = MSGPACK_SIMPLE_MODE

)

Creates the MsgPack object.

Parameters

mode	MsgPack module operation mode

Exceptions

INVALID-MODE

passed operation mode is invalid

getOperationMode()

int msgpack::MsgPack::getOperationMode

(

)

Get module operation mode.

Returns

MsgPack module operation mode

pack()

*binary msgpack::MsgPack::pack

(

auto

value

)

Pack the passed data.

Parameters

value

value to pack

Returns

packed value in MessagePack format

Exceptions

ENCODING-ERROR	encoding error occured during packing
PACK-ERROR	packing failed

Example:

MsgPack mp();
hash example = {"compact": True, "schema": 0};
*binary packed = mp.pack(example);

setOperationMode()

nothing msgpack::MsgPack::setOperationMode

(

int

mode

)

Set operation mode.

Parameters

mode	MsgPack module operation mode

Exceptions

INVALID-MODE

passed operation mode is invalid

Example:

MsgPack mp();
mp.setOperationMode(MSGPACK_QORE_MODE);

unpack()

auto msgpack::MsgPack::unpack

(

binary

value

)

Unpack the passed data.

Parameters

value

data to unpack

Returns

unpacked Qore value

Exceptions

ENCODING-ERROR	encoding error occured during unpacking
INVALID-MODE	passed operation mode is invalid
UNPACK-ERROR	unpacking failed

Example:

MsgPack mp();
hash example = {"compact": True, "schema": 0};
*binary packed = mp.pack(example);
 
# ---
 
auto unpacked = mp.unpack(packed);

---

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

• QC_MsgPack.dox.h