MGE General C Library - API Documentation v1.8.0
Library of general C functions.
|
Header file for message processing. More...
#include <stdbool.h>
#include <sys/types.h>
#include <libmgec/mge-buffer.h>
#include <libmgec/mge-portability.h>
Go to the source code of this file.
Data Structures | |
struct | mgemessage |
Message object. More... | |
Macros | |
#define | MGEMESSAGE_INIT(a, b) |
mgemessage struct initialiser. More... | |
Functions | |
struct mgemessage * | pull_msg (struct mgebuffer *buf, struct mgemessage *msg) |
Pull a message from a buffer object. More... | |
void | clear_msg (struct mgemessage *msg, const char terminator, const char separator) |
Clear message struct. More... | |
void | print_msg (struct mgemessage *msg) |
Print a message struct. More... | |
void | print_def_msg_values (void) |
Print default values to stdout, for debugging. More... | |
Header file for message processing.
All message manipulation related information.
Released under the GPLv3 only.
SPDX-License-Identifier: GPL-3.0-only
#define MGEMESSAGE_INIT | ( | a, | |
b | |||
) |
mgemessage struct initialiser.
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.
msg | A message object to clear. |
terminator | The message delimitter to use. |
separator | The message element delimitter to use. |
void print_def_msg_values | ( | void | ) |
Print default values to stdout, for debugging.
void print_msg | ( | struct mgemessage * | msg | ) |
Print a message struct.
Useful for debugging.
msg | The message object to print to stdout. |
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.
buf | A buffer object. |
msg | A message object. |