Go to the documentation of this file.
20 #ifndef __PIPEWIRE_RESOURCE_H__
21 #define __PIPEWIRE_RESOURCE_H__
27 #define PW_TYPE__Resource "PipeWire:Object:Resource"
28 #define PW_TYPE_RESOURCE_BASE PW_TYPE__Resource ":"
30 #include <spa/utils/hook.h>
63 #define PW_VERSION_RESOURCE_EVENTS 0
77 size_t user_data_size );
102 struct spa_hook *listener,
108 const void *implementation,
113 struct spa_hook *listener,
114 const void *implementation,
126 #define pw_resource_do(r,type,method,v,...) \
127 spa_hook_list_call_once(pw_resource_get_implementation(r),type,method,v,## __VA_ARGS__)
129 #define pw_resource_do_parent(r,l,type,method,...) \
130 spa_hook_list_call_once_start(pw_resource_get_implementation(r),l,type,method,v,## __VA_ARGS__)
132 #define pw_resource_notify(r,type,event,...) \
133 ((type*) pw_resource_get_marshal(r)->event_marshal)->event(r, ## __VA_ARGS__)
SPA_EXPORT struct pw_resource * pw_resource_new(struct pw_client *client, uint32_t id, uint32_t permissions, uint32_t type, uint32_t version, size_t user_data_size)
Make a new resource for client.
Definition: resource.c:34
SPA_EXPORT void pw_resource_destroy(struct pw_resource *resource)
Destroy a resource.
Definition: resource.c:169
SPA_EXPORT struct pw_client * pw_resource_get_client(struct pw_resource *resource)
Get the client owning this resource.
Definition: resource.c:83
void(* destroy)(void *data)
The resource is destroyed.
Definition: resource.h:67
PipeWire client object class.
Manages protocols and their implementation.
#define pw_core_resource_remove_id(r,...)
Definition: interfaces.h:339
void pw_resource_set_implementation(struct pw_resource *resource, const void *implementation, void *data)
Set the resource implementation.
Definition: resource.c:128
uint32_t pw_resource_get_id(struct pw_resource *resource)
Get the unique id of this resource.
Definition: resource.c:89
SPA_EXPORT uint32_t pw_resource_get_permissions(struct pw_resource *resource)
Get the permissions of this resource.
Definition: resource.c:95
static uint32_t pw_map_insert_new(struct pw_map *map, void *data)
Insert data in the map.
Definition: map.h:92
SPA_EXPORT struct spa_hook_list * pw_resource_get_implementation(struct pw_resource *resource)
Get the implementation list of a resource.
Definition: resource.c:150
SPA_EXPORT struct pw_protocol * pw_resource_get_protocol(struct pw_resource *resource)
Get the protocol used for this resource.
Definition: resource.c:107
struct pw_resource * pw_resource_new(struct pw_client *client, uint32_t id, uint32_t permissions, uint32_t type, uint32_t version, size_t user_data_size)
Make a new resource for client.
Definition: resource.c:34
struct pw_protocol * pw_resource_get_protocol(struct pw_resource *resource)
Get the protocol used for this resource.
Definition: resource.c:107
SPA_EXPORT void pw_resource_add_listener(struct pw_resource *resource, struct spa_hook *listener, const struct pw_resource_events *events, void *data)
Add an event listener.
Definition: resource.c:119
uint32_t pw_resource_get_type(struct pw_resource *resource)
Get the type of this resource.
Definition: resource.c:101
uint32_t pw_resource_get_permissions(struct pw_resource *resource)
Get the permissions of this resource.
Definition: resource.c:95
SPA_EXPORT void pw_resource_set_implementation(struct pw_resource *resource, const void *implementation, void *data)
Set the resource implementation.
Definition: resource.c:128
void pw_resource_error(struct pw_resource *resource, int result, const char *error)
Generate an error for a resource.
Definition: resource.c:162
void * pw_resource_get_user_data(struct pw_resource *resource)
Get the user data for the resource, the size was given in pw_resource_new.
Definition: resource.c:113
SPA_EXPORT uint32_t pw_resource_get_id(struct pw_resource *resource)
Get the unique id of this resource.
Definition: resource.c:89
struct pw_client * pw_resource_get_client(struct pw_resource *resource)
Get the client owning this resource.
Definition: resource.c:83
SPA_EXPORT void pw_resource_error(struct pw_resource *resource, int result, const char *error)
Generate an error for a resource.
Definition: resource.c:162
void pw_resource_destroy(struct pw_resource *resource)
Destroy a resource.
Definition: resource.c:169
#define pw_core_resource_error(r,...)
Definition: interfaces.h:338
struct pw_control this
Definition: control.c:26
Definition: protocol.h:70
SPA_EXPORT const struct pw_protocol_marshal * pw_resource_get_marshal(struct pw_resource *resource)
Get the marshal functions for the resource.
Definition: resource.c:156
struct spa_hook_list * pw_resource_get_implementation(struct pw_resource *resource)
Get the implementation list of a resource.
Definition: resource.c:150
SPA_EXPORT uint32_t pw_resource_get_type(struct pw_resource *resource)
Get the type of this resource.
Definition: resource.c:101
SPA_EXPORT void * pw_resource_get_user_data(struct pw_resource *resource)
Get the user data for the resource, the size was given in pw_resource_new.
Definition: resource.c:113
SPA_EXPORT void pw_resource_add_override(struct pw_resource *resource, struct spa_hook *listener, const void *implementation, void *data)
Override the implementation of a resource.
Definition: resource.c:141
static bool pw_map_insert_at(struct pw_map *map, uint32_t id, void *data)
Insert data in the map at an index.
Definition: map.h:119
const struct pw_protocol_marshal * pw_protocol_get_marshal(struct pw_protocol *protocol, uint32_t type)
Definition: protocol.c:146
Resource events.
Definition: resource.h:62
void pw_resource_add_listener(struct pw_resource *resource, struct spa_hook *listener, const struct pw_resource_events *events, void *data)
Add an event listener.
Definition: resource.c:119
uint32_t version
Definition: resource.h:64
void pw_log_debug(const char *format,...)
Log a debug message.
void pw_resource_add_override(struct pw_resource *resource, struct spa_hook *listener, const void *implementation, void *data)
Override the implementation of a resource.
Definition: resource.c:141
const struct pw_protocol_marshal * pw_resource_get_marshal(struct pw_resource *resource)
Get the marshal functions for the resource.
Definition: resource.c:156