File: dbus_properties.h

package info (click to toggle)
chromium 120.0.6099.224-1~deb11u1
  • links: PTS, VCS
  • area: main
  • in suites: bullseye
  • size: 6,112,112 kB
  • sloc: cpp: 32,907,025; ansic: 8,148,123; javascript: 3,679,536; python: 2,031,248; asm: 959,718; java: 804,675; xml: 617,256; sh: 111,417; objc: 100,835; perl: 88,443; cs: 53,032; makefile: 29,579; fortran: 24,137; php: 21,162; tcl: 21,147; sql: 20,809; ruby: 17,735; pascal: 12,864; yacc: 8,045; lisp: 3,388; lex: 1,323; ada: 727; awk: 329; jsp: 267; csh: 117; exp: 43; sed: 37
file content (87 lines) | stat: -rw-r--r-- 3,384 bytes parent folder | download | duplicates (2)
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
// Copyright 2019 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#ifndef COMPONENTS_DBUS_PROPERTIES_DBUS_PROPERTIES_H_
#define COMPONENTS_DBUS_PROPERTIES_DBUS_PROPERTIES_H_

#include "base/component_export.h"
#include "base/functional/callback_forward.h"
#include "base/memory/raw_ptr.h"
#include "base/memory/weak_ptr.h"
#include "components/dbus/properties/types.h"
#include "dbus/bus.h"
#include "dbus/exported_object.h"

// https://dbus.freedesktop.org/doc/dbus-specification.html#standard-interfaces-properties
class COMPONENT_EXPORT(DBUS) DbusProperties {
 public:
  using InitializedCallback = base::OnceCallback<void(bool success)>;

  // Registers method handlers for the properties interface.  The handlers will
  // not be removed until the bus is shut down.
  DbusProperties(dbus::ExportedObject* exported_object,
                 InitializedCallback callback);

  DbusProperties(const DbusProperties&) = delete;
  DbusProperties& operator=(const DbusProperties&) = delete;

  ~DbusProperties();

  void RegisterInterface(const std::string& interface);

  template <typename T>
  void SetProperty(const std::string& interface,
                   const std::string& name,
                   T&& value,
                   bool emit_signal = true,
                   bool send_change = true) {
    auto interface_it = properties_.find(interface);
    DCHECK(interface_it != properties_.end());
    auto property_it = interface_it->second.find(name);
    DbusVariant new_value = MakeDbusVariant(std::forward<T>(value));
    const bool send_signal =
        emit_signal && (property_it == interface_it->second.end() ||
                        property_it->second != new_value);
    (interface_it->second)[name] = std::move(new_value);
    if (send_signal)
      PropertyUpdated(interface, name, send_change);
  }

  DbusVariant* GetProperty(const std::string& interface,
                           const std::string& property_name);

  // If emitting a PropertiesChangedSignal is desired, this should be called
  // after an existing property is modified through any means other than
  // SetProperty().
  void PropertyUpdated(const std::string& interface,
                       const std::string& property_name,
                       bool send_change = true);

 private:
  void OnExported(const std::string& interface_name,
                  const std::string& method_name,
                  bool success);

  void OnGetAllProperties(dbus::MethodCall* method_call,
                          dbus::ExportedObject::ResponseSender response_sender);
  void OnGetProperty(dbus::MethodCall* method_call,
                     dbus::ExportedObject::ResponseSender response_sender);
  void OnSetProperty(dbus::MethodCall* method_call,
                     dbus::ExportedObject::ResponseSender response_sender);

  bool initialized_ = false;

  raw_ptr<dbus::ExportedObject, AcrossTasksDanglingUntriaged> exported_object_ =
      nullptr;

  base::RepeatingCallback<void(bool)> barrier_;

  // A map from interface name to a map of properties.  The properties map is
  // from property name to property value.
  std::map<std::string, std::map<std::string, DbusVariant>> properties_;

  base::WeakPtrFactory<DbusProperties> weak_factory_{this};
};

#endif  // COMPONENTS_DBUS_PROPERTIES_DBUS_PROPERTIES_H_