mirror of
https://gitlab.freedesktop.org/pipewire/pipewire.git
synced 2025-11-02 09:01:50 -05:00
ae708c14e7
Add version numbers to protocol interfaces and implementation. Allow allocating user_data in proxy and resource Use separate methods to set implementation. Add protocol object to keep track of available protocols and interfaces. Add possibility to dynamically register interfaces.
128 lines
4.1 KiB
C
128 lines
4.1 KiB
C
/* PipeWire
|
|
* Copyright (C) 2015 Wim Taymans <wim.taymans@gmail.com>
|
|
*
|
|
* This library is free software; you can redistribute it and/or
|
|
* modify it under the terms of the GNU Library General Public
|
|
* License as published by the Free Software Foundation; either
|
|
* version 2 of the License, or (at your option) any later version.
|
|
*
|
|
* This library is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
|
* Library General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU Library General Public
|
|
* License along with this library; if not, write to the
|
|
* Free Software Foundation, Inc., 51 Franklin St, Fifth Floor,
|
|
* Boston, MA 02110-1301, USA.
|
|
*/
|
|
|
|
#ifndef __PIPEWIRE_PROXY_H__
|
|
#define __PIPEWIRE_PROXY_H__
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
|
|
#include <pipewire/client/connection.h>
|
|
#include <pipewire/client/context.h>
|
|
#include <pipewire/client/type.h>
|
|
#include <pipewire/client/utils.h>
|
|
|
|
/** \page page_proxy Proxy
|
|
*
|
|
* \section sec_page_proxy_overview Overview
|
|
*
|
|
* The proxy object is a client side representation of a resource
|
|
* that lives on the server.
|
|
*
|
|
* It is used to communicate with the server side object.
|
|
*
|
|
* \section sec_page_proxy_create Create
|
|
*
|
|
* A client first creates a new proxy object with pw_proxy_new(). A
|
|
* type must be provided for this object.
|
|
*
|
|
* The protocol of the context will usually install an interface to
|
|
* translate method calls and events to the wire format.
|
|
*
|
|
* The creator of the proxy will usually also install an event
|
|
* implementation of the particular object type.
|
|
*
|
|
* \section sec_page_proxy_bind Bind
|
|
*
|
|
* To actually use the proxy object, one needs to create a server
|
|
* side resource for it. This can be done by, for example, binding
|
|
* to a global object or by calling a method that creates and binds
|
|
* to a new remote object. In all cases, the local id is passed to
|
|
* the server and is used to create a resource with the same id.
|
|
*
|
|
* \section sec_page_proxy_methods Methods
|
|
*
|
|
* To call a method on the proxy use the interface methods. Calling
|
|
* any interface method will result in a request to the server to
|
|
* perform the requested action on the corresponding resource.
|
|
*
|
|
* \section sec_page_proxy_events Events
|
|
*
|
|
* Events send from the server to the proxy will be demarshalled by
|
|
* the protocol and will then result in a call to the installed
|
|
* implementation of the proxy.
|
|
*
|
|
* \section sec_page_proxy_destroy Destroy
|
|
*
|
|
* Use pw_proxy_destroy() to destroy the client side object. This
|
|
* is usually done automatically when the server removes the resource
|
|
* associated to the proxy.
|
|
*/
|
|
|
|
/** \class pw_proxy
|
|
*
|
|
* \brief Represents an object on the client side.
|
|
*
|
|
* A pw_proxy acts as a client side proxy to an object existing in the
|
|
* pipewire server. The proxy is responsible for converting interface functions
|
|
* invoked by the client to PipeWire messages. Events will call the handlers
|
|
* set in implementation.
|
|
*
|
|
* See \ref page_proxy
|
|
*/
|
|
struct pw_proxy {
|
|
struct pw_context *context; /**< the owner context of this proxy */
|
|
struct spa_list link; /**< link in the context */
|
|
|
|
uint32_t id; /**< client side id */
|
|
uint32_t type; /**< object type id */
|
|
const struct pw_interface *iface; /**< methods/events marshal/demarshal functions */
|
|
|
|
void *object; /**< client side object */
|
|
uint32_t version;
|
|
const void *implementation; /**< event handler implementation */
|
|
pw_destroy_t destroy; /**< optional destroy function to clean up the object */
|
|
|
|
/** destroy_signal is emited when the proxy is destroyed */
|
|
PW_SIGNAL(destroy_signal, (struct pw_listener *listener, struct pw_proxy *proxy));
|
|
|
|
void *user_data; /**< extra user data */
|
|
};
|
|
|
|
struct pw_proxy *
|
|
pw_proxy_new(struct pw_context *context,
|
|
uint32_t id,
|
|
uint32_t type,
|
|
size_t user_data_size);
|
|
|
|
int
|
|
pw_proxy_set_implementation(struct pw_proxy *proxy,
|
|
void *object,
|
|
uint32_t version,
|
|
const void *implementation,
|
|
pw_destroy_t destroy);
|
|
|
|
void pw_proxy_destroy(struct pw_proxy *proxy);
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|
|
|
|
#endif /* __PIPEWIRE_PROXY_H__ */
|