PipeWire  0.3.29
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 
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 
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 
66 #define SPA_VERSION_DBUS_CONNECTION 1
67  uint32_t version;
74  void *(*get) (struct spa_dbus_connection *conn);
80  void (*destroy) (struct spa_dbus_connection *conn);
81 
87  void (*add_listener) (struct spa_dbus_connection *conn,
88  struct spa_hook *listener,
89  const struct spa_dbus_connection_events *events,
90  void *data);
91 };
92 
93 #define spa_dbus_connection_call(c,method,vers,...) \
94 ({ \
95  if (SPA_LIKELY(SPA_CALLBACK_CHECK(c,method,vers))) \
96  c->method((c), ## __VA_ARGS__); \
97 })
98 
99 #define spa_dbus_connection_call_vp(c,method,vers,...) \
100 ({ \
101  void *_res = NULL; \
102  if (SPA_LIKELY(SPA_CALLBACK_CHECK(c,method,vers))) \
103  _res = c->method((c), ## __VA_ARGS__); \
104  _res; \
105 })
106 
107 #define spa_dbus_connection_get(c) spa_dbus_connection_call_vp(c,get,0)
108 #define spa_dbus_connection_destroy(c) spa_dbus_connection_call(c,destroy,0)
109 #define spa_dbus_connection_add_listener(c,...) spa_dbus_connection_call(c,add_listener,1,__VA_ARGS__)
110 
112 #define SPA_VERSION_DBUS_METHODS 0
113  uint32_t version;
114 
127  struct spa_dbus_connection * (*get_connection) (void *object,
128  enum spa_dbus_type type);
129 };
130 
131 /* static */ inline struct spa_dbus_connection *
133 {
134  struct spa_dbus_connection *res = NULL;
136  struct spa_dbus_methods, res,
137  get_connection, 0, type);
138  return res;
139 }
140 
145 #ifdef __cplusplus
146 } /* extern "C" */
147 #endif
148 
149 #endif /* SPA_DBUS_H */
static uint32_t int int res
Definition: core.h:329
#define spa_interface_call_res(iface, type, res, method, vers,...)
Definition: hook.h:170
struct spa_dbus_connection * spa_dbus_get_connection(struct spa_dbus *dbus, enum spa_dbus_type type)
Definition: dbus.h:132
spa_dbus_type
Definition: dbus.h:44
@ SPA_DBUS_TYPE_SESSION
The login session bus.
Definition: dbus.h:45
@ SPA_DBUS_TYPE_STARTER
The bus that started us, if any.
Definition: dbus.h:47
@ SPA_DBUS_TYPE_SYSTEM
The systemwide bus.
Definition: dbus.h:46
Definition: filter.c:75
Definition: dbus.h:54
void(* destroy)(void *data)
Definition: dbus.h:59
uint32_t version
Definition: dbus.h:56
void(* disconnected)(void *data)
Definition: dbus.h:62
Definition: dbus.h:65
void(* destroy)(struct spa_dbus_connection *conn)
Destroy a dbus connection wrapper.
Definition: dbus.h:80
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:87
uint32_t version
Definition: dbus.h:67
Definition: dbus.h:111
uint32_t version
Definition: dbus.h:113
Definition: dbus.h:42
struct spa_interface iface
Definition: dbus.h:42
A hook, contains the structure with functions and the data passed to the functions.
Definition: hook.h:76
Definition: hook.h:65