aboutsummaryrefslogtreecommitdiffstats
path: root/contrib/libs/poco/Foundation/include/Poco/Event.h
blob: ecc4e78a0feba185acd3014cb8e61ba0d67ffc79 (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
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
// 
// Event.h 
// 
// Library: Foundation 
// Package: Threading 
// Module:  Event 
// 
// Definition of the Event class. 
// 
// Copyright (c) 2004-2006, Applied Informatics Software Engineering GmbH. 
// and Contributors. 
// 
// SPDX-License-Identifier:	BSL-1.0 
// 
 
 
#ifndef Foundation_Event_INCLUDED 
#define Foundation_Event_INCLUDED 
 
 
#include "Poco/Foundation.h" 
#include "Poco/Exception.h" 
 
 
#if defined(POCO_OS_FAMILY_WINDOWS) 
#include "Poco/Event_WIN32.h" 
#elif defined(POCO_VXWORKS) 
#include "Poco/Event_VX.h" 
#else 
#include "Poco/Event_POSIX.h" 
#endif 
 
 
namespace Poco { 
 
 
class Foundation_API Event: private EventImpl 
	/// An Event is a synchronization object that 
	/// allows one thread to signal one or more 
	/// other threads that a certain event 
	/// has happened. 
	/// Usually, one thread signals an event, 
	/// while one or more other threads wait 
	/// for an event to become signalled. 
{ 
public: 
	Event(bool autoReset = true); 
		/// Creates the event. If autoReset is true, 
		/// the event is automatically reset after 
		/// a wait() successfully returns. 
		 
	~Event(); 
		/// Destroys the event. 
 
	void set(); 
		/// Signals the event. If autoReset is true, 
		/// only one thread waiting for the event  
		/// can resume execution. 
		/// If autoReset is false, all waiting threads 
		/// can resume execution. 
 
	void wait(); 
		/// Waits for the event to become signalled. 
 
	void wait(long milliseconds); 
		/// Waits for the event to become signalled. 
		/// Throws a TimeoutException if the event 
		/// does not become signalled within the specified 
		/// time interval. 
 
	bool tryWait(long milliseconds); 
		/// Waits for the event to become signalled. 
		/// Returns true if the event 
		/// became signalled within the specified 
		/// time interval, false otherwise. 
 
	void reset(); 
		/// Resets the event to unsignalled state. 
	 
private: 
	Event(const Event&); 
	Event& operator = (const Event&); 
}; 
 
 
// 
// inlines 
// 
inline void Event::set() 
{ 
	setImpl(); 
} 
 
 
inline void Event::wait() 
{ 
	waitImpl(); 
} 
 
 
inline void Event::wait(long milliseconds) 
{ 
	if (!waitImpl(milliseconds)) 
		throw TimeoutException(); 
} 
 
 
inline bool Event::tryWait(long milliseconds) 
{ 
	return waitImpl(milliseconds); 
} 
 
 
inline void Event::reset() 
{ 
	resetImpl(); 
} 
 
 
} // namespace Poco 
 
 
#endif // Foundation_Event_INCLUDED