gml_CQueue.h

Go to the documentation of this file.
00001 /**
00002  *  @file gml_CQueue.h
00003  *
00004  *    Thread-safe C wrapper for the <gml_TPointerQueue> class.
00005  *
00006  *  Copyright (c) 2004 CLIPS-IMAG
00007  *
00008  *  See the file "gml_LicenseTerms.txt" for information on usage and redistribution
00009  *  of this file, and for a DISCLAIMER OF ALL WARRANTIES.
00010  *
00011  *  Created in December 2004 (JL).
00012  */
00013 #ifndef __GML_CQUEUE__
00014 #define __GML_CQUEUE__
00015 
00016 #include "gml/base/gml_Types.h"
00017 #include "gml/base/gml_Errors.h"
00018 
00019 typedef void* gml_TCQueue;
00020 
00021 GML_EXTERN_C
00022 gml_TError gml_Queue_Init    (gml_TCQueue* queue, UInt32 queueSize, gml_TBoolean dropWhenFull);
00023 
00024 GML_EXTERN_C
00025 void       gml_Queue_Dispose (gml_TCQueue queue);
00026 
00027 GML_EXTERN_C
00028 gml_TError gml_Queue_Push    (gml_TCQueue queue, gml_TPointer  item);
00029 
00030 GML_EXTERN_C
00031 gml_TError gml_Queue_Pop     (gml_TCQueue queue, gml_TPointer *item);
00032 
00033 #endif /* __GML_CQUEUE__ */
00034