message.c File Reference

Message processing functions. More...

#include <errno.h>
#include <stdbool.h>
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include "internal.h"
#include <libmgec/libmgec.h>
#include <libmgec/mge-buffer.h>
#include <libmgec/mge-errno.h>
#include <libmgec/mge-memory.h>
#include <libmgec/mge-message.h>

Include dependency graph for message.c:

Functions
struct mgemessage *	pull_msg (struct mgebuffer *buf, struct mgemessage *msg)
	Pull a message from a buffer object.
void	clear_msg (struct mgemessage *msg, const char terminator, const char separator)
	Clear message struct.
void	print_msg (struct mgemessage *msg)
	Print a message struct.
void	print_def_msg_values (void)
	Print default values to stdout, for debugging.

Variables
static int	args
	Number of arguments in the message.

Detailed Description

Message processing functions.

All message handling support functions.

Author

Copyright (C) 2017-2023, 2025 Mark Grant

Released under the GPLv3 only.
SPDX-License-Identifier: GPL-3.0-only

Version

v1.1.1 ==== 03/04/2025

Function Documentation

clear_msg()

void clear_msg	(	struct mgemessage *	msg,
		const char	terminator,
		const char	separator
	)

Clear message struct.

Free memory allocated to the object and initialise the fields.

Parameters

msg	A message object to clear.
terminator	The message delimitter to use.
separator	The message element delimitter to use.

print_def_msg_values()

void print_def_msg_values

(

void

)

Print default values to stdout, for debugging.

print_msg()

void print_msg

(

struct mgemessage *

msg

)

Print a message struct.

Useful for debugging.

Parameters

msg	The message object to print to stdout.

pull_msg()

struct mgemessage * pull_msg	(	struct mgebuffer *	buf,
		struct mgemessage *	msg
	)

Pull a message from a buffer object.

On error NULL is returned and mge_errno is set.

Parameters

buf	A buffer object.
msg	A message object.

Returns

The resulting message object, partial or complete, or NULL on error.

Variable Documentation

args

int args

static

Number of arguments in the message.