message.h File Reference

Message structure and functions. More...

#include <lwmsg/status.h>
#include <lwmsg/common.h>

Data Structures

struct  LWMsgMessage
 Message structure. More...
 

Macros

#define LWMSG_TAG_INVALID
 Invalid message tag. More...
 
#define LWMSG_MESSAGE_INITIALIZER
 Message static initializer. More...
 

Typedefs

typedef int16_t LWMsgTag
 Message tag. More...
 
typedef uint16_t LWMsgCookie
 Message cookie. More...
 

Functions

void lwmsg_message_init (LWMsgMessage *message)
 Initialize an LWMsgMessage. More...
 

Macro Definition Documentation

#define LWMSG_TAG_INVALID

A message with this tag is invalid and contains no data.

#define LWMSG_MESSAGE_INITIALIZER

An LWMsgMessage structure may be statically initialized with this value in lieu of explicit initialization of the various fields.

Typedef Documentation

typedef int16_t LWMsgTag

Identifies the type of data contained within a message in the context of a particular protocol. Values less than 0 are reserved for internal use by LWMsg.

typedef uint16_t LWMsgCookie

Allows "request" and "response" messages to be correlated when multiple requests might be outstanding simultaneously.

Function Documentation

void lwmsg_message_init ( LWMsgMessage message)

Initializes an LWMsgMessage structure to reasonable default values:

Parameters
messagethe message to initialize