Message Queue

Data Structures
struct	OSMessage
struct	OSMessageQueue

Macros
#define	OS_MESSAGE_QUEUE_TAG   0x6D536751u

Typedefs
typedef struct OSMessage	OSMessage
typedef struct OSMessageQueue	OSMessageQueue
typedef enum OSMessageFlags	OSMessageFlags

Enumerations
enum	OSMessageFlags { OS_MESSAGE_QUEUE_BLOCKING = 1 << 0, OS_MESSAGE_QUEUE_HIGH_PRIORITY = 1 << 1 }

Functions
void	OSInitMessageQueue (OSMessageQueue *queue, OSMessage *messages, int32_t size)
void	OSInitMessageQueueEx (OSMessageQueue *queue, OSMessage *messages, int32_t size, const char *name)
BOOL	OSSendMessage (OSMessageQueue *queue, OSMessage *message, OSMessageFlags flags)
BOOL	OSJamMessage (OSMessageQueue *queue, OSMessage *message, OSMessageFlags flags)
BOOL	OSReceiveMessage (OSMessageQueue *queue, OSMessage *message, OSMessageFlags flags)
BOOL	OSPeekMessage (OSMessageQueue *queue, OSMessage *message)
OSMessageQueue *	OSGetSystemMessageQueue ()

Detailed Description

Macro Definition Documentation

#define OS_MESSAGE_QUEUE_TAG   0x6D536751u

Definition at line 32 of file messagequeue.h.

Typedef Documentation

typedef struct OSMessage OSMessage

Definition at line 14 of file messagequeue.h.

typedef enum OSMessageFlags OSMessageFlags

typedef struct OSMessageQueue OSMessageQueue

Definition at line 15 of file messagequeue.h.

Enumeration Type Documentation

enum OSMessageFlags

Enumerator
OS_MESSAGE_QUEUE_BLOCKING
OS_MESSAGE_QUEUE_HIGH_PRIORITY

Definition at line 17 of file messagequeue.h.

Function Documentation

OSMessageQueue* OSGetSystemMessageQueue

(

)

void OSInitMessageQueue	(	OSMessageQueue *	queue,
		OSMessage *	messages,
		int32_t	size
	)

void OSInitMessageQueueEx	(	OSMessageQueue *	queue,
		OSMessage *	messages,
		int32_t	size,
		const char *	name
	)

BOOL OSJamMessage	(	OSMessageQueue *	queue,
		OSMessage *	message,
		OSMessageFlags	flags
	)

BOOL OSPeekMessage	(	OSMessageQueue *	queue,
		OSMessage *	message
	)

BOOL OSReceiveMessage	(	OSMessageQueue *	queue,
		OSMessage *	message,
		OSMessageFlags	flags
	)

BOOL OSSendMessage	(	OSMessageQueue *	queue,
		OSMessage *	message,
		OSMessageFlags	flags
	)