message.h File Reference

Thread subsystem II. More...

#include <gctypes.h>

Defines

#define MQ_BOX_NULL   0xffffffff
#define MQ_ERROR_SUCCESSFUL   0
#define MQ_ERROR_TOOMANY   -5
#define MQ_MSG_BLOCK   0
#define MQ_MSG_NOBLOCK   1

Typedefs

typedef u32 mqbox_t
 typedef for the message queue handle
typedef void * mqmsg_t
 typedef for the message pointer

Functions

s32 MQ_Init (mqbox_t *mqbox, u32 count)
 Initializes a message queue.
void MQ_Close (mqbox_t mqbox)
 Closes the message queue and releases all memory.
BOOL MQ_Send (mqbox_t mqbox, mqmsg_t msg, u32 flags)
 Sends a message to the given message queue.
BOOL MQ_Jam (mqbox_t mqbox, mqmsg_t msg, u32 flags)
 Sends a message to the given message queue and jams it in front of the queue.
BOOL MQ_Receive (mqbox_t mqbox, mqmsg_t *msg, u32 flags)
 Sends a message to the given message queue.


Detailed Description

Thread subsystem II.


Function Documentation

void MQ_Close ( mqbox_t  mqbox  ) 

Closes the message queue and releases all memory.

Parameters:
[in] mqbox handle to the mqbox_t structure.
Returns:
none

u32 MQ_Init ( mqbox_t mqbox,
u32  count 
)

Initializes a message queue.

Parameters:
[out] mqbox pointer to the mqbox_t handle.
[in] count maximum number of messages the queue can hold
Returns:
0 on success, <0 on error

BOOL MQ_Jam ( mqbox_t  mqbox,
mqmsg_t  msg,
u32  flags 
)

Sends a message to the given message queue and jams it in front of the queue.

Parameters:
[in] mqbox mqbox_t handle to the message queue
[in] msg message to send
[in] flags message flags (MQ_MSG_BLOCK, MQ_MSG_NOBLOCK)
Returns:
boolean result

BOOL MQ_Receive ( mqbox_t  mqbox,
mqmsg_t msg,
u32  flags 
)

Sends a message to the given message queue.

Parameters:
[in] mqbox mqbox_t handle to the message queue
[in] msg pointer to a mqmsg_t_t-type message to receive.
[in] flags message flags (MQ_MSG_BLOCK, MQ_MSG_NOBLOCK)
Returns:
boolean result

BOOL MQ_Send ( mqbox_t  mqbox,
mqmsg_t  msg,
u32  flags 
)

Sends a message to the given message queue.

Parameters:
[in] mqbox mqbox_t handle to the message queue
[in] msg message to send
[in] flags message flags (MQ_MSG_BLOCK, MQ_MSG_NOBLOCK)
Returns:
boolean result


Generated on Sun Feb 4 18:14:34 2007 for libOGC by  doxygen 1.4.7