MessagePack for C
Classes | Macros | Typedefs | Functions
Streaming deserializer

Classes

struct  msgpack_unpacker
 

Macros

#define MSGPACK_UNPACKER_INIT_BUFFER_SIZE   (64*1024)
 
#define MSGPACK_UNPACKER_RESERVE_SIZE   (32*1024)
 

Typedefs

typedef struct msgpack_unpacker msgpack_unpacker
 

Functions

MSGPACK_DLLEXPORT bool msgpack_unpacker_init (msgpack_unpacker *mpac, size_t initial_buffer_size)
 Initializes a streaming deserializer. More...
 
MSGPACK_DLLEXPORT void msgpack_unpacker_destroy (msgpack_unpacker *mpac)
 Destroys a streaming deserializer initialized by msgpack_unpacker_init(msgpack_unpacker*, size_t). More...
 
MSGPACK_DLLEXPORT msgpack_unpackermsgpack_unpacker_new (size_t initial_buffer_size)
 Creates a streaming deserializer. More...
 
MSGPACK_DLLEXPORT void msgpack_unpacker_free (msgpack_unpacker *mpac)
 Frees a streaming deserializer created by msgpack_unpacker_new(size_t). More...
 
MSGPACK_DLLEXPORT msgpack_unpack_return msgpack_unpacker_next (msgpack_unpacker *mpac, msgpack_unpacked *pac)
 Deserializes one object. More...
 
MSGPACK_DLLEXPORT int msgpack_unpacker_execute (msgpack_unpacker *mpac)
 
MSGPACK_DLLEXPORT msgpack_object msgpack_unpacker_data (msgpack_unpacker *mpac)
 
MSGPACK_DLLEXPORT msgpack_zonemsgpack_unpacker_release_zone (msgpack_unpacker *mpac)
 
MSGPACK_DLLEXPORT void msgpack_unpacker_reset_zone (msgpack_unpacker *mpac)
 
MSGPACK_DLLEXPORT void msgpack_unpacker_reset (msgpack_unpacker *mpac)
 

Detailed Description

Macro Definition Documentation

#define MSGPACK_UNPACKER_INIT_BUFFER_SIZE   (64*1024)
#define MSGPACK_UNPACKER_RESERVE_SIZE   (32*1024)

Typedef Documentation

Function Documentation

MSGPACK_DLLEXPORT msgpack_object msgpack_unpacker_data ( msgpack_unpacker mpac)
MSGPACK_DLLEXPORT void msgpack_unpacker_destroy ( msgpack_unpacker mpac)

Destroys a streaming deserializer initialized by msgpack_unpacker_init(msgpack_unpacker*, size_t).

MSGPACK_DLLEXPORT int msgpack_unpacker_execute ( msgpack_unpacker mpac)
MSGPACK_DLLEXPORT void msgpack_unpacker_free ( msgpack_unpacker mpac)

Frees a streaming deserializer created by msgpack_unpacker_new(size_t).

MSGPACK_DLLEXPORT bool msgpack_unpacker_init ( msgpack_unpacker mpac,
size_t  initial_buffer_size 
)

Initializes a streaming deserializer.

The initialized deserializer must be destroyed by msgpack_unpacker_destroy(msgpack_unpacker*).

MSGPACK_DLLEXPORT msgpack_unpacker* msgpack_unpacker_new ( size_t  initial_buffer_size)

Creates a streaming deserializer.

The created deserializer must be destroyed by msgpack_unpacker_free(msgpack_unpacker*).

MSGPACK_DLLEXPORT msgpack_unpack_return msgpack_unpacker_next ( msgpack_unpacker mpac,
msgpack_unpacked pac 
)

Deserializes one object.

Returns true if it successes. Otherwise false is returned.

Parameters
pacpointer to an initialized msgpack_unpacked object.
MSGPACK_DLLEXPORT msgpack_zone* msgpack_unpacker_release_zone ( msgpack_unpacker mpac)
MSGPACK_DLLEXPORT void msgpack_unpacker_reset ( msgpack_unpacker mpac)
MSGPACK_DLLEXPORT void msgpack_unpacker_reset_zone ( msgpack_unpacker mpac)