mirror of
https://git.kernel.org/pub/scm/bluetooth/bluez.git
synced 2024-11-15 16:24:28 +08:00
dbdbdb5a8e
This patch adds SPDX License Identifier and removes the license text.
-------------------------------------
License COUNT
-------------------------------------
GPL-2.0-or-later : 6
License: GPL-2.0-or-later
gdbus/mainloop.c
gdbus/object.c
gdbus/polkit.c
gdbus/client.c
gdbus/watch.c
gdbus/gdbus.h
404 lines
14 KiB
C
404 lines
14 KiB
C
/* SPDX-License-Identifier: GPL-2.0-or-later */
|
|
/*
|
|
*
|
|
* D-Bus helper library
|
|
*
|
|
* Copyright (C) 2004-2011 Marcel Holtmann <marcel@holtmann.org>
|
|
*
|
|
*
|
|
*/
|
|
|
|
#ifndef __GDBUS_H
|
|
#define __GDBUS_H
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
|
|
#include <dbus/dbus.h>
|
|
#include <glib.h>
|
|
|
|
typedef struct GDBusArgInfo GDBusArgInfo;
|
|
typedef struct GDBusMethodTable GDBusMethodTable;
|
|
typedef struct GDBusSignalTable GDBusSignalTable;
|
|
typedef struct GDBusPropertyTable GDBusPropertyTable;
|
|
typedef struct GDBusSecurityTable GDBusSecurityTable;
|
|
|
|
typedef void (* GDBusWatchFunction) (DBusConnection *connection,
|
|
void *user_data);
|
|
|
|
typedef void (* GDBusMessageFunction) (DBusConnection *connection,
|
|
DBusMessage *message, void *user_data);
|
|
|
|
typedef gboolean (* GDBusSignalFunction) (DBusConnection *connection,
|
|
DBusMessage *message, void *user_data);
|
|
|
|
DBusConnection *g_dbus_setup_bus(DBusBusType type, const char *name,
|
|
DBusError *error);
|
|
|
|
DBusConnection *g_dbus_setup_private(DBusBusType type, const char *name,
|
|
DBusError *error);
|
|
|
|
gboolean g_dbus_request_name(DBusConnection *connection, const char *name,
|
|
DBusError *error);
|
|
|
|
gboolean g_dbus_set_disconnect_function(DBusConnection *connection,
|
|
GDBusWatchFunction function,
|
|
void *user_data, DBusFreeFunction destroy);
|
|
|
|
typedef void (* GDBusDestroyFunction) (void *user_data);
|
|
|
|
typedef DBusMessage * (* GDBusMethodFunction) (DBusConnection *connection,
|
|
DBusMessage *message, void *user_data);
|
|
|
|
typedef gboolean (*GDBusPropertyGetter)(const GDBusPropertyTable *property,
|
|
DBusMessageIter *iter, void *data);
|
|
|
|
typedef guint32 GDBusPendingPropertySet;
|
|
|
|
typedef void (*GDBusPropertySetter)(const GDBusPropertyTable *property,
|
|
DBusMessageIter *value, GDBusPendingPropertySet id,
|
|
void *data);
|
|
|
|
typedef gboolean (*GDBusPropertyExists)(const GDBusPropertyTable *property,
|
|
void *data);
|
|
|
|
typedef guint32 GDBusPendingReply;
|
|
|
|
typedef void (* GDBusSecurityFunction) (DBusConnection *connection,
|
|
const char *action,
|
|
gboolean interaction,
|
|
GDBusPendingReply pending);
|
|
|
|
enum GDBusFlags {
|
|
G_DBUS_FLAG_ENABLE_EXPERIMENTAL = (1 << 0),
|
|
};
|
|
|
|
enum GDBusMethodFlags {
|
|
G_DBUS_METHOD_FLAG_DEPRECATED = (1 << 0),
|
|
G_DBUS_METHOD_FLAG_NOREPLY = (1 << 1),
|
|
G_DBUS_METHOD_FLAG_ASYNC = (1 << 2),
|
|
G_DBUS_METHOD_FLAG_EXPERIMENTAL = (1 << 3),
|
|
};
|
|
|
|
enum GDBusSignalFlags {
|
|
G_DBUS_SIGNAL_FLAG_DEPRECATED = (1 << 0),
|
|
G_DBUS_SIGNAL_FLAG_EXPERIMENTAL = (1 << 1),
|
|
};
|
|
|
|
enum GDBusPropertyFlags {
|
|
G_DBUS_PROPERTY_FLAG_DEPRECATED = (1 << 0),
|
|
G_DBUS_PROPERTY_FLAG_EXPERIMENTAL = (1 << 1),
|
|
};
|
|
|
|
enum GDBusSecurityFlags {
|
|
G_DBUS_SECURITY_FLAG_DEPRECATED = (1 << 0),
|
|
G_DBUS_SECURITY_FLAG_BUILTIN = (1 << 1),
|
|
G_DBUS_SECURITY_FLAG_ALLOW_INTERACTION = (1 << 2),
|
|
};
|
|
|
|
enum GDbusPropertyChangedFlags {
|
|
G_DBUS_PROPERTY_CHANGED_FLAG_FLUSH = (1 << 0),
|
|
};
|
|
|
|
typedef enum GDBusMethodFlags GDBusMethodFlags;
|
|
typedef enum GDBusSignalFlags GDBusSignalFlags;
|
|
typedef enum GDBusPropertyFlags GDBusPropertyFlags;
|
|
typedef enum GDBusSecurityFlags GDBusSecurityFlags;
|
|
typedef enum GDbusPropertyChangedFlags GDbusPropertyChangedFlags;
|
|
|
|
struct GDBusArgInfo {
|
|
const char *name;
|
|
const char *signature;
|
|
};
|
|
|
|
struct GDBusMethodTable {
|
|
const char *name;
|
|
GDBusMethodFunction function;
|
|
GDBusMethodFlags flags;
|
|
unsigned int privilege;
|
|
const GDBusArgInfo *in_args;
|
|
const GDBusArgInfo *out_args;
|
|
};
|
|
|
|
struct GDBusSignalTable {
|
|
const char *name;
|
|
GDBusSignalFlags flags;
|
|
const GDBusArgInfo *args;
|
|
};
|
|
|
|
struct GDBusPropertyTable {
|
|
const char *name;
|
|
const char *type;
|
|
GDBusPropertyGetter get;
|
|
GDBusPropertySetter set;
|
|
GDBusPropertyExists exists;
|
|
GDBusPropertyFlags flags;
|
|
};
|
|
|
|
struct GDBusSecurityTable {
|
|
unsigned int privilege;
|
|
const char *action;
|
|
GDBusSecurityFlags flags;
|
|
GDBusSecurityFunction function;
|
|
};
|
|
|
|
#define GDBUS_ARGS(args...) (const GDBusArgInfo[]) { args, { } }
|
|
|
|
#define GDBUS_METHOD(_name, _in_args, _out_args, _function) \
|
|
.name = _name, \
|
|
.in_args = _in_args, \
|
|
.out_args = _out_args, \
|
|
.function = _function
|
|
|
|
#define GDBUS_ASYNC_METHOD(_name, _in_args, _out_args, _function) \
|
|
.name = _name, \
|
|
.in_args = _in_args, \
|
|
.out_args = _out_args, \
|
|
.function = _function, \
|
|
.flags = G_DBUS_METHOD_FLAG_ASYNC
|
|
|
|
#define GDBUS_DEPRECATED_METHOD(_name, _in_args, _out_args, _function) \
|
|
.name = _name, \
|
|
.in_args = _in_args, \
|
|
.out_args = _out_args, \
|
|
.function = _function, \
|
|
.flags = G_DBUS_METHOD_FLAG_DEPRECATED
|
|
|
|
#define GDBUS_DEPRECATED_ASYNC_METHOD(_name, _in_args, _out_args, _function) \
|
|
.name = _name, \
|
|
.in_args = _in_args, \
|
|
.out_args = _out_args, \
|
|
.function = _function, \
|
|
.flags = G_DBUS_METHOD_FLAG_ASYNC | G_DBUS_METHOD_FLAG_DEPRECATED
|
|
|
|
#define GDBUS_EXPERIMENTAL_METHOD(_name, _in_args, _out_args, _function) \
|
|
.name = _name, \
|
|
.in_args = _in_args, \
|
|
.out_args = _out_args, \
|
|
.function = _function, \
|
|
.flags = G_DBUS_METHOD_FLAG_EXPERIMENTAL
|
|
|
|
#define GDBUS_EXPERIMENTAL_ASYNC_METHOD(_name, _in_args, _out_args, _function) \
|
|
.name = _name, \
|
|
.in_args = _in_args, \
|
|
.out_args = _out_args, \
|
|
.function = _function, \
|
|
.flags = G_DBUS_METHOD_FLAG_ASYNC | G_DBUS_METHOD_FLAG_EXPERIMENTAL
|
|
|
|
#define GDBUS_NOREPLY_METHOD(_name, _in_args, _out_args, _function) \
|
|
.name = _name, \
|
|
.in_args = _in_args, \
|
|
.out_args = _out_args, \
|
|
.function = _function, \
|
|
.flags = G_DBUS_METHOD_FLAG_NOREPLY
|
|
|
|
#define GDBUS_SIGNAL(_name, _args) \
|
|
.name = _name, \
|
|
.args = _args
|
|
|
|
#define GDBUS_DEPRECATED_SIGNAL(_name, _args) \
|
|
.name = _name, \
|
|
.args = _args, \
|
|
.flags = G_DBUS_SIGNAL_FLAG_DEPRECATED
|
|
|
|
#define GDBUS_EXPERIMENTAL_SIGNAL(_name, _args) \
|
|
.name = _name, \
|
|
.args = _args, \
|
|
.flags = G_DBUS_SIGNAL_FLAG_EXPERIMENTAL
|
|
|
|
void g_dbus_set_flags(int flags);
|
|
int g_dbus_get_flags(void);
|
|
|
|
gboolean g_dbus_register_interface(DBusConnection *connection,
|
|
const char *path, const char *name,
|
|
const GDBusMethodTable *methods,
|
|
const GDBusSignalTable *signals,
|
|
const GDBusPropertyTable *properties,
|
|
void *user_data,
|
|
GDBusDestroyFunction destroy);
|
|
gboolean g_dbus_unregister_interface(DBusConnection *connection,
|
|
const char *path, const char *name);
|
|
|
|
gboolean g_dbus_register_security(const GDBusSecurityTable *security);
|
|
gboolean g_dbus_unregister_security(const GDBusSecurityTable *security);
|
|
|
|
void g_dbus_pending_success(DBusConnection *connection,
|
|
GDBusPendingReply pending);
|
|
void g_dbus_pending_error(DBusConnection *connection,
|
|
GDBusPendingReply pending,
|
|
const char *name, const char *format, ...)
|
|
__attribute__((format(printf, 4, 5)));
|
|
void g_dbus_pending_error_valist(DBusConnection *connection,
|
|
GDBusPendingReply pending, const char *name,
|
|
const char *format, va_list args);
|
|
|
|
DBusMessage *g_dbus_create_error(DBusMessage *message, const char *name,
|
|
const char *format, ...)
|
|
__attribute__((format(printf, 3, 4)));
|
|
DBusMessage *g_dbus_create_error_valist(DBusMessage *message, const char *name,
|
|
const char *format, va_list args);
|
|
DBusMessage *g_dbus_create_reply(DBusMessage *message, int type, ...);
|
|
DBusMessage *g_dbus_create_reply_valist(DBusMessage *message,
|
|
int type, va_list args);
|
|
|
|
gboolean g_dbus_send_message(DBusConnection *connection, DBusMessage *message);
|
|
gboolean g_dbus_send_message_with_reply(DBusConnection *connection,
|
|
DBusMessage *message,
|
|
DBusPendingCall **call, int timeout);
|
|
gboolean g_dbus_send_error(DBusConnection *connection, DBusMessage *message,
|
|
const char *name, const char *format, ...)
|
|
__attribute__((format(printf, 4, 5)));
|
|
gboolean g_dbus_send_error_valist(DBusConnection *connection,
|
|
DBusMessage *message, const char *name,
|
|
const char *format, va_list args);
|
|
gboolean g_dbus_send_reply(DBusConnection *connection,
|
|
DBusMessage *message, int type, ...);
|
|
gboolean g_dbus_send_reply_valist(DBusConnection *connection,
|
|
DBusMessage *message, int type, va_list args);
|
|
|
|
gboolean g_dbus_emit_signal(DBusConnection *connection,
|
|
const char *path, const char *interface,
|
|
const char *name, int type, ...);
|
|
gboolean g_dbus_emit_signal_valist(DBusConnection *connection,
|
|
const char *path, const char *interface,
|
|
const char *name, int type, va_list args);
|
|
|
|
guint g_dbus_add_service_watch(DBusConnection *connection, const char *name,
|
|
GDBusWatchFunction connect,
|
|
GDBusWatchFunction disconnect,
|
|
void *user_data, GDBusDestroyFunction destroy);
|
|
guint g_dbus_add_disconnect_watch(DBusConnection *connection, const char *name,
|
|
GDBusWatchFunction function,
|
|
void *user_data, GDBusDestroyFunction destroy);
|
|
guint g_dbus_add_signal_watch(DBusConnection *connection,
|
|
const char *sender, const char *path,
|
|
const char *interface, const char *member,
|
|
GDBusSignalFunction function, void *user_data,
|
|
GDBusDestroyFunction destroy);
|
|
guint g_dbus_add_properties_watch(DBusConnection *connection,
|
|
const char *sender, const char *path,
|
|
const char *interface,
|
|
GDBusSignalFunction function, void *user_data,
|
|
GDBusDestroyFunction destroy);
|
|
gboolean g_dbus_remove_watch(DBusConnection *connection, guint tag);
|
|
void g_dbus_remove_all_watches(DBusConnection *connection);
|
|
|
|
void g_dbus_pending_property_success(GDBusPendingPropertySet id);
|
|
void g_dbus_pending_property_error_valist(GDBusPendingReply id,
|
|
const char *name, const char *format, va_list args);
|
|
void g_dbus_pending_property_error(GDBusPendingReply id, const char *name,
|
|
const char *format, ...);
|
|
|
|
/*
|
|
* Note that when multiple properties for a given object path are changed
|
|
* in the same mainloop iteration, they will be grouped with the last
|
|
* property changed. If this behaviour is undesired, use
|
|
* g_dbus_emit_property_changed_full() with the
|
|
* G_DBUS_PROPERTY_CHANGED_FLAG_FLUSH flag, causing the signal to ignore
|
|
* any grouping.
|
|
*/
|
|
void g_dbus_emit_property_changed(DBusConnection *connection,
|
|
const char *path, const char *interface,
|
|
const char *name);
|
|
void g_dbus_emit_property_changed_full(DBusConnection *connection,
|
|
const char *path, const char *interface,
|
|
const char *name,
|
|
GDbusPropertyChangedFlags flags);
|
|
gboolean g_dbus_get_properties(DBusConnection *connection, const char *path,
|
|
const char *interface, DBusMessageIter *iter);
|
|
|
|
gboolean g_dbus_attach_object_manager(DBusConnection *connection);
|
|
gboolean g_dbus_detach_object_manager(DBusConnection *connection);
|
|
|
|
typedef struct GDBusClient GDBusClient;
|
|
typedef struct GDBusProxy GDBusProxy;
|
|
|
|
GDBusProxy *g_dbus_proxy_new(GDBusClient *client, const char *path,
|
|
const char *interface);
|
|
|
|
GDBusProxy *g_dbus_proxy_ref(GDBusProxy *proxy);
|
|
void g_dbus_proxy_unref(GDBusProxy *proxy);
|
|
|
|
const char *g_dbus_proxy_get_path(const GDBusProxy *proxy);
|
|
const char *g_dbus_proxy_get_interface(GDBusProxy *proxy);
|
|
|
|
gboolean g_dbus_proxy_get_property(GDBusProxy *proxy, const char *name,
|
|
DBusMessageIter *iter);
|
|
|
|
GDBusProxy *g_dbus_proxy_lookup(GList *list, int *index, const char *path,
|
|
const char *interface);
|
|
char *g_dbus_proxy_path_lookup(GList *list, int *index, const char *path);
|
|
|
|
gboolean g_dbus_proxy_refresh_property(GDBusProxy *proxy, const char *name);
|
|
|
|
typedef void (* GDBusResultFunction) (const DBusError *error, void *user_data);
|
|
|
|
gboolean g_dbus_proxy_set_property_basic(GDBusProxy *proxy,
|
|
const char *name, int type, const void *value,
|
|
GDBusResultFunction function, void *user_data,
|
|
GDBusDestroyFunction destroy);
|
|
|
|
gboolean g_dbus_proxy_set_property_array(GDBusProxy *proxy,
|
|
const char *name, int type, const void *value,
|
|
size_t size, GDBusResultFunction function,
|
|
void *user_data, GDBusDestroyFunction destroy);
|
|
|
|
void g_dbus_dict_append_entry(DBusMessageIter *dict,
|
|
const char *key, int type, void *val);
|
|
void g_dbus_dict_append_basic_array(DBusMessageIter *dict, int key_type,
|
|
const void *key, int type, void *val,
|
|
int n_elements);
|
|
void g_dbus_dict_append_array(DBusMessageIter *dict,
|
|
const char *key, int type, void *val,
|
|
int n_elements);
|
|
|
|
typedef void (* GDBusSetupFunction) (DBusMessageIter *iter, void *user_data);
|
|
typedef void (* GDBusReturnFunction) (DBusMessage *message, void *user_data);
|
|
|
|
gboolean g_dbus_proxy_method_call(GDBusProxy *proxy, const char *method,
|
|
GDBusSetupFunction setup,
|
|
GDBusReturnFunction function, void *user_data,
|
|
GDBusDestroyFunction destroy);
|
|
|
|
typedef void (* GDBusClientFunction) (GDBusClient *client, void *user_data);
|
|
typedef void (* GDBusProxyFunction) (GDBusProxy *proxy, void *user_data);
|
|
typedef void (* GDBusPropertyFunction) (GDBusProxy *proxy, const char *name,
|
|
DBusMessageIter *iter, void *user_data);
|
|
|
|
gboolean g_dbus_proxy_set_property_watch(GDBusProxy *proxy,
|
|
GDBusPropertyFunction function, void *user_data);
|
|
|
|
gboolean g_dbus_proxy_set_removed_watch(GDBusProxy *proxy,
|
|
GDBusProxyFunction destroy, void *user_data);
|
|
|
|
GDBusClient *g_dbus_client_new(DBusConnection *connection,
|
|
const char *service, const char *path);
|
|
GDBusClient *g_dbus_client_new_full(DBusConnection *connection,
|
|
const char *service,
|
|
const char *path,
|
|
const char *root_path);
|
|
|
|
GDBusClient *g_dbus_client_ref(GDBusClient *client);
|
|
void g_dbus_client_unref(GDBusClient *client);
|
|
|
|
gboolean g_dbus_client_set_connect_watch(GDBusClient *client,
|
|
GDBusWatchFunction function, void *user_data);
|
|
gboolean g_dbus_client_set_disconnect_watch(GDBusClient *client,
|
|
GDBusWatchFunction function, void *user_data);
|
|
gboolean g_dbus_client_set_signal_watch(GDBusClient *client,
|
|
GDBusMessageFunction function, void *user_data);
|
|
gboolean g_dbus_client_set_ready_watch(GDBusClient *client,
|
|
GDBusClientFunction ready, void *user_data);
|
|
gboolean g_dbus_client_set_proxy_handlers(GDBusClient *client,
|
|
GDBusProxyFunction proxy_added,
|
|
GDBusProxyFunction proxy_removed,
|
|
GDBusPropertyFunction property_changed,
|
|
void *user_data);
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|
|
|
|
#endif /* __GDBUS_H */
|