aboutsummaryrefslogtreecommitdiffstats
path: root/contrib/libs/poco/Foundation/include/Poco/NamedEvent.h
blob: 7217f2c94dfe31aebf84c0eadc5b0efb539fb276 (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
// 
// NamedEvent.h 
// 
// Library: Foundation 
// Package: Processes 
// Module:  NamedEvent 
// 
// Definition of the NamedEvent class. 
// 
// Copyright (c) 2004-2006, Applied Informatics Software Engineering GmbH. 
// and Contributors. 
// 
// SPDX-License-Identifier:	BSL-1.0 
// 
 
 
#ifndef Foundation_NamedEvent_INCLUDED 
#define Foundation_NamedEvent_INCLUDED 
 
 
#include "Poco/Foundation.h" 
 
 
#if defined(POCO_OS_FAMILY_WINDOWS) && defined(POCO_WIN32_UTF8) 
#include "Poco/NamedEvent_WIN32U.h" 
#elif defined(POCO_OS_FAMILY_WINDOWS) 
#include "Poco/NamedEvent_WIN32.h" 
#elif POCO_OS == POCO_OS_ANDROID 
#include "Poco/NamedEvent_Android.h" 
#elif defined(POCO_OS_FAMILY_UNIX) 
#include "Poco/NamedEvent_UNIX.h" 
#endif 
 
 
namespace Poco { 
 
 
class Foundation_API NamedEvent: public NamedEventImpl 
	/// An NamedEvent is a global synchronization object 
	/// that allows one process or thread to signal an 
	/// other process or thread that a certain event 
	/// has happened. 
	/// 
	/// Unlike an Event, which itself is the unit of synchronization, 
	/// a NamedEvent refers to a named operating system resource being the 
	/// unit of synchronization. 
	/// In other words, there can be multiple instances of NamedEvent referring 
	/// to the same actual synchronization object. 
	/// 
	/// NamedEvents are always autoresetting. 
	/// 
	/// There should not be more than one instance of NamedEvent for 
	/// a given name in a process. Otherwise, the instances may 
	/// interfere with each other. 
{ 
public: 
	NamedEvent(const std::string& name); 
		/// Creates the event. 
 
	~NamedEvent(); 
		/// Destroys the event. 
 
	void set(); 
		/// Signals the event. 
		/// The one thread or process waiting for the event 
		/// can resume execution. 
 
	void wait(); 
		/// Waits for the event to become signalled. 
 
private: 
	NamedEvent(); 
	NamedEvent(const NamedEvent&); 
	NamedEvent& operator = (const NamedEvent&); 
}; 
 
 
// 
// inlines 
// 
inline void NamedEvent::set() 
{ 
	setImpl(); 
} 
 
 
inline void NamedEvent::wait() 
{ 
	waitImpl(); 
} 
 
 
} // namespace Poco 
 
 
#endif // Foundation_NamedEvent_INCLUDED