PipeWire: dbus.h Source File

PipeWire 0.3.34

dbus.h
Go to the documentation of this file.
1 /* Simple Plugin API
2 *
3 * Copyright © 2018 Wim Taymans
4 *
5 * Permission is hereby granted, free of charge, to any person obtaining a
6 * copy of this software and associated documentation files (the "Software"),
7 * to deal in the Software without restriction, including without limitation
8 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
9 * and/or sell copies of the Software, and to permit persons to whom the
10 * Software is furnished to do so, subject to the following conditions:
11 *
12 * The above copyright notice and this permission notice (including the next
13 * paragraph) shall be included in all copies or substantial portions of the
14 * Software.
15 *
16 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
19 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
21 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
22 * DEALINGS IN THE SOFTWARE.
23 */
24
25 #ifndef SPA_DBUS_H
26 #define SPA_DBUS_H
27
28 #ifdef __cplusplus
29 extern "C" {
30 #endif
31
32 #include <spa/support/loop.h>
33
39 #define SPA_TYPE_INTERFACE_DBus SPA_TYPE_INFO_INTERFACE_BASE "DBus"
40
41 #define SPA_VERSION_DBUS 0
42 struct spa_dbus { struct spa_interface iface; };
43
44 enum spa_dbus_type {
45 SPA_DBUS_TYPE_SESSION,
46 SPA_DBUS_TYPE_SYSTEM,
47 SPA_DBUS_TYPE_STARTER
48 };
49
50 #define SPA_DBUS_CONNECTION_EVENT_DESTROY 0
51 #define SPA_DBUS_CONNECTION_EVENT_DISCONNECTED 1
52 #define SPA_DBUS_CONNECTION_EVENT_NUM 2
53
54 struct spa_dbus_connection_events {
55 #define SPA_VERSION_DBUS_CONNECTION_EVENTS 0
56 uint32_t version;
57
58 /* a connection is destroyed */
59 void (*destroy) (void *data);
60
61 /* a connection disconnected */
62 void (*disconnected) (void *data);
63 };
64
65 struct spa_dbus_connection {
66 #define SPA_VERSION_DBUS_CONNECTION 1
67 uint32_t version;
79 void *(*get) (struct spa_dbus_connection *conn);
85 void (*destroy) (struct spa_dbus_connection *conn);
86
92 void (*add_listener) (struct spa_dbus_connection *conn,
93 struct spa_hook *listener,
94 const struct spa_dbus_connection_events *events,
95 void *data);
96 };
97
98 #define spa_dbus_connection_call(c,method,vers,...) \
99 ({ \
100 if (SPA_LIKELY(SPA_CALLBACK_CHECK(c,method,vers))) \
101 c->method((c), ## __VA_ARGS__); \
102 })
103
104 #define spa_dbus_connection_call_vp(c,method,vers,...) \
105 ({ \
106 void *_res = NULL; \
107 if (SPA_LIKELY(SPA_CALLBACK_CHECK(c,method,vers))) \
108 _res = c->method((c), ## __VA_ARGS__); \
109 _res; \
110 })
111
112 #define spa_dbus_connection_get(c) spa_dbus_connection_call_vp(c,get,0)
113 #define spa_dbus_connection_destroy(c) spa_dbus_connection_call(c,destroy,0)
114 #define spa_dbus_connection_add_listener(c,...) spa_dbus_connection_call(c,add_listener,1,__VA_ARGS__)
115
116 struct spa_dbus_methods {
117 #define SPA_VERSION_DBUS_METHODS 0
118 uint32_t version;
119
132 struct spa_dbus_connection * (*get_connection) (void *object,
133 enum spa_dbus_type type);
134 };
135
136 /* static */ inline struct spa_dbus_connection *
137 spa_dbus_get_connection(struct spa_dbus *dbus, enum spa_dbus_type type)
138 {
139 struct spa_dbus_connection *res = NULL;
140 spa_interface_call_res(&dbus->iface,
141 struct spa_dbus_methods, res,
142 get_connection, 0, type);
143 return res;
144 }
145
150 #ifdef __cplusplus
151 } /* extern "C" */
152 #endif
153
154 #endif /* SPA_DBUS_H */
loop.h
spa_interface_call_res
#define spa_interface_call_res(iface, method_type, res, method, vers,...)
Invoke method named method in the callbacks on the given interface object.
Definition: hook.h:208
spa_dbus_get_connection
struct spa_dbus_connection * spa_dbus_get_connection(struct spa_dbus *dbus, enum spa_dbus_type type)
Definition: dbus.h:137
spa_dbus_type
spa_dbus_type
Definition: dbus.h:44
SPA_DBUS_TYPE_SESSION
@ SPA_DBUS_TYPE_SESSION
The login session bus.
Definition: dbus.h:45
SPA_DBUS_TYPE_STARTER
@ SPA_DBUS_TYPE_STARTER
The bus that started us, if any.
Definition: dbus.h:47
SPA_DBUS_TYPE_SYSTEM
@ SPA_DBUS_TYPE_SYSTEM
The systemwide bus.
Definition: dbus.h:46
data
user data to add to an object
Definition: filter.c:75
spa_dbus_connection_events
Definition: dbus.h:54
spa_dbus_connection_events::destroy
void(* destroy)(void *data)
Definition: dbus.h:59
spa_dbus_connection_events::version
uint32_t version
Definition: dbus.h:56
spa_dbus_connection_events::disconnected
void(* disconnected)(void *data)
Definition: dbus.h:62
spa_dbus_connection
Definition: dbus.h:65
spa_dbus_connection::destroy
void(* destroy)(struct spa_dbus_connection *conn)
Destroy a dbus connection wrapper.
Definition: dbus.h:85
spa_dbus_connection::add_listener
void(* add_listener)(struct spa_dbus_connection *conn, struct spa_hook *listener, const struct spa_dbus_connection_events *events, void *data)
Add a listener for events.
Definition: dbus.h:92
spa_dbus_connection::version
uint32_t version
Definition: dbus.h:67
spa_dbus_methods
Definition: dbus.h:116
spa_dbus_methods::version
uint32_t version
Definition: dbus.h:118
spa_dbus
Definition: dbus.h:42
spa_dbus::iface
struct spa_interface iface
Definition: dbus.h:42
spa_hook
A hook, contains the structure with functions and the data passed to the functions.
Definition: hook.h:295
spa_interface
Definition: hook.h:146