summaryrefslogtreecommitdiff
path: root/tracker/common/CompletionEvent.h
blob: 77075f9bb4c21c9570120081146ac144fb324479 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
//========= Copyright Valve Corporation, All rights reserved. ============//
//
// Purpose: Wraps windows WaitForSingleEvent() calls
//
// $NoKeywords: $
//=============================================================================

#ifndef COMPLETIONEVENT_H
#define COMPLETIONEVENT_H
#ifdef _WIN32
#pragma once
#endif

// handle to an event
typedef unsigned long EventHandle_t;

// creates an event
EventHandle_t Event_CreateEvent();

// sets the current thread to wait for either the event to be signalled, or the timeout to occur
void Event_WaitForEvent(EventHandle_t event, unsigned long timeoutMilliseconds);

// set the timeout to this for it to never time out
#define TIMEOUT_INFINITE 0xFFFFFFFF

// signals an event to Activate
// Releases one thread waiting on the event.  
// If the event has no threads waiting on it, the next thread to wait on it will be let right through
void Event_SignalEvent(EventHandle_t event);


#endif // COMPLETIONEVENT_H