gml_SharedMessageRing.h File Reference


Detailed Description

Shared message rings.

#include "gml/base/gml_Types.h"
#include "gml/base/gml_Errors.h"

Go to the source code of this file.


Defines

#define GML_MESSAGERING_OLDEST   0000
 retreive oldest message from queue when reading (default)
#define GML_MESSAGERING_LATEST   0001
 retreive newest message from queue when reading
#define GML_MESSAGERING_BLOCKING   0002
 block when reading messages from queue
#define GML_MESSAGERING_DROP   0004
 drop old messages if queue is full when writing

Typedefs

typedef gml_TMessageRing_ * gml_TMessageRing

Functions

GML_EXTERN_C gml_TError gml_MessageRing_Create (gml_TMessageRing *ring, UInt32 bytes)
GML_EXTERN_C gml_TError gml_MessageRing_Open (gml_TMessageRing *ring, UInt32 name)
GML_EXTERN_C gml_TError gml_MessageRing_Close (gml_TMessageRing ring)
GML_EXTERN_C gml_TError gml_MessageRing_GetName (gml_TMessageRing ring, UInt32 *name)
GML_EXTERN_C gml_TError gml_MessageRing_WriteMessageAcquire (gml_TMessageRing ring, UInt32 flags, UInt32 size, UInt8 **payload)
GML_EXTERN_C gml_TError gml_MessageRing_WriteMessageRelease (gml_TMessageRing ring)
GML_EXTERN_C gml_TError gml_MessageRing_ReadMessageAcquire (gml_TMessageRing ring, UInt32 flags, UInt32 *size, UInt8 **payload)
GML_EXTERN_C gml_TError gml_MessageRing_ReadMessageRelease (gml_TMessageRing ring)

Variables

gml_TError gml_gMessageRing_NoNewMessage
 returned when no new message is available
Generated on Tue Jun 12 14:03:28 2007 for gml by Doxygen 1.5.2.