DBusConnection.signalSubscribe
uint signalSubscribe(string sender, string interfaceName, string member, string objectPath, string arg0, gio.types.DBusSignalFlags flags, gio.types.DBusSignalCallback callback)Subscribes to signals on connection and invokes callback whenever the signal is received. Note that callback will be invoked in the [thread-default main context][g-main-context-push-thread-default] of the thread you are calling this method from.
If connection is not a message bus connection, sender must be null.
If sender is a well-known name note that callback is invoked with the unique name for the owner of sender, not the well-known name as one would expect. This is because the message bus rewrites the name. As such, to avoid certain race conditions, users should be tracking the name owner of the well-known name and use that when processing the received signal.
If one of [gio.types.DBusSignalFlags.MatchArg0Namespace] or [gio.types.DBusSignalFlags.MatchArg0Path] are given, arg0 is interpreted as part of a namespace or path. The first argument of a signal is matched against that part as specified by D-Bus.
If user_data_free_func is non-null, it will be called (in the thread-default main context of the thread you are calling this method from) at some point after user_data is no longer needed. (It is not guaranteed to be called synchronously when the signal is unsubscribed from, and may be called after connection has been destroyed.)
As callback is potentially invoked in a different thread from where it’s emitted, it’s possible for this to happen after [gio.dbus_connection.DBusConnection.signalUnsubscribe] has been called in another thread. Due to this, user_data should have a strong reference which is freed with user_data_free_func, rather than pointing to data whose lifecycle is tied to the signal subscription. For example, if a #GObject is used to store the subscription ID from [gio.dbus_connection.DBusConnection.signalSubscribe], a strong reference to that #GObject must be passed to user_data, and [gobject.object.ObjectWrap.unref] passed to user_data_free_func. You are responsible for breaking the resulting reference count cycle by explicitly unsubscribing from the signal when dropping the last external reference to the #GObject. Alternatively, a weak reference may be used.
It is guaranteed that if you unsubscribe from a signal using [gio.dbus_connection.DBusConnection.signalUnsubscribe] from the same thread which made the corresponding [gio.dbus_connection.DBusConnection.signalSubscribe] call, callback will not be invoked after [gio.dbus_connection.DBusConnection.signalUnsubscribe] returns.
The returned subscription identifier is an opaque value which is guaranteed to never be zero.
This function can never fail.
Parameters
sender | sender name to match on (unique or well-known name) or null to listen from all senders |
interfaceName | D-Bus interface name to match on or null to match on all interfaces |
member | D-Bus signal name to match on or null to match on all signals |
objectPath | object path to match on or null to match on all object paths |
arg0 | contents of first string argument to match on or null to match on all kinds of arguments |
flags | #GDBusSignalFlags describing how arg0 is used in subscribing to the signal |
callback | callback to invoke when there is a signal matching the requested data |