msg-encoder.h File Reference

#include "msg-decoder.h"

Include dependency graph for msg-encoder.h:

Go to the source code of this file.

Functions
ssize_t	nexusrv_msg_encode (const nexusrv_hw_cfg *hwcfg, uint8_t *buffer, size_t limit, const nexusrv_msg *msg)
	Encode the msg into buffer. More...
int	nexusrv_read_msg (FILE *fp, nexusrv_msg *msg)
	Read the text (human readable) form of Message from fp into msg. More...

Function Documentation

nexusrv_msg_encode()

ssize_t nexusrv_msg_encode	(	const nexusrv_hw_cfg *	hwcfg,
		uint8_t *	buffer,
		size_t	limit,
		const nexusrv_msg *	msg
	)

Encode the msg into buffer.

Parameters

[in]	hwcfg	Specifies the desired HW implementation.
[in,out]	buffer	The buffer that will hold the Message
[in]	limit	Should be set to the number of bytes in buffer
[in]	msg	The Message to encode

Return values

>0	The number of bytes produced on success
-nexus_stream_truncate	if more bytes are required from buffer
-nexus_msg_unsupported	if the msg type is not supported

nexusrv_read_msg()

int nexusrv_read_msg	(	FILE *	fp,
		nexusrv_msg *	msg
	)

Read the text (human readable) form of Message from fp into msg.

Parameters

[in]	fp	FILE pointer
[out]	msg	Parsed Message

Return values

0	Success
-nexus_msg_missing_field	if Message has missing fields
-nexus_msg_unsupported	if Message type is not supported