File: runtime_settings_map.hpp

package info (click to toggle)
actor-framework 0.17.6-3.2
  • links: PTS
  • area: main
  • in suites: forky, sid
  • size: 9,008 kB
  • sloc: cpp: 77,684; sh: 674; python: 309; makefile: 13
file content (75 lines) | stat: -rw-r--r-- 2,849 bytes parent folder | download | duplicates (4)
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
/******************************************************************************
 *                       ____    _    _____                                   *
 *                      / ___|  / \  |  ___|    C++                           *
 *                     | |     / _ \ | |_       Actor                         *
 *                     | |___ / ___ \|  _|      Framework                     *
 *                      \____/_/   \_|_|                                      *
 *                                                                            *
 * Copyright 2011-2018 Dominik Charousset                                     *
 *                                                                            *
 * Distributed under the terms and conditions of the BSD 3-Clause License or  *
 * (at your option) under the terms and conditions of the Boost Software      *
 * License 1.0. See accompanying files LICENSE and LICENSE_ALTERNATIVE.       *
 *                                                                            *
 * If you did not receive a copy of the license files, see                    *
 * http://opensource.org/licenses/BSD-3-Clause and                            *
 * http://www.boost.org/LICENSE_1_0.txt.                                      *
 ******************************************************************************/

#pragma once

#include <cstdint>
#include <unordered_map>

#include "caf/atom.hpp"
#include "caf/detail/shared_spinlock.hpp"
#include "caf/variant.hpp"

namespace caf {

/// Thread-safe container for mapping atoms to arbitrary settings.
class runtime_settings_map {
public:
  // -- member types -----------------------------------------------------------

  using mutex_type = detail::shared_spinlock;

  using generic_pointer = void*;

  using generic_function_pointer = void (*)();

  using mapped_type = variant<none_t, int64_t, uint64_t, atom_value,
                              generic_pointer, generic_function_pointer>;

  // -- thread-safe access -----------------------------------------------------

  /// Returns the value mapped to `key`.
  mapped_type get(atom_value key) const;

  /// Returns the value mapped to `key` or `fallback` if no value is mapped to
  /// this key.
  mapped_type get_or(atom_value key, mapped_type fallback) const;

  /// Maps `key` to `value` and returns the previous value.
  void set(atom_value key, mapped_type value);

  /// Removes `key` from the map.
  void erase(atom_value key);

  /// Returns the number of key-value entries.
  size_t size() const;

  /// Returns whether `size()` equals 0.
  bool empty() const {
    return size() == 0;
  }

private:
  // -- member variables -------------------------------------------------------

  mutable mutex_type mtx_;

  std::unordered_map<atom_value, mapped_type> map_;
};

} // namespace caf