OnixS BME SENAF Handler C++ library  2.0.1
API documentation
ThreadAffinity.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/Senaf/MarketData/Export.h>
23 
24 #include <set>
25 #include <string>
26 
27 namespace OnixS { namespace Senaf { namespace MarketData {
28 
29 /// Zero-based index of CPU.
30 typedef int CpuIndex;
31 
32 /// Represents set of CPU indices.
33 class ONIXS_BME_SENAF_EXPORT ThreadAffinity
34 {
35 public:
36  /// Initializes empty set.
38 
39  /// Initializes as copy of other set.
41 
42  /// Utilizes all the resources.
43  ~ThreadAffinity();
44 
45  /// Indicates whether is empty.
46  bool empty() const;
47 
48  /// Copies set into another set.
49  void copyTo(std::set<CpuIndex>&) const;
50 
51  /// Adds CPU index into set.
52  bool insert(CpuIndex index);
53 
54  /// Removes CPU index from the set.
55  bool erase(CpuIndex index);
56 
57  /// Makes set empty.
58  void clear();
59 
60  /// Re-initializes instance as copy of other set.
61  ThreadAffinity& operator =(const ThreadAffinity&);
62 
63  /// Returns textual presentation.
64  std::string toString() const;
65 
66  /// Serializes indices into text.
67  void toString(std::string&) const;
68 
69  /// Returns thread affinity of given string presentation.
70  static ThreadAffinity deserialize(const std::string&);
71 
72 private:
73  /// System index.
74  std::set<CpuIndex>* indices_;
75 };
76 
77 inline std::string ThreadAffinity::toString() const
78 {
79  std::string str;
80  toString(str);
81  return str;
82 }
83 
84 }}} // namespace MarketData, Senaf, OnixS
int CpuIndex
Zero-based index of CPU.
std::string toString() const
Returns textual presentation.
Represents set of CPU indices.