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
typedef enum OSFunctionType	OSFunctionType

Enumerations
enum	OSMessageFlags {   OS_MESSAGE_FLAGS_NONE = 0,   OS_MESSAGE_FLAGS_BLOCKING = 1 << 0,   OS_MESSAGE_FLAGS_HIGH_PRIORITY = 1 << 1 }
enum	OSFunctionType {   OS_FUNCTION_TYPE_HIO_OPEN = 1,   OS_FUNCTION_TYPE_HIO_READ_ASYNC = 2,   OS_FUNCTION_TYPE_HIO_WRITE_ASYNC = 3,   OS_FUNCTION_TYPE_FSA_CMD_ASYNC = 4,   OS_FUNCTION_TYPE_FSA_PR_CMD_ASYNC = 5,   OS_FUNCTION_TYPE_FSA_PR_CMD_ASYNC_NO_ALLOC = 6,   OS_FUNCTION_TYPE_FSA_ATTACH_EVENT = 7,   OS_FUNCTION_TYPE_FS_CMD_ASYNC = 8,   OS_FUNCTION_TYPE_FS_CMD_HANDLER = 9,   OS_FUNCTION_TYPE_FS_ATTACH_EVENT = 10,   OS_FUNCTION_TYPE_FS_STATE_CHANGE_EVENT = 11 }

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	OSReceiveMessage (OSMessageQueue *queue, OSMessage *message, OSMessageFlags flags)
BOOL	OSPeekMessage (OSMessageQueue *queue, OSMessage *message)
OSMessageQueue *	OSGetSystemMessageQueue ()

Detailed Description

---

Data Structure Documentation

OSMessage

struct OSMessage

Definition at line 40 of file messagequeue.h.

Data Fields
void *	message
uint32_t	args[3]

OSMessageQueue

struct OSMessageQueue

Definition at line 51 of file messagequeue.h.

Data Fields
uint32_t	tag
const char *	name
OSThreadQueue	sendQueue
OSThreadQueue	recvQueue
OSMessage *	messages
uint32_t	size
uint32_t	first
uint32_t	used

Macro Definition Documentation

OS_MESSAGE_QUEUE_TAG

#define OS_MESSAGE_QUEUE_TAG   0x6D536751u

Definition at line 49 of file messagequeue.h.

Typedef Documentation

OSMessage

typedef struct OSMessage OSMessage

Definition at line 15 of file messagequeue.h.

OSMessageQueue

typedef struct OSMessageQueue OSMessageQueue

Definition at line 16 of file messagequeue.h.

OSMessageFlags

typedef enum OSMessageFlags OSMessageFlags

OSFunctionType

typedef enum OSFunctionType OSFunctionType

Enumeration Type Documentation

OSMessageFlags

enum OSMessageFlags

Enumerator
OS_MESSAGE_FLAGS_NONE
OS_MESSAGE_FLAGS_BLOCKING
OS_MESSAGE_FLAGS_HIGH_PRIORITY

Definition at line 18 of file messagequeue.h.

OSFunctionType

enum OSFunctionType

Enumerator
OS_FUNCTION_TYPE_HIO_OPEN
OS_FUNCTION_TYPE_HIO_READ_ASYNC
OS_FUNCTION_TYPE_HIO_WRITE_ASYNC
OS_FUNCTION_TYPE_FSA_CMD_ASYNC
OS_FUNCTION_TYPE_FSA_PR_CMD_ASYNC
OS_FUNCTION_TYPE_FSA_PR_CMD_ASYNC_NO_ALLOC
OS_FUNCTION_TYPE_FSA_ATTACH_EVENT
OS_FUNCTION_TYPE_FS_CMD_ASYNC
OS_FUNCTION_TYPE_FS_CMD_HANDLER
OS_FUNCTION_TYPE_FS_ATTACH_EVENT
OS_FUNCTION_TYPE_FS_STATE_CHANGE_EVENT

Definition at line 25 of file messagequeue.h.

Function Documentation

OSInitMessageQueue()

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

OSInitMessageQueueEx()

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

OSSendMessage()

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

OSReceiveMessage()

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

OSPeekMessage()

BOOL OSPeekMessage	(	OSMessageQueue *	queue,
		OSMessage *	message
	)

OSGetSystemMessageQueue()

OSMessageQueue* OSGetSystemMessageQueue

(

)