Main Page | Modules | Data Structures | Directories | File List | Data Fields | Globals | Related Pages

messageQueue.h: Basic message queue class
[platform independant portions of code]


Typedefs

typedef _MessageQueue * MessageQueue
typedef _Message * Message
typedef ErrorCode(* MessageDestroyFunction )(Message msg)

Functions

ErrorCode messageQueueCreate (MessageQueue *msgq, uint32 size)
ErrorCode messageQueueSend (MessageQueue mq, Pointer message)
ErrorCode messageQueuePeek (MessageQueue mq, Pointer *message)
ErrorCode messageQueueReceive (MessageQueue mq, Timeout to, Pointer *message)
ErrorCode messageQueueDestroy (MessageQueue *mq)
ErrorCode messageCreate (Message *msg, MessageDestroyFunction destroy, MessageQueue responseQueue, uint32 code, uint32 numArgs,...)
ErrorCode messageGetArgument (Message msg, uint32 num, Pointer *arg)
ErrorCode messageGetArgumentCount (Message msg, uint32 *total)
ErrorCode messageGetArgumentList (Message msg, Pointer *top, uint32 *total)
ErrorCode messageGetCode (Message msg, uint32 *code)
ErrorCode messageRespond (Message source, Message response)
ErrorCode messageDestroy (Message *msg)

Detailed Description

This file defines a interface for working with message queues

Typedef Documentation

typedef struct _Message* Message
 

Definition at line 24 of file messageQueue.h.

typedef ErrorCode(* MessageDestroyFunction)(Message msg)
 

Definition at line 26 of file messageQueue.h.

typedef struct _MessageQueue* MessageQueue
 

Definition at line 23 of file messageQueue.h.


Function Documentation

ErrorCode messageCreate Message msg,
MessageDestroyFunction  destroy,
MessageQueue  responseQueue,
uint32  code,
uint32  numArgs,
  ...
 

TODO: implement below...

ErrorCode messageDestroy Message msg  ) 
 

ErrorCode messageGetArgument Message  msg,
uint32  num,
Pointer arg
 

ErrorCode messageGetArgumentCount Message  msg,
uint32 total
 

ErrorCode messageGetArgumentList Message  msg,
Pointer top,
uint32 total
 

ErrorCode messageGetCode Message  msg,
uint32 code
 

ErrorCode messageQueueCreate MessageQueue msgq,
uint32  size
 

ErrorCode messageQueueDestroy MessageQueue mq  ) 
 

ErrorCode messageQueuePeek MessageQueue  mq,
Pointer message
 

ErrorCode messageQueueReceive MessageQueue  mq,
Timeout  to,
Pointer message
 

ErrorCode messageQueueSend MessageQueue  mq,
Pointer  message
 

ErrorCode messageRespond Message  source,
Message  response
 


Generated on Wed Mar 22 20:36:34 2006 for ndk by  doxygen 1.4.4