Class Hierarchy   Class Index   Method Index  

CHMevent.h

00001 #ifndef __CHM_EVENT_H__
00002 #define __CHM_EVENT_H__
00003 //---------------------------------------------------------------------------
00004 // Copyright (C) 1997-2007 iNTERFACEWARE Inc. All Rights Reserved
00005 //
00006 // Module: CHMevent
00007 //
00008 // Description: 
00009 //
00010 // A portable syncronization primitive in the style of Win32 Events.
00011 //
00012 // Author: Steven Dodd
00013 // Date:   Jan 28, 2009
00014 // Revision: $Revision: 1.1 $
00015 //
00016 // Last Edit Date: $Date: 2009-01-28 22:04:10 $
00017 // Source: $Source: /home/cvs/cvsroot/CHM/CHMevent.h,v $
00018 //---------------------------------------------------------------------------
00019 
00020 #include <CHM/CHMminCInclude.h>
00021 
00022 CHM_DLL_FUNC(CHMeventCreate)
00023 (
00024    CHMeventHandle* HandleOut,
00025    CHMboolean ManualReset
00026 );
00027 
00028 CHM_DLL_FUNC(CHMeventDestroy)
00029 (
00030    CHMeventHandle Handle
00031 );
00032 
00033 // Only valid for events created with ManualReset = true.  Calling for events
00034 // created with ManualReset = false will lead to undefined behavior.
00035 CHM_DLL_FUNC(CHMeventReset)
00036 (
00037    CHMeventHandle Handle
00038 );
00039 
00040 CHM_DLL_FUNC(CHMeventSignal)
00041 (
00042    CHMeventHandle Handle
00043 );
00044 
00045 CHM_DLL_FUNC(CHMeventWait)
00046 (
00047    CHMeventHandle Handle
00048 );
00049 
00050 CHM_DLL_FUNC(CHMeventWaitWithTimeout)
00051 (
00052    CHMeventHandle Handle,
00053    CHMuint32 TimeoutInMilliseconds,
00054    CHMboolean* SignalledOut
00055 );
00056 
00057 #endif // end of defensive include