OnixS C++ FIX Engine  4.2.0
API Documentation
Mutex.h
Go to the documentation of this file.
1 /*
2 * Copyright Onix Solutions Limited [OnixS]. All rights reserved.
3 *
4 * This software owned by Onix Solutions Limited [OnixS] and is protected by copyright law
5 * and international copyright treaties.
6 *
7 * Access to and use of the software is governed by the terms of the applicable OnixS Software
8 * Services Agreement (the Agreement) and Customer end user license agreements granting
9 * a non-assignable, non-transferable and non-exclusive license to use the software
10 * for it's own data processing purposes under the terms defined in the Agreement.
11 *
12 * Except as otherwise granted within the terms of the Agreement, copying or reproduction of any part
13 * of this source code or associated reference material to any other location for further reproduction
14 * or redistribution, and any amendments to this copyright notice, are expressly prohibited.
15 *
16 * Any reproduction or redistribution for sale or hiring of the Software not in accordance with
17 * the terms of the Agreement is a violation of copyright law.
18 */
19 
20 #pragma once
21 
22 #include <OnixS/FIXEngine/ABI.h>
23 
24 namespace OnixS {
25 namespace Threading {
26 /// Protects a resources from simultaneous access by multiple threads.
27 ///
28 /// Only one thread at a time can own instance of this class.
29 ///
30 /// This implementation is optimized for locking threads that are in the same process.
31 ///
32 /// @note It is NOT suitable for use for interprocess synchronization.
33 /// @note Recursive locking is NOT supported.
35 {
36 public:
37  friend ONIXS_FIXENGINE_API_DECL(class, Condition);
38 
39  /// Initializes the instance.
40  Mutex();
41 
42  /// Destructs the instance.
43  ~Mutex();
44 
45  /// Acquires lock ownership. If Mutex already
46  /// occupied by the other thread, block current
47  /// thread and waits until it will be released
48  /// by the owner.
49  void acquire();
50 
51  /// Acquires lock ownership if Mutex is not
52  /// owned by any thread. If Mutex is already
53  /// owned by the other thread, returns @c false.
54  /// In either cases it doesn't block thread and
55  /// quites immediately.
56  bool tryAcquire();
57 
58  /// Releases the ownership (lock) and
59  /// unblocks one of waiting threads.
60  void release();
61 
62 private:
63  // Implementation details.
64  void * impl_;
65 
66  // Copying & assignment is prohibited.
67 
68  Mutex(const Mutex &);
69  Mutex & operator = (const Mutex &);
70 };
71 }
72 }
Protects a resources from simultaneous access by multiple threads.
Definition: Mutex.h:34
#define ONIXS_FIXENGINE_API
Definition: ABI.h:45
#define ONIXS_FIXENGINE_API_DECL(typeKind, typeName)
Definition: ABI.h:57
Condition variable - a synchronization objects that allows threads to wait for certain events (condit...
Definition: Condition.h:33