PipeWire  0.3.45
proxy.h
Go to the documentation of this file.
1 /* PipeWire
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 PIPEWIRE_PROXY_H
26 #define PIPEWIRE_PROXY_H
27 
28 #ifdef __cplusplus
29 extern "C" {
30 #endif
31 
32 #include <spa/utils/hook.h>
33 
106 struct pw_proxy;
107 
108 #include <pipewire/protocol.h>
109 
111 struct pw_proxy_events {
112 #define PW_VERSION_PROXY_EVENTS 0
113  uint32_t version;
114 
116  void (*destroy) (void *data);
117 
119  void (*bound) (void *data, uint32_t global_id);
120 
123  void (*removed) (void *data);
124 
126  void (*done) (void *data, int seq);
127 
129  void (*error) (void *data, int seq, int res, const char *message);
130 };
131 
132 /* Make a new proxy object. The id can be used to bind to a remote object and
133  * can be retrieved with \ref pw_proxy_get_id . */
134 struct pw_proxy *
135 pw_proxy_new(struct pw_proxy *factory,
136  const char *type, /* interface type */
137  uint32_t version, /* interface version */
138  size_t user_data_size /* size of user data */);
139 
141 void pw_proxy_add_listener(struct pw_proxy *proxy,
142  struct spa_hook *listener,
143  const struct pw_proxy_events *events,
144  void *data);
145 
148 void pw_proxy_add_object_listener(struct pw_proxy *proxy,
149  struct spa_hook *listener,
150  const void *funcs,
151  void *data );
152 
154 void pw_proxy_destroy(struct pw_proxy *proxy);
155 
156 void pw_proxy_ref(struct pw_proxy *proxy);
157 void pw_proxy_unref(struct pw_proxy *proxy);
158 
160 void *pw_proxy_get_user_data(struct pw_proxy *proxy);
161 
163 uint32_t pw_proxy_get_id(struct pw_proxy *proxy);
164 
166 const char *pw_proxy_get_type(struct pw_proxy *proxy, uint32_t *version);
167 
169 struct pw_protocol *pw_proxy_get_protocol(struct pw_proxy *proxy);
170 
173 int pw_proxy_sync(struct pw_proxy *proxy, int seq);
174 
177 int pw_proxy_set_bound_id(struct pw_proxy *proxy, uint32_t global_id);
180 uint32_t pw_proxy_get_bound_id(struct pw_proxy *proxy);
181 
183 int pw_proxy_error(struct pw_proxy *proxy, int res, const char *error);
184 int pw_proxy_errorf(struct pw_proxy *proxy, int res, const char *error, ...) SPA_PRINTF_FUNC(3, 4);
185 
188 
190 const struct pw_protocol_marshal *pw_proxy_get_marshal(struct pw_proxy *proxy);
191 
193 int pw_proxy_install_marshal(struct pw_proxy *proxy, bool implementor);
194 
195 #define pw_proxy_notify(p,type,event,version,...) \
196  spa_hook_list_call(pw_proxy_get_object_listeners(p), \
197  type, event, version, ## __VA_ARGS__)
198 
199 #define pw_proxy_call(p,type,method,version,...) \
200  spa_interface_call((struct spa_interface*)p, \
201  type, method, version, ##__VA_ARGS__)
202 
203 #define pw_proxy_call_res(p,type,method,version,...) \
204 ({ \
205  int _res = -ENOTSUP; \
206  spa_interface_call_res((struct spa_interface*)p, \
207  type, _res, method, version, ##__VA_ARGS__); \
208  _res; \
209 })
210 
215 #ifdef __cplusplus
216 }
217 #endif
218 
219 #endif /* PIPEWIRE_PROXY_H */
int pw_proxy_set_bound_id(struct pw_proxy *proxy, uint32_t global_id)
Set the global id this proxy is bound to.
Definition: proxy.c:160
void pw_proxy_add_listener(struct pw_proxy *proxy, struct spa_hook *listener, const struct pw_proxy_events *events, void *data)
Add an event listener to proxy.
Definition: proxy.c:197
const char * pw_proxy_get_type(struct pw_proxy *proxy, uint32_t *version)
Get the type and version of the proxy.
Definition: proxy.c:175
void pw_proxy_add_object_listener(struct pw_proxy *proxy, struct spa_hook *listener, const void *funcs, void *data)
Add a listener for the events received from the remote object.
Definition: proxy.c:206
void pw_proxy_unref(struct pw_proxy *proxy)
Definition: proxy.c:289
struct pw_proxy * pw_proxy_new(struct pw_proxy *factory, const char *type, uint32_t version, size_t user_data_size)
Create a proxy object with a given id and type.
Definition: proxy.c:91
const struct pw_protocol_marshal * pw_proxy_get_marshal(struct pw_proxy *proxy)
Get the marshal functions for the proxy.
Definition: proxy.c:365
int pw_proxy_error(struct pw_proxy *proxy, int res, const char *error)
Generate an error for a proxy.
Definition: proxy.c:347
uint32_t pw_proxy_get_bound_id(struct pw_proxy *proxy)
Get the global id bound to this proxy of SPA_ID_INVALID when not bound to a global.
Definition: proxy.c:169
int struct spa_hook_list * pw_proxy_get_object_listeners(struct pw_proxy *proxy)
Get the listener of proxy.
Definition: proxy.c:359
int pw_proxy_sync(struct pw_proxy *proxy, int seq)
Generate an sync method for a proxy.
Definition: proxy.c:319
struct pw_protocol * pw_proxy_get_protocol(struct pw_proxy *proxy)
Get the protocol used for the proxy.
Definition: proxy.c:189
uint32_t pw_proxy_get_id(struct pw_proxy *proxy)
Get the local id of the proxy.
Definition: proxy.c:154
void * pw_proxy_get_user_data(struct pw_proxy *proxy)
Get the user_data.
Definition: proxy.c:148
void pw_proxy_ref(struct pw_proxy *proxy)
Definition: proxy.c:312
int pw_proxy_errorf(struct pw_proxy *proxy, int res, const char *error,...) 1(3
int pw_proxy_install_marshal(struct pw_proxy *proxy, bool implementor)
Install a marshal function on a proxy.
Definition: proxy.c:123
void pw_proxy_destroy(struct pw_proxy *proxy)
destroy a proxy
Definition: proxy.c:231
#define SPA_PRINTF_FUNC(fmt, arg1)
Definition: defs.h:260
spa/utils/hook.h
pipewire/protocol.h
Definition: protocol.h:97
Proxy events, use pw_proxy_add_listener.
Definition: proxy.h:116
void(* done)(void *data, int seq)
a reply to a sync method completed
Definition: proxy.h:132
uint32_t version
Definition: proxy.h:119
void(* removed)(void *data)
a proxy is removed from the server.
Definition: proxy.h:129
void(* bound)(void *data, uint32_t global_id)
a proxy is bound to a global id
Definition: proxy.h:125
void(* destroy)(void *data)
The proxy is destroyed.
Definition: proxy.h:122
void(* error)(void *data, int seq, int res, const char *message)
an error occurred on the proxy
Definition: proxy.h:135
A list of hooks.
Definition: hook.h:331
A hook, contains the structure with functions and the data passed to the functions.
Definition: hook.h:342