OnixS C++ CBOE CFE Binary Order Entry (BOE) Handler  1.11.0
API documentation
Condition.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 #pragma once
20 
22 
23 namespace OnixS {
24 namespace CboeCFE {
25 namespace Trading {
26 namespace BOE {
27 namespace Threading {
28 
29 /// Condition variable - a synchronization objects that
30 /// allows threads to wait for certain events (conditions)
31 /// to occur.
32 ///
33 /// Condition variable enables threads to atomically block
34 /// and test condition under protection of mutual exclusion
35 /// lock (Mutex) until condition is satisfied.
36 class ONIXS_CBOE_CFE_BOE_API Condition
37 {
38 public:
39  /// Initializes the instance.
40  Condition();
41 
42  /// Destructs the instance.
43  ~Condition();
44 
45  /// Signals one waiting thread.
46  void signal();
47 
48  /// Signals all waiting threads.
49  void signalAll();
50 
51  /// Blocks on a condition.
52  ///
53  /// \param lock Represents a reference to Mutex
54  /// that is used to protect the condition testing.
55  void wait(Mutex &lock);
56 
57 private:
58  void *impl_;
59 
60  // Copying & assignment is prohibited.
61  Condition(const Condition &);
62  Condition &operator=(const Condition &);
63 };
64 
65 }
66 }
67 }
68 }
69 }