Memory-managed wrapper type.

Type class for types which can be safely cast to DBusConnection, for instance with toDBusConnection.

Cast to DBusConnection, for types for which this is known to be safe. For general casts, use castTo.

A convenience alias for Nothing :: Maybe DBusConnection.

Adds a message filter. Filters are handlers that are run on all incoming and outgoing messages, prior to standard dispatch. Filters are run in the order that they were added. The same handler can be added as a filter more than once, in which case it will be run more than once. Filters added during a filter callback won't be run on the message being processed. Filter functions are allowed to modify and even drop messages.

Note that filters are run in a dedicated message handling thread so they can't block and, generally, can't do anything but signal a worker thread. Also note that filters are rarely needed - use API such as dBusConnectionSendMessageWithReply, dBusConnectionSignalSubscribe or dBusConnectionCall instead.

If a filter consumes an incoming message the message is not dispatched anywhere else - not even the standard dispatch machinery (that API such as dBusConnectionSignalSubscribe and dBusConnectionSendMessageWithReply relies on) will see the message. Similary, if a filter consumes an outgoing message, the message will not be sent to the other peer.

If userDataFreeFunc is non-Nothing, it will be called (in the thread-default main context of the thread you are calling this method from) at some point after userData is no longer needed. (It is not guaranteed to be called synchronously when the filter is removed, and may be called after connection has been destroyed.)

Since: 2.26

Asynchronously invokes the methodName method on the interfaceName D-Bus interface on the remote object at objectPath owned by busName.

If connection is closed then the operation will fail with IOErrorEnumClosed. If cancellable is canceled, the operation will fail with IOErrorEnumCancelled. If parameters contains a value not compatible with the D-Bus protocol, the operation fails with IOErrorEnumInvalidArgument.

If replyType is non-Nothing then the reply will be checked for having this type and an error will be raised if it does not match. Said another way, if you give a replyType then any non-Nothing return value will be of this type. Unless it’s G_VARIANT_TYPE_UNIT, the replyType will be a tuple containing one or more values.

If the parameters GVariant is floating, it is consumed. This allows convenient 'inline' use of g_variant_new(), e.g.:

C code

g_dbus_connection_call (connection,
                        "org.freedesktop.StringThings",
                        "/org/freedesktop/StringThings",
                        "org.freedesktop.StringThings",
                        "TwoStrings",
                        g_variant_new ("(ss)",
                                       "Thing One",
                                       "Thing Two"),
                        NULL,
                        G_DBUS_CALL_FLAGS_NONE,
                        -1,
                        NULL,
                        (GAsyncReadyCallback) two_strings_done,
                        NULL);

This is an asynchronous method. When the operation is finished, 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. You can then call dBusConnectionCallFinish to get the result of the operation. See dBusConnectionCallSync for the synchronous version of this function.

If callback is Nothing then the D-Bus method call message will be sent with the DBusMessageFlagsNoReplyExpected flag set.

Since: 2.26

Finishes an operation started with dBusConnectionCall.

Since: 2.26

Synchronously invokes the methodName method on the interfaceName D-Bus interface on the remote object at objectPath owned by busName.

If connection is closed then the operation will fail with IOErrorEnumClosed. If cancellable is canceled, the operation will fail with IOErrorEnumCancelled. If parameters contains a value not compatible with the D-Bus protocol, the operation fails with IOErrorEnumInvalidArgument.

If replyType is non-Nothing then the reply will be checked for having this type and an error will be raised if it does not match. Said another way, if you give a replyType then any non-Nothing return value will be of this type.

If the parameters GVariant is floating, it is consumed. This allows convenient 'inline' use of g_variant_new(), e.g.:

C code

g_dbus_connection_call_sync (connection,
                             "org.freedesktop.StringThings",
                             "/org/freedesktop/StringThings",
                             "org.freedesktop.StringThings",
                             "TwoStrings",
                             g_variant_new ("(ss)",
                                            "Thing One",
                                            "Thing Two"),
                             NULL,
                             G_DBUS_CALL_FLAGS_NONE,
                             -1,
                             NULL,
                             &error);

The calling thread is blocked until a reply is received. See dBusConnectionCall for the asynchronous version of this method.

Since: 2.26

Like dBusConnectionCall but also takes a UnixFDList object.

This method is only available on UNIX.

Since: 2.30

Finishes an operation started with dBusConnectionCallWithUnixFdList.

Since: 2.30

Like dBusConnectionCallSync but also takes and returns UnixFDList objects.

This method is only available on UNIX.

Since: 2.30

Closes connection. Note that this never causes the process to exit (this might only happen if the other end of a shared message bus connection disconnects, see DBusConnection:exit-on-close).

Once the connection is closed, operations such as sending a message will return with the error IOErrorEnumClosed. Closing a connection will not automatically flush the connection so queued messages may be lost. Use dBusConnectionFlush if you need such guarantees.

If connection is already closed, this method fails with IOErrorEnumClosed.

When connection has been closed, the DBusConnection::closed signal is emitted in the [thread-default main context][g-main-context-push-thread-default] of the thread that connection was constructed in.

This is an asynchronous method. When the operation is finished, 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. You can then call dBusConnectionCloseFinish to get the result of the operation. See dBusConnectionCloseSync for the synchronous version.

Since: 2.26

Finishes an operation started with dBusConnectionClose.

Since: 2.26

Synchronously closees connection. The calling thread is blocked until this is done. See dBusConnectionClose for the asynchronous version of this method and more details about what it does.

Since: 2.26

Emits a signal.

If the parameters GVariant is floating, it is consumed.

This can only fail if parameters is not compatible with the D-Bus protocol (IOErrorEnumInvalidArgument), or if connection has been closed (IOErrorEnumClosed).

Since: 2.26

Exports actionGroup on connection at objectPath.

The implemented D-Bus API should be considered private. It is subject to change in the future.

A given object path can only have one action group exported on it. If this constraint is violated, the export will fail and 0 will be returned (with error set accordingly).

You can unexport the action group using dBusConnectionUnexportActionGroup with the return value of this function.

The thread default main context is taken at the time of this call. All incoming action activations and state change requests are reported from this context. Any changes on the action group that cause it to emit signals must also come from this same context. Since incoming action activations and state change requests are rather likely to cause changes on the action group, this effectively limits a given action group to being exported from only one main context.

Since: 2.32

Exports menu on connection at objectPath.

The implemented D-Bus API should be considered private. It is subject to change in the future.

An object path can only have one menu model exported on it. If this constraint is violated, the export will fail and 0 will be returned (with error set accordingly).

You can unexport the menu model using dBusConnectionUnexportMenuModel with the return value of this function.

Since: 2.32

Asynchronously flushes connection, that is, writes all queued outgoing message to the transport and then flushes the transport (using outputStreamFlushAsync). This is useful in programs that wants to emit a D-Bus signal and then exit immediately. Without flushing the connection, there is no guaranteed that the message has been sent to the networking buffers in the OS kernel.

This is an asynchronous method. When the operation is finished, 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. You can then call dBusConnectionFlushFinish to get the result of the operation. See dBusConnectionFlushSync for the synchronous version.

Since: 2.26

Finishes an operation started with dBusConnectionFlush.

Since: 2.26

Synchronously flushes connection. The calling thread is blocked until this is done. See dBusConnectionFlush for the asynchronous version of this method and more details about what it does.

Since: 2.26

Gets the capabilities negotiated with the remote peer

Since: 2.26

Gets whether the process is terminated when connection is closed by the remote peer. See DBusConnection:exit-on-close for more details.

Since: 2.26

The GUID of the peer performing the role of server when authenticating. See DBusConnection:guid for more details.

Since: 2.26

Retrieves the last serial number assigned to a DBusMessage on the current thread. This includes messages sent via both low-level API such as dBusConnectionSendMessage as well as high-level API such as dBusConnectionEmitSignal, dBusConnectionCall or dBusProxyCall.

Since: 2.34

Gets the credentials of the authenticated peer. This will always return Nothing unless connection acted as a server (e.g. DBusConnectionFlagsAuthenticationServer was passed) when set up and the client passed credentials as part of the authentication process.

In a message bus setup, the message bus is always the server and each application is a client. So this method will always return Nothing for message bus clients.

Since: 2.26

Gets the underlying stream used for IO.

While the DBusConnection is active, it will interact with this stream from a worker thread, so it is not safe to interact with the stream directly.

Since: 2.26

Gets the unique name of connection as assigned by the message bus. This can also be used to figure out if connection is a message bus connection.

Since: 2.26

Gets whether connection is closed.

Since: 2.26

Asynchronously sets up a D-Bus connection for exchanging D-Bus messages with the end represented by stream.

If stream is a SocketConnection, then the corresponding Socket will be put into non-blocking mode.

The D-Bus connection will interact with stream from a worker thread. As a result, the caller should not interact with stream after this method has been called, except by calling objectUnref on it.

If observer is not Nothing it may be used to control the authentication process.

When the operation is finished, callback will be invoked. You can then call dBusConnectionNewFinish to get the result of the operation.

This is a asynchronous failable constructor. See dBusConnectionNewSync for the synchronous version.

Since: 2.26

Finishes an operation started with dBusConnectionNew.

Since: 2.26

Asynchronously connects and sets up a D-Bus client connection for exchanging D-Bus messages with an endpoint specified by address which must be in the D-Bus address format.

This constructor can only be used to initiate client-side connections - use dBusConnectionNew if you need to act as the server. In particular, flags cannot contain the DBusConnectionFlagsAuthenticationServer or DBusConnectionFlagsAuthenticationAllowAnonymous flags.

When the operation is finished, callback will be invoked. You can then call dBusConnectionNewFinish to get the result of the operation.

If observer is not Nothing it may be used to control the authentication process.

This is a asynchronous failable constructor. See dBusConnectionNewForAddressSync for the synchronous version.

Since: 2.26

Finishes an operation started with dBusConnectionNewForAddress.

Since: 2.26

Synchronously connects and sets up a D-Bus client connection for exchanging D-Bus messages with an endpoint specified by address which must be in the D-Bus address format.

This constructor can only be used to initiate client-side connections - use dBusConnectionNewSync if you need to act as the server. In particular, flags cannot contain the DBusConnectionFlagsAuthenticationServer or DBusConnectionFlagsAuthenticationAllowAnonymous flags.

This is a synchronous failable constructor. See dBusConnectionNewForAddress for the asynchronous version.

If observer is not Nothing it may be used to control the authentication process.

Since: 2.26

Synchronously sets up a D-Bus connection for exchanging D-Bus messages with the end represented by stream.

If stream is a SocketConnection, then the corresponding Socket will be put into non-blocking mode.

The D-Bus connection will interact with stream from a worker thread. As a result, the caller should not interact with stream after this method has been called, except by calling objectUnref on it.

If observer is not Nothing it may be used to control the authentication process.

This is a synchronous failable constructor. See dBusConnectionNew for the asynchronous version.

Since: 2.26

Version of g_dbus_connection_register_object() using closures instead of a DBusInterfaceVTable for easier binding in other languages.

Since: 2.46

Registers a whole subtree of dynamic objects.

The enumerate and introspection functions in vtable are used to convey, to remote callers, what nodes exist in the subtree rooted by objectPath.

When handling remote calls into any node in the subtree, first the enumerate function is used to check if the node exists. If the node exists or the G_DBUS_SUBTREE_FLAGS_DISPATCH_TO_UNENUMERATED_NODES flag is set the introspection function is used to check if the node supports the requested method. If so, the dispatch function is used to determine where to dispatch the call. The collected DBusInterfaceVTable and gpointer will be used to call into the interface vtable for processing the request.

All calls into user-provided code 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 an existing subtree is already registered at objectPath or then error is set to G_IO_ERROR_EXISTS.

Note that it is valid to register regular objects (using g_dbus_connection_register_object()) in a subtree registered with dBusConnectionRegisterSubtree - if so, the subtree handler is tried as the last resort. One way to think about a subtree handler is to consider it a fallback handler for object paths not registered via g_dbus_connection_register_object() or other bindings.

Note that vtable will be copied so you cannot change it after registration.

See this [server][gdbus-subtree-server] for an example of how to use this method.

Since: 2.26

Removes a filter.

Note that since filters run in a different thread, there is a race condition where it is possible that the filter will be running even after calling dBusConnectionRemoveFilter, so you cannot just free data that the filter might be using. Instead, you should pass a DestroyNotify to dBusConnectionAddFilter, which will be called when it is guaranteed that the data is no longer needed.

Since: 2.26

Asynchronously sends message to the peer represented by connection.

Unless flags contain the DBusSendMessageFlagsPreserveSerial flag, the serial number will be assigned by connection and set on message via dBusMessageSetSerial. If outSerial is not Nothing, then the serial number used will be written to this location prior to submitting the message to the underlying transport.

If connection is closed then the operation will fail with IOErrorEnumClosed. If message is not well-formed, the operation fails with IOErrorEnumInvalidArgument.

See this [server][gdbus-server] and [client][gdbus-unix-fd-client] for an example of how to use this low-level API to send and receive UNIX file descriptors.

Note that message must be unlocked, unless flags contain the DBusSendMessageFlagsPreserveSerial flag.

Since: 2.26

Asynchronously sends message to the peer represented by connection.

Unless flags contain the DBusSendMessageFlagsPreserveSerial flag, the serial number will be assigned by connection and set on message via dBusMessageSetSerial. If outSerial is not Nothing, then the serial number used will be written to this location prior to submitting the message to the underlying transport.

If connection is closed then the operation will fail with IOErrorEnumClosed. If cancellable is canceled, the operation will fail with IOErrorEnumCancelled. If message is not well-formed, the operation fails with IOErrorEnumInvalidArgument.

This is an asynchronous method. When the operation is finished, 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. You can then call dBusConnectionSendMessageWithReplyFinish to get the result of the operation. See dBusConnectionSendMessageWithReplySync for the synchronous version.

Note that message must be unlocked, unless flags contain the DBusSendMessageFlagsPreserveSerial flag.

See this [server][gdbus-server] and [client][gdbus-unix-fd-client] for an example of how to use this low-level API to send and receive UNIX file descriptors.

Since: 2.26

Finishes an operation started with dBusConnectionSendMessageWithReply.

Note that error is only set if a local in-process error occurred. That is to say that the returned DBusMessage object may be of type DBusMessageTypeError. Use dBusMessageToGerror to transcode this to a GError.

See this [server][gdbus-server] and [client][gdbus-unix-fd-client] for an example of how to use this low-level API to send and receive UNIX file descriptors.

Since: 2.26

Synchronously sends message to the peer represented by connection and blocks the calling thread until a reply is received or the timeout is reached. See dBusConnectionSendMessageWithReply for the asynchronous version of this method.

Unless flags contain the DBusSendMessageFlagsPreserveSerial flag, the serial number will be assigned by connection and set on message via dBusMessageSetSerial. If outSerial is not Nothing, then the serial number used will be written to this location prior to submitting the message to the underlying transport.

If connection is closed then the operation will fail with IOErrorEnumClosed. If cancellable is canceled, the operation will fail with IOErrorEnumCancelled. If message is not well-formed, the operation fails with IOErrorEnumInvalidArgument.

Note that error is only set if a local in-process error occurred. That is to say that the returned DBusMessage object may be of type DBusMessageTypeError. Use dBusMessageToGerror to transcode this to a GError.

See this [server][gdbus-server] and [client][gdbus-unix-fd-client] for an example of how to use this low-level API to send and receive UNIX file descriptors.

Note that message must be unlocked, unless flags contain the DBusSendMessageFlagsPreserveSerial flag.

Since: 2.26

Sets whether the process should be terminated when connection is closed by the remote peer. See DBusConnection:exit-on-close for more details.

Note that this function should be used with care. Most modern UNIX desktops tie the notion of a user session the session bus, and expect all of a users applications to quit when their bus connection goes away. If you are setting exitOnClose to False for the shared session bus connection, you should make sure that your application exits when the user session ends.

Since: 2.26

Subscribes to signals on connection and invokes callback with a 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 Nothing.

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 DBusSignalFlagsMatchArg0Namespace or DBusSignalFlagsMatchArg0Path 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 userDataFreeFunc is non-Nothing, it will be called (in the thread-default main context of the thread you are calling this method from) at some point after userData 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.)

Since: 2.26

Unsubscribes from signals.

Since: 2.26

If connection was created with DBusConnectionFlagsDelayMessageProcessing, this method starts processing messages. Does nothing on if connection wasn't created with this flag or if the method has already been called.

Since: 2.26

Reverses the effect of a previous call to dBusConnectionExportActionGroup.

It is an error to call this function with an ID that wasn't returned from dBusConnectionExportActionGroup or to call it with the same ID more than once.

Since: 2.32

Reverses the effect of a previous call to dBusConnectionExportMenuModel.

It is an error to call this function with an ID that wasn't returned from dBusConnectionExportMenuModel or to call it with the same ID more than once.

Since: 2.32

Unregisters an object.

Since: 2.26

Unregisters a subtree.

Since: 2.26

Construct a GValueConstruct with valid value for the “address” property. This is rarely needed directly, but it is used by new.

Construct a GValueConstruct with valid value for the “authentication-observer” property. This is rarely needed directly, but it is used by new.

Get the value of the “capabilities” property. When overloading is enabled, this is equivalent to

get dBusConnection #capabilities

Get the value of the “closed” property. When overloading is enabled, this is equivalent to

get dBusConnection #closed

Construct a GValueConstruct with valid value for the “exit-on-close” property. This is rarely needed directly, but it is used by new.

Get the value of the “exit-on-close” property. When overloading is enabled, this is equivalent to

get dBusConnection #exitOnClose

Set the value of the “exit-on-close” property. When overloading is enabled, this is equivalent to

set dBusConnection [ #exitOnClose := value ]

Construct a GValueConstruct with valid value for the “flags” property. This is rarely needed directly, but it is used by new.

Construct a GValueConstruct with valid value for the “guid” property. This is rarely needed directly, but it is used by new.

Get the value of the “guid” property. When overloading is enabled, this is equivalent to

get dBusConnection #guid

Construct a GValueConstruct with valid value for the “stream” property. This is rarely needed directly, but it is used by new.

Get the value of the “stream” property. When overloading is enabled, this is equivalent to

get dBusConnection #stream

Get the value of the “unique-name” property. When overloading is enabled, this is equivalent to

get dBusConnection #uniqueName

Type for the callback on the (unwrapped) C side.

Emitted when the connection is closed.

The cause of this event can be

• If dBusConnectionClose is called. In this case remotePeerVanished is set to False and error is Nothing.
• If the remote peer closes the connection. In this case remotePeerVanished is set to True and error is set.
• If the remote peer sends invalid or malformed data. In this case remotePeerVanished is set to False and error is set.

Upon receiving this signal, you should give up your reference to connection. You are guaranteed that this signal is emitted only once.

Since: 2.26

Connect a signal handler for the “closed” signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after dBusConnection #closed callback

Wrap the callback into a Closure.

Generate a function pointer callable from C code, from a C_DBusConnectionClosedCallback.

A convenience synonym for Nothing :: Maybe DBusConnectionClosedCallback.

Connect a signal handler for the “closed” signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on dBusConnection #closed callback

Wrap a DBusConnectionClosedCallback into a C_DBusConnectionClosedCallback.