blob: 3545d8be5ed1935fd041aebcfa1dc675dd917b1d (
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
|
//
// NamedMutex.h
//
// Library: Foundation
// Package: Processes
// Module: NamedMutex
//
// Definition of the NamedMutex class.
//
// Copyright (c) 2004-2006, Applied Informatics Software Engineering GmbH.
// and Contributors.
//
// SPDX-License-Identifier: BSL-1.0
//
#ifndef Foundation_NamedMutex_INCLUDED
#define Foundation_NamedMutex_INCLUDED
#include "Poco/Foundation.h"
#include "Poco/ScopedLock.h"
#if defined(POCO_OS_FAMILY_WINDOWS) && defined(POCO_WIN32_UTF8)
#include "Poco/NamedMutex_WIN32U.h"
#elif defined(POCO_OS_FAMILY_WINDOWS)
#include "Poco/NamedMutex_WIN32.h"
#elif POCO_OS == POCO_OS_ANDROID
#include "Poco/NamedMutex_Android.h"
#elif defined(POCO_OS_FAMILY_UNIX)
#include "Poco/NamedMutex_UNIX.h"
#endif
namespace Poco {
class Foundation_API NamedMutex: private NamedMutexImpl
/// A NamedMutex (mutual exclusion) is a global synchronization
/// mechanism used to control access to a shared resource
/// in a concurrent (multi process) scenario.
/// Using the ScopedLock class is the preferred way to automatically
/// lock and unlock a mutex.
///
/// Unlike a Mutex or a FastMutex, which itself is the unit of synchronization,
/// a NamedMutex refers to a named operating system resource being the
/// unit of synchronization.
/// In other words, there can be multiple instances of NamedMutex referring
/// to the same actual synchronization object.
///
///
/// There should not be more than one instance of NamedMutex for
/// a given name in a process. Otherwise, the instances may
/// interfere with each other.
{
public:
typedef Poco::ScopedLock<NamedMutex> ScopedLock;
NamedMutex(const std::string& name);
/// creates the Mutex.
~NamedMutex();
/// destroys the Mutex.
void lock();
/// Locks the mutex. Blocks if the mutex
/// is held by another process or thread.
bool tryLock();
/// Tries to lock the mutex. Returns false immediately
/// if the mutex is already held by another process or thread.
/// Returns true if the mutex was successfully locked.
void unlock();
/// Unlocks the mutex so that it can be acquired by
/// other threads.
private:
NamedMutex();
NamedMutex(const NamedMutex&);
NamedMutex& operator = (const NamedMutex&);
};
//
// inlines
//
inline void NamedMutex::lock()
{
lockImpl();
}
inline bool NamedMutex::tryLock()
{
return tryLockImpl();
}
inline void NamedMutex::unlock()
{
unlockImpl();
}
} // namespace Poco
#endif // Foundation_NamedMutex_INCLUDED
|
