shared/nm-glib-aux/nm-dbus-aux.h


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
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202

// SPDX-License-Identifier: LGPL-2.1+
/*
 * Copyright (C) 2019 Red Hat, Inc.
 */

#ifndef __NM_DBUS_AUX_H__
#define __NM_DBUS_AUX_H__

#include "nm-std-aux/nm-dbus-compat.h"

/*****************************************************************************/

static inline gboolean
nm_clear_g_dbus_connection_signal(GDBusConnection *dbus_connection, guint *id)
{
    guint v;

    if (id && (v = *id)) {
        *id = 0;
        g_dbus_connection_signal_unsubscribe(dbus_connection, v);
        return TRUE;
    }
    return FALSE;
}

/*****************************************************************************/

typedef void (*NMDBusConnectionCallDefaultCb)(GVariant *result, GError *error, gpointer user_data);

/*****************************************************************************/

static inline void
nm_dbus_connection_call_start_service_by_name(GDBusConnection *   dbus_connection,
                                              const char *        name,
                                              int                 timeout_msec,
                                              GCancellable *      cancellable,
                                              GAsyncReadyCallback callback,
                                              gpointer            user_data)
{
    g_dbus_connection_call(dbus_connection,
                           DBUS_SERVICE_DBUS,
                           DBUS_PATH_DBUS,
                           DBUS_INTERFACE_DBUS,
                           "StartServiceByName",
                           g_variant_new("(su)", name, 0u),
                           G_VARIANT_TYPE("(u)"),
                           G_DBUS_CALL_FLAGS_NONE,
                           timeout_msec,
                           cancellable,
                           callback,
                           user_data);
}

/*****************************************************************************/

static inline guint
nm_dbus_connection_signal_subscribe_name_owner_changed(GDBusConnection *   dbus_connection,
                                                       const char *        service_name,
                                                       GDBusSignalCallback callback,
                                                       gpointer            user_data,
                                                       GDestroyNotify      user_data_free_func)

{
    return g_dbus_connection_signal_subscribe(dbus_connection,
                                              DBUS_SERVICE_DBUS,
                                              DBUS_INTERFACE_DBUS,
                                              "NameOwnerChanged",
                                              DBUS_PATH_DBUS,
                                              service_name,
                                              G_DBUS_SIGNAL_FLAGS_NONE,
                                              callback,
                                              user_data,
                                              user_data_free_func);
}

typedef void (*NMDBusConnectionCallGetNameOwnerCb)(const char *name_owner,
                                                   GError *    error,
                                                   gpointer    user_data);

void nm_dbus_connection_call_get_name_owner(GDBusConnection *                  dbus_connection,
                                            const char *                       service_name,
                                            int                                timeout_msec,
                                            GCancellable *                     cancellable,
                                            NMDBusConnectionCallGetNameOwnerCb callback,
                                            gpointer                           user_data);

static inline guint
nm_dbus_connection_signal_subscribe_properties_changed(GDBusConnection *   dbus_connection,
                                                       const char *        bus_name,
                                                       const char *        object_path,
                                                       const char *        interface_name,
                                                       GDBusSignalCallback callback,
                                                       gpointer            user_data,
                                                       GDestroyNotify      user_data_free_func)

{
    nm_assert(bus_name);

    /* it seems that using a non-unique name causes problems that we get signals
	 * also from unrelated senders. Usually, you are anyway monitoring the name-owner,
	 * so you should have the unique name at hand.
	 *
	 * If not, investigate this, ensure that it works, and lift this restriction. */
    nm_assert(g_dbus_is_unique_name(bus_name));

    return g_dbus_connection_signal_subscribe(dbus_connection,
                                              bus_name,
                                              DBUS_INTERFACE_PROPERTIES,
                                              "PropertiesChanged",
                                              object_path,
                                              interface_name,
                                              G_DBUS_SIGNAL_FLAGS_NONE,
                                              callback,
                                              user_data,
                                              user_data_free_func);
}

void nm_dbus_connection_call_get_all(GDBusConnection *             dbus_connection,
                                     const char *                  bus_name,
                                     const char *                  object_path,
                                     const char *                  interface_name,
                                     int                           timeout_msec,
                                     GCancellable *                cancellable,
                                     NMDBusConnectionCallDefaultCb callback,
                                     gpointer                      user_data);

void nm_dbus_connection_call_set(GDBusConnection *             dbus_connection,
                                 const char *                  bus_name,
                                 const char *                  object_path,
                                 const char *                  interface_name,
                                 const char *                  property_name,
                                 GVariant *                    value,
                                 int                           timeout_msec,
                                 GCancellable *                cancellable,
                                 NMDBusConnectionCallDefaultCb callback,
                                 gpointer                      user_data);

/*****************************************************************************/

static inline guint
nm_dbus_connection_signal_subscribe_object_manager(GDBusConnection *   dbus_connection,
                                                   const char *        service_name,
                                                   const char *        object_path,
                                                   const char *        signal_name,
                                                   GDBusSignalCallback callback,
                                                   gpointer            user_data,
                                                   GDestroyNotify      user_data_free_func)
{
    return g_dbus_connection_signal_subscribe(dbus_connection,
                                              service_name,
                                              DBUS_INTERFACE_OBJECT_MANAGER,
                                              signal_name,
                                              object_path,
                                              NULL,
                                              G_DBUS_SIGNAL_FLAGS_NONE,
                                              callback,
                                              user_data,
                                              user_data_free_func);
}

void nm_dbus_connection_call_get_managed_objects(GDBusConnection *             dbus_connection,
                                                 const char *                  bus_name,
                                                 const char *                  object_path,
                                                 GDBusCallFlags                flags,
                                                 int                           timeout_msec,
                                                 GCancellable *                cancellable,
                                                 NMDBusConnectionCallDefaultCb callback,
                                                 gpointer                      user_data);

/*****************************************************************************/

void
nm_dbus_connection_call_finish_void_cb(GObject *source, GAsyncResult *result, gpointer user_data);

void nm_dbus_connection_call_finish_void_strip_dbus_error_cb(GObject *     source,
                                                             GAsyncResult *result,
                                                             gpointer      user_data);

void nm_dbus_connection_call_finish_variant_cb(GObject *     source,
                                               GAsyncResult *result,
                                               gpointer      user_data);

void nm_dbus_connection_call_finish_variant_strip_dbus_error_cb(GObject *     source,
                                                                GAsyncResult *result,
                                                                gpointer      user_data);

/*****************************************************************************/

gboolean _nm_dbus_error_is(GError *error, ...) G_GNUC_NULL_TERMINATED;

#define nm_dbus_error_is(error, ...)                           \
    ({                                                         \
        GError *const _error = (error);                        \
                                                               \
        _error &&_nm_dbus_error_is(_error, __VA_ARGS__, NULL); \
    })

#define NM_DBUS_ERROR_NAME_UNKNOWN_METHOD "org.freedesktop.DBus.Error.UnknownMethod"

/*****************************************************************************/

#endif /* __NM_DBUS_AUX_H__ */