vl_msgpack.c File Reference

#include "vl_msgpack.h"
#include <string.h>

Include dependency graph for vl_msgpack.c:

Data Structures
struct	vl_msgpack_element
union	vl_msgpack_element.payload
struct	vl_msgpack_element.payload.mapBranch
struct	vl_msgpack_element.payload.arrayBranch
struct	vl_msgpack_element.payload.leaf

Functions
vl_hash	vl_HashMsgPackKey (const void *data, vl_memsize_t size)
void	vl_MsgPackFreeChildren (vl_msgpack *pack, vl_msgpack_iter iter)
vl_msgpack_iter	vlMsgPackInsert (vl_msgpack *pack, vl_msgpack_type type, vl_msgpack_iter parent, const void *keyPtr, vl_memsize_t keyLen, const void *dataPtr, vl_memsize_t dataLen)
vl_msgpack_element *	vl_MsgPackInitNode (vl_msgpack *pack, vl_msgpack_iter nodeIter, vl_msgpack_type type, vl_int8_t extType, vl_msgpack_iter parent, const void *dataPtr, vl_memsize_t dataLen)
void	vlMsgPackInit (vl_msgpack *pack)
	Initializes the specified MessagePack DOM.
void	vlMsgPackFree (vl_msgpack *pack)
	Frees the specified MessagePack DOM.
vl_msgpack *	vlMsgPackNew ()
	Allocates and initializes a MessagePack DOM.
void	vlMsgPackDelete (vl_msgpack *pack)
	Deletes the specified MessagePack DOM.
void	vlMsgPackClear (vl_msgpack *pack)
	Clears the MessagePack DOM, resetting it for reuse.
vl_msgpack *	vlMsgPackClone (vl_msgpack *src, vl_msgpack *dest)
	Clones the specified MessagePack DOM to another.
vl_msgpack_iter	vlMsgPackParent (vl_msgpack *pack, vl_msgpack_iter iter)
	Retrieves the parent node of a given node in the MessagePack DOM.
vl_dsidx_t	vlMsgPackTotalChildren (vl_msgpack *pack, vl_msgpack_iter iter)
	Retrieves the total number of children of a given node.
vl_msgpack_iter	vlMsgPackFirstChild (vl_msgpack *pack, vl_msgpack_iter iter)
	Retrieves the first child of a given node.
vl_msgpack_iter	vlMsgPackNextSibling (vl_msgpack *pack, vl_msgpack_iter iter)
	Retrieves the next sibling of a given node.
vl_msgpack_iter	vlMsgPackPrevSibling (vl_msgpack *pack, vl_msgpack_iter iter)
	Retrieves the previous sibling of a given node.
vl_msgpack_type	vlMsgPackType (vl_msgpack *pack, vl_msgpack_iter iter)
	Retrieves the type of a given node in the MessagePack DOM.
vl_int8_t	vlMsgPackExtType (vl_msgpack *pack, vl_msgpack_iter iter)
	Retrieves the extension type of a MessagePack EXT node.
vl_msgpack_iter	vlMsgPackInsertExt (vl_msgpack *pack, vl_msgpack_type type, vl_int8_t extType, vl_msgpack_iter parent, const void *keyPtr, vl_memsize_t keyLen, const void *dataPtr, vl_memsize_t dataLen)
	Inserts a new element into the MessagePack DOM with an extended type.
void	vlMsgPackRemove (vl_msgpack *pack, vl_msgpack_iter iter)
	Removes an element from the MessagePack DOM.
vl_msgpack_iter	vlMsgPackFindChild (vl_msgpack *pack, vl_msgpack_iter parent, const void *keyPtr, vl_memsize_t keyLen)
	Finds a child element by key.
vl_msgpack_iter	vlMsgPackFindChildIndexed (vl_msgpack *pack, vl_msgpack_iter parent, vl_dsidx_t index)
	Finds a child element by index.
const vl_transient *	vlMsgPackSampleKey (vl_msgpack *pack, vl_msgpack_iter iter, vl_memsize_t *size)
	Retrieves the key associated with an element.
vl_transient *	vlMsgPackSampleValue (vl_msgpack *pack, vl_msgpack_iter iter, vl_memsize_t *size)
	Retrieves the value associated with an element.

---

Data Structure Documentation

vl_msgpack_element

struct vl_msgpack_element

Collaboration diagram for vl_msgpack_element:

Data Fields
vl_int8_t	extType
vl_msgpack_iter	nextSibling
vl_msgpack_iter	parent
union vl_msgpack_element.payload	payload
vl_msgpack_iter	prevSibling
vl_msgpack_type	type

vl_msgpack_element.payload

union vl_msgpack_element.payload

Collaboration diagram for vl_msgpack_element.payload:

Data Fields
struct vl_msgpack_element.payload.arrayBranch	arrayBranch
struct vl_msgpack_element.payload.leaf	leaf
struct vl_msgpack_element.payload.mapBranch	mapBranch

vl_msgpack_element.payload.mapBranch

struct vl_msgpack_element.payload.mapBranch

Collaboration diagram for vl_msgpack_element.payload.mapBranch:

Data Fields
vl_msgpack_iter	firstChild
vl_msgpack_iter	lastChild
vl_dsidx_t	totalChildren

vl_msgpack_element.payload.arrayBranch

struct vl_msgpack_element.payload.arrayBranch

Collaboration diagram for vl_msgpack_element.payload.arrayBranch:

Data Fields
vl_arena_ptr	array
vl_dsidx_t	arrayLength

vl_msgpack_element.payload.leaf

struct vl_msgpack_element.payload.leaf

Collaboration diagram for vl_msgpack_element.payload.leaf:

Data Fields
vl_arena_ptr	value

Function Documentation

vl_HashMsgPackKey()

vl_hash vl_HashMsgPackKey	(	const void *	data,
		vl_memsize_t	size )

Here is the call graph for this function:

Here is the caller graph for this function:

vl_MsgPackFreeChildren()

void vl_MsgPackFreeChildren	(	vl_msgpack *	pack,
		vl_msgpack_iter	iter )

Here is the call graph for this function:

Here is the caller graph for this function:

vl_MsgPackInitNode()

vl_msgpack_element * vl_MsgPackInitNode	(	vl_msgpack *	pack,
		vl_msgpack_iter	nodeIter,
		vl_msgpack_type	type,
		vl_int8_t	extType,
		vl_msgpack_iter	parent,
		const void *	dataPtr,
		vl_memsize_t	dataLen )

Here is the call graph for this function:

Here is the caller graph for this function:

vlMsgPackClear()

void vlMsgPackClear

(

vl_msgpack *

pack

)

Clears the MessagePack DOM, resetting it for reuse.

This function resets the MessagePack DOM instance without deallocating memory. Previously allocated memory remains available for reuse, improving performance when repeatedly decoding into the same structure.

Parameters

pack	The MessagePack DOM instance to clear.

Here is the call graph for this function:

vlMsgPackClone()

vl_msgpack * vlMsgPackClone	(	vl_msgpack *	src,
		vl_msgpack *	dest )

Clones the specified MessagePack DOM to another.

Clones the entirety of the src MessagePack to the dest MessagePack.

The 'src' DOM must be non-null and initialized. The 'dest' DOM may be null, but if it is not null it must be initialized.

If the 'dest' table pointer is null, a new DOM is created via vlMsgPackNew.

See also

vlMsgPackNew

Parameters

src	source DOM pointer
dest	destination DOM pointer

Returns

pointer to the MessagePack that was copied to or created.

Here is the call graph for this function:

vlMsgPackDelete()

void vlMsgPackDelete

(

vl_msgpack *

pack

)

Deletes the specified MessagePack DOM.

The specified MessagePack must have been initialized via vlMsgPackNew before calling this function.

See also

vlMsgPackNew

Parameters

pack	pointer to DOM

Here is the call graph for this function:

vlMsgPackExtType()

vl_int8_t vlMsgPackExtType	(	vl_msgpack *	pack,
		vl_msgpack_iter	iter )

Retrieves the extension type of a MessagePack EXT node.

Parameters

pack	The MessagePack DOM instance.
iter	The iterator pointing to the current node.

Returns

The extension type value, or an undefined result if the node is not an EXT type.

Here is the call graph for this function:

Here is the caller graph for this function:

vlMsgPackFindChild()

vl_msgpack_iter vlMsgPackFindChild	(	vl_msgpack *	pack,
		vl_msgpack_iter	parent,
		const void *	key,
		vl_memsize_t	keyLen )

Finds a child element by key.

This function searches for a child under the given parent node with a matching key.

Parameters

pack	The MessagePack DOM instance.
parent	The parent node to search in.
key	Pointer to the key data.
keyLen	Length of the key.

Returns

An iterator to the matching child or an invalid iterator if not found.

Here is the call graph for this function:

vlMsgPackFindChildIndexed()

vl_msgpack_iter vlMsgPackFindChildIndexed	(	vl_msgpack *	pack,
		vl_msgpack_iter	iter,
		vl_dsidx_t	idx )

Finds a child element by index.

This function retrieves the indexed child from a parent container. The parent must be an array.

Parameters

pack	The MessagePack DOM instance.
iter	The parent node.
idx	The zero-based index of the child.

Returns

An iterator to the indexed child or an invalid iterator if out of bounds.

Here is the call graph for this function:

Here is the caller graph for this function:

vlMsgPackFirstChild()

vl_msgpack_iter vlMsgPackFirstChild	(	vl_msgpack *	pack,
		vl_msgpack_iter	iter )

Retrieves the first child of a given node.

Parameters

pack	The MessagePack DOM instance.
iter	The iterator pointing to the current node.

Returns

An iterator to the first child node, or an invalid iterator if there are no children.

Here is the call graph for this function:

vlMsgPackFree()

void vlMsgPackFree

(

vl_msgpack *

pack

)

Frees the specified MessagePack DOM.

The specified MessagePack must have been initialized via vlMsgPackInit before calling this function.

Parameters

pack	pointer to DOM

Here is the call graph for this function:

Here is the caller graph for this function:

vlMsgPackInit()

void vlMsgPackInit

(

vl_msgpack *

pack

)

Initializes the specified MessagePack DOM.

See also

vlMsgPackInit

Parameters

pack	pointer to DOM

Here is the call graph for this function:

Here is the caller graph for this function:

vlMsgPackInsert()

vl_msgpack_iter vlMsgPackInsert	(	vl_msgpack *	pack,
		vl_msgpack_type	type,
		vl_msgpack_iter	parent,
		const void *	keyPtr,
		vl_memsize_t	keyLen,
		const void *	dataPtr,
		vl_memsize_t	dataLen )

Here is the caller graph for this function:

vlMsgPackInsertExt()

vl_msgpack_iter vlMsgPackInsertExt	(	vl_msgpack *	pack,
		vl_msgpack_type	type,
		vl_int8_t	subType,
		vl_msgpack_iter	parent,
		const void *	keyPtr,
		vl_memsize_t	keyLen,
		const void *	dataPtr,
		vl_memsize_t	dataLen )

Inserts a new element into the MessagePack DOM with an extended type.

This function inserts an element of the specified MessagePack type and optional extended type under a given parent node. The key and value are copied into the internal storage, allowing external memory to be safely freed after insertion.

Parameters

pack	The MessagePack DOM instance.
type	The type of the inserted element.
subType	The extended type (used for MessagePack ext types).
parent	The parent node where the element is inserted.
keyPtr	Pointer to the key data.
keyLen	Length of the key.
dataPtr	Pointer to the value data.
dataLen	Length of the value.

Returns

An iterator to the newly inserted element.

Here is the call graph for this function:

Here is the caller graph for this function:

vlMsgPackNew()

vl_msgpack * vlMsgPackNew

(

)

Allocates and initializes a MessagePack DOM.

The returned pointer is to be deleted via vlMsgPackDelete.

See also

vlMsgPackDelete

Returns

pointer to DOM

Here is the call graph for this function:

Here is the caller graph for this function:

vlMsgPackNextSibling()

vl_msgpack_iter vlMsgPackNextSibling	(	vl_msgpack *	pack,
		vl_msgpack_iter	iter )

Retrieves the next sibling of a given node.

Parameters

pack	The MessagePack DOM instance.
iter	The iterator pointing to the current node.

Returns

An iterator to the next sibling node, or an invalid iterator if there is no next sibling.

Here is the call graph for this function:

vlMsgPackParent()

vl_msgpack_iter vlMsgPackParent	(	vl_msgpack *	pack,
		vl_msgpack_iter	iter )

Retrieves the parent node of a given node in the MessagePack DOM.

Parameters

pack	The MessagePack DOM instance.
iter	The iterator pointing to the current node.

Returns

An iterator to the parent node, or an invalid iterator if the node has no parent.

Here is the call graph for this function:

vlMsgPackPrevSibling()

vl_msgpack_iter vlMsgPackPrevSibling	(	vl_msgpack *	pack,
		vl_msgpack_iter	iter )

Retrieves the previous sibling of a given node.

Parameters

pack	The MessagePack DOM instance.
iter	The iterator pointing to the current node.

Returns

An iterator to the previous sibling node, or an invalid iterator if there is no previous sibling.

Here is the call graph for this function:

vlMsgPackRemove()

void vlMsgPackRemove	(	vl_msgpack *	pack,
		vl_msgpack_iter	iter )

Removes an element from the MessagePack DOM.

This function removes the specified element and all its children from the DOM. Memory may be reused depending on the allocator's behavior.

Parameters

pack	The MessagePack DOM instance.
iter	Iterator pointing to the element to be removed.

Here is the call graph for this function:

Here is the caller graph for this function:

vlMsgPackSampleKey()

const vl_transient * vlMsgPackSampleKey	(	vl_msgpack *	pack,
		vl_msgpack_iter	iter,
		vl_memsize_t *	size )

Retrieves the key associated with an element.

This function returns a pointer to the key data of the given element. The key may move if modifications occur in the DOM, so users should not store this pointer for long-term access.

Parameters

pack	The MessagePack DOM instance.
iter	The element iterator.
size	Pointer to receive the key size (optional, can be NULL).

Returns

A transient pointer to the key data.

Here is the call graph for this function:

Here is the caller graph for this function:

vlMsgPackSampleValue()

vl_transient * vlMsgPackSampleValue	(	vl_msgpack *	pack,
		vl_msgpack_iter	iter,
		vl_memsize_t *	size )

Retrieves the value associated with an element.

This function returns a pointer to the value data of the given element. The value may move if modifications occur in the DOM, so users should not store this pointer for long-term access.

Parameters

pack	The MessagePack DOM instance.
iter	The element iterator.
size	Pointer to receive the value size (optional, can be NULL).

Returns

A transient pointer to the value data.

Here is the call graph for this function:

Here is the caller graph for this function:

vlMsgPackTotalChildren()

vl_dsidx_t vlMsgPackTotalChildren	(	vl_msgpack *	pack,
		vl_msgpack_iter	iter )

Retrieves the total number of children of a given node.

Parameters

pack	The MessagePack DOM instance.
iter	The iterator pointing to the current node.

Returns

The number of child nodes.

Here is the call graph for this function:

vlMsgPackType()

vl_msgpack_type vlMsgPackType	(	vl_msgpack *	pack,
		vl_msgpack_iter	iter )

Retrieves the type of a given node in the MessagePack DOM.

Parameters

pack	The MessagePack DOM instance.
iter	The iterator pointing to the current node.

Returns

The MessagePack type of the node.

Here is the call graph for this function:

Here is the caller graph for this function: