class: DebugControllerDBus

[68:7] extends: object

GDebugControllerDBus is an implementation of [iface@Gio.DebugController] which exposes debug settings as a D-Bus object. It is a [iface@Gio.Initable] object, and will register an object at /org/gtk/Debugging on the bus given as [property@Gio.DebugControllerDBus:connection] once it’s initialized. The object will be unregistered when the last reference to the GDebugControllerDBus is dropped. This D-Bus object can be used by remote processes to enable or disable debug output in this process. Remote processes calling org.gtk.Debugging.SetDebugEnabled() will affect the value of [property@Gio.DebugController:debug-enabled] and, by default, [func@GLib.log_get_debug_enabled]. By default, no processes are allowed to call SetDebugEnabled() unless a [signal@Gio.DebugControllerDBus::authorize] signal handler is installed. This is because the process may be privileged, or might expose sensitive information in its debug output. You may want to restrict the ability to enable debug output to privileged users or processes. One option is to install a D-Bus security policy which restricts access to SetDebugEnabled(), installing something like the following in $datadir/dbus-1/system.d/: ```xml

``` This will prevent the SetDebugEnabled() method from being called by all except root. It will not prevent the DebugEnabled property from being read, as it’s accessed through the org.freedesktop.DBus.Properties interface. Another option is to use polkit to allow or deny requests on a case-by-case basis, allowing for the possibility of dynamic authorisation. To do this, connect to the [signal@Gio.DebugControllerDBus::authorize] signal and query polkit in it:

connection = g_bus_get_sync (G_BUS_TYPE_SYSTEM, NULL, NULL); gulong
debug_controller_authorize_id = 0; // Set up the debug controller.
debug_controller = G_DEBUG_CONTROLLER (g_debug_controller_dbus_new
(priv->connection, NULL, &child_error)); if (debug_controller == NULL) {
g_error ("Could not register debug controller on bus: %s",
child_error->message); } debug_controller_authorize_id = g_signal_connect
(debug_controller, "authorize", G_CALLBACK (debug_controller_authorize_cb),
self); static gboolean debug_controller_authorize_cb (GDebugControllerDBus
*debug_controller, GDBusMethodInvocation *invocation, gpointer user_data) {
g_autoptr(PolkitAuthority) authority = NULL; g_autoptr(PolkitSubject) subject
= NULL; g_autoptr(PolkitAuthorizationResult) auth_result = NULL;
g_autoptr(GError) local_error = NULL; GDBusMessage *message;
GDBusMessageFlags message_flags; PolkitCheckAuthorizationFlags flags =
POLKIT_CHECK_AUTHORIZATION_FLAGS_NONE; message =
g_dbus_method_invocation_get_message (invocation); message_flags =
g_dbus_message_get_flags (message); authority = polkit_authority_get_sync
(NULL, &local_error); if (authority == NULL) { g_warning ("Failed to get
polkit authority: %s", local_error->message); return FALSE; } if
(message_flags & G_DBUS_MESSAGE_FLAGS_ALLOW_INTERACTIVE_AUTHORIZATION) flags
|= POLKIT_CHECK_AUTHORIZATION_FLAGS_ALLOW_USER_INTERACTION; subject =
polkit_system_bus_name_new (g_dbus_method_invocation_get_sender
(invocation)); auth_result = polkit_authority_check_authorization_sync
(authority, subject, "com.example.MyService.set-debug-enabled", NULL, flags,
NULL, &local_error); if (auth_result == NULL) { g_warning ("Failed to get
check polkit authorization: %s", local_error->message); return FALSE; }
return polkit_authorization_result_get_is_authorized (auth_result); } ```

#### Members
- **handleObj**
- **lib**
- **retainedCallbacks**
- **signalHandlerNames**
- **signalSetterHandlers**

#### Methods

- **DebugControllerDBus** (`connection = null, cancellable = null`)

	> Create a new #GDebugControllerDBus and synchronously initialize it. Initializing the object will export the debug object on @connection. The object will remain registered until the last reference to the #GDebugControllerDBus is dropped. Initialization may fail if registering the object on @connection fails.

	- **@p** `connection` is a #GDBusConnection to register the debug object on.
	- **@p** `cancellable` is a #GCancellable, or %NULL.


- **toNativeHandle** (`Source`)

	> Normalizes a constructor argument into a raw pointer carrier. Accepts a raw NativeHandle, a raw NativeBuffer returned from `fn.call(...)`, another generated wrapper exposing `handle()`, or null. Returns null when the argument carries no pointer.

	- **@p** `Source` is the raw handle, raw buffer, wrapper, or null.
	- **@r** `A` raw pointer carrier or null when no pointer is present.


- **getLib** ()

	> Returns the opened native library for this generated wrapper.

	- **@r** `The` opened native library.


- **handle** ()

	> Returns the wrapped NativeHandle.

	- **@r** `The` wrapped NativeHandle.


- **isNull** ()

	> Returns true when the wrapped handle is null.

	- **@r** `A` bool.


- **describe** ()

	> Returns a small string for debugging generated wrappers.

	- **@r** `A` string.


- **asObject** ()

	> Wraps this handle as `Object`.

	- **@r** `A` `Object` object.


- **asDebugController** ()

	> Wraps this handle as `DebugController`.

	- **@r** `A` `DebugController` object.


- **asInitable** ()

	> Wraps this handle as `Initable`.

	- **@r** `A` `Initable` object.


- **connectSignal** (`string Name, CallbackObj`)

	> Connects one generated callback wrapper to a named signal.

	- **@p** `Name` is the signal name.
	- **@p** `CallbackObj` is the generated callback wrapper to connect.
	- **@r** `The` connected handler id.


- **disconnectSignalHandler** (`int HandlerId`)

	> Disconnects one retained signal handler id.

	- **@p** `HandlerId` is the signal handler id to disconnect.
	- **@r** `None.` 


- **setOnAuthorize** (`callback Fn, UserData = null`)

	> Emitted when a D-Bus peer is trying to change the debug settings and used to determine if that is authorized. This signal is emitted in a dedicated worker thread, so handlers are allowed to perform blocking I/O. This means that, for example, it is appropriate to call `polkit_authority_check_authorization_sync()` to check authorization using polkit. If %FALSE is returned then no further handlers are run and the request to change the debug settings is rejected. Otherwise, if %TRUE is returned, signal emission continues. If no handlers return %FALSE, then the debug settings are allowed to be changed. Signal handlers must not modify @invocation, or cause it to return a value. The default class handler just returns %TRUE.

	- **@p** `Fn` is the Aussom callback.
	- **@p** `Fn` is called with (DebugControllerDBus Self, DBusMethodInvocation Invocation).
	- **@p** `UserData` is retained and passed through to the generated callback wrapper when provided.
	- **@r** `The` connected handler id.


- **stop** ()

	> Stop the debug controller, unregistering its object from the bus. Any pending method calls to the object will complete successfully, but new ones will return an error. This method will block until all pending #GDebugControllerDBus::authorize signals have been handled. This is expected to not take long, as it will just be waiting for threads to join. If any #GDebugControllerDBus::authorize signal handlers are still executing in other threads, this will block until after they have returned. This method will be called automatically when the final reference to the #GDebugControllerDBus is dropped. You may want to call it explicitly to know when the controller has been fully removed from the bus, or to break reference count cycles. Calling this method from within a #GDebugControllerDBus::authorize signal handler will cause a deadlock and must not be done.

	- **@r** `None.` 




## class: DebugControllerDBusMeta

[337:14] `static` **extends: object** 

Generated metadata helpers for `DebugControllerDBus` class surfaces.

#### Methods

- **properties** ()

	> Returns property metadata for `DebugControllerDBus`.

	- **@r** `A` list.


- **signals** ()

	> Returns signal metadata for `DebugControllerDBus`.

	- **@r** `A` list.




## class: DebugControllerDBusAuthorizeCallback

[266:7] **extends: object** 

Generated low-level callback wrapper for GIR callback `authorize`.

#### Members
- **callbackObj**
- **userFn**
- **userData**
- **hasUserData**

#### Methods

- **DebugControllerDBusAuthorizeCallback** (`callback Fn, UserData = null`)

	> Creates one native callback wrapper. The wrapper owns a trampoline that converts native pointers into generated wrapper objects before invoking `Fn`.

	- **@p** `Fn` is the Aussom callback implementation.
	- **@p** `UserData` is retained and passed through to Fn on each invocation when provided.


- **trampoline** (`nativeSelf, invocation, nativeUserData`)

	> Internal trampoline. Converts native pointer arguments into generated wrapper instances, then invokes the user's callback.



- **callback** ()

	> Returns the wrapped NativeCallback.



- **handle** ()

	> Returns the callback as a NativeHandle.



- **close** ()

	> Closes the underlying NativeCallback.



- **isClosed** ()

	> Returns true when the callback has been closed.