DBusConnection

The gio.DBusConnection type is used for D-Bus connections to remote peers such as a message buses. It is a low-level API that offers a lot of flexibility. For instance, it lets you establish a connection over any transport that can by represented as an gio.IOStream

This class is rarely used directly in D-Bus clients. If you are writing a D-Bus client, it is often easier to use the Bus.ownName, Bus.watchName or g_dbus_proxy_new_for_bus() APIs.

As an exception to the usual GLib rule that a particular object must not be used by two threads at the same time, gio.DBusConnection's methods may be called from any thread. This is so that Bus.get and Bus.getSync can safely return the same gio.DBusConnection when called from any thread.

Most of the ways to obtain a gio.DBusConnection automatically initialize it (i.e. connect to D-Bus): for instance, g_dbus_connection_new() and Bus.get, and the synchronous versions of those methods, give you an initialized connection. Language bindings for GIO should use g_initable_new() or g_async_initable_new_async(), which also initialize the connection.

If you construct an uninitialized gio.DBusConnection, such as via g_object_new(), you must initialize it via g_initable_init() or g_async_initable_init_async() before using its methods or properties. Calling methods or accessing properties on a gio.DBusConnection that has not completed initialization successfully is considered to be invalid, and leads to undefined behaviour. In particular, if initialization fails with a GError, the only valid thing you can do with that gio.DBusConnection is to free it with g_object_unref().

An example D-Bus server # {[gdbus-server|gdbus-server]}

Here is an example for a D-Bus server: gdbus-example-server.c

An example for exporting a subtree # {[gdbus-subtree-server|gdbus-subtree-server]}

Here is an example for exporting a subtree: gdbus-example-subtree.c

An example for file descriptor passing # {[gdbus-unix-fd-client|gdbus-unix-fd-client]}

Here is an example for passing UNIX file descriptors: gdbus-unix-fd-client.c

An example for exporting a GObject # {[gdbus-export|gdbus-export]}

Here is an example for exporting a GObject.get gdbus-example-export.c

class DBusConnection : ObjectG , AsyncInitableIF , InitableIF {}

Constructors

this
this(GDBusConnection* gDBusConnection, bool ownedRef = false)

Sets our main struct and passes it to the parent class.

this
this(AsyncResultIF res, bool address = false)

Finishes an operation started with g_dbus_connection_new().

this
this(string address, GDBusConnectionFlags flags, DBusAuthObserver observer, Cancellable cancellable)

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
this(IOStream stream, string guid, GDBusConnectionFlags flags, DBusAuthObserver observer, Cancellable cancellable)

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

Members

Functions

addFilter
uint addFilter(GDBusMessageFilterFunction filterFunction, void* userData, GDestroyNotify userDataFreeFunc)

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.

addOnClosed
gulong addOnClosed(void delegate(bool, ErrorG, DBusConnection) dlg, ConnectFlags connectFlags = cast(ConnectFlags)0)

Emitted when the connection is closed.

call
void call(string busName, string objectPath, string interfaceName, string methodName, Variant parameters, VariantType replyType, GDBusCallFlags flags, int timeoutMsec, Cancellable cancellable, GAsyncReadyCallback callback, void* userData)

Asynchronously invokes the method_name method on the interface_name D-Bus interface on the remote object at object_path owned by bus_name.

callFinish
Variant callFinish(AsyncResultIF res)

Finishes an operation started with g_dbus_connection_call().

callSync
Variant callSync(string busName, string objectPath, string interfaceName, string methodName, Variant parameters, VariantType replyType, GDBusCallFlags flags, int timeoutMsec, Cancellable cancellable)

Synchronously invokes the method_name method on the interface_name D-Bus interface on the remote object at object_path owned by bus_name.

callWithUnixFdList
void callWithUnixFdList(string busName, string objectPath, string interfaceName, string methodName, Variant parameters, VariantType replyType, GDBusCallFlags flags, int timeoutMsec, UnixFDList fdList, Cancellable cancellable, GAsyncReadyCallback callback, void* userData)

Like g_dbus_connection_call() but also takes a gio.UnixFDList object.

callWithUnixFdListFinish
Variant callWithUnixFdListFinish(out UnixFDList outFdList, AsyncResultIF res)

Finishes an operation started with g_dbus_connection_call_with_unix_fd_list().

callWithUnixFdListSync
Variant callWithUnixFdListSync(string busName, string objectPath, string interfaceName, string methodName, Variant parameters, VariantType replyType, GDBusCallFlags flags, int timeoutMsec, UnixFDList fdList, out UnixFDList outFdList, Cancellable cancellable)

Like g_dbus_connection_call_sync() but also takes and returns gio.UnixFDList objects.

close
void close(Cancellable cancellable, GAsyncReadyCallback callback, void* userData)

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 exit-on-close).

closeFinish
bool closeFinish(AsyncResultIF res)

Finishes an operation started with g_dbus_connection_close().

closeSync
bool closeSync(Cancellable cancellable)

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

emitSignal
bool emitSignal(string destinationBusName, string objectPath, string interfaceName, string signalName, Variant parameters)

Emits a signal.

exportActionGroup
uint exportActionGroup(string objectPath, ActionGroupIF actionGroup)

Exports action_group on connection at object_path.

exportMenuModel
uint exportMenuModel(string objectPath, MenuModel menu)

Exports menu on connection at object_path.

flush
void flush(Cancellable cancellable, GAsyncReadyCallback callback, void* userData)

Asynchronously flushes connection, that is, writes all queued outgoing message to the transport and then flushes the transport (using OutputStream.flushAsync). 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.

flushFinish
bool flushFinish(AsyncResultIF res)

Finishes an operation started with g_dbus_connection_flush().

flushSync
bool flushSync(Cancellable cancellable)

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

getCapabilities
GDBusCapabilityFlags getCapabilities()

Gets the capabilities negotiated with the remote peer

getDBusConnectionStruct
GDBusConnection* getDBusConnectionStruct(bool transferOwnership = false)

Get the main Gtk struct

getExitOnClose
bool getExitOnClose()

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

getGuid
string getGuid()

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

getLastSerial
uint getLastSerial()

Retrieves the last serial number assigned to a gio.DBusMessage on the current thread. This includes messages sent via both low-level API such as g_dbus_connection_send_message() as well as high-level API such as g_dbus_connection_emit_signal(), g_dbus_connection_call() or g_dbus_proxy_call().

getPeerCredentials
Credentials getPeerCredentials()

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

getStream
IOStream getStream()

Gets the underlying stream used for IO.

getStruct
void* getStruct()

the main Gtk struct as a void*

getUniqueName
string getUniqueName()

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.

isClosed
bool isClosed()

Gets whether connection is closed.

registerObject
uint registerObject(string objectPath, DBusInterfaceInfo interfaceInfo, GDBusInterfaceVTable* vtable, void* userData, GDestroyNotify userDataFreeFunc)

Registers callbacks for exported objects at object_path with the D-Bus interface that is described in interface_info.

registerObjectWithClosures
uint registerObjectWithClosures(string objectPath, DBusInterfaceInfo interfaceInfo, Closure methodCallClosure, Closure getPropertyClosure, Closure setPropertyClosure)

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

registerSubtree
uint registerSubtree(string objectPath, GDBusSubtreeVTable* vtable, GDBusSubtreeFlags flags, void* userData, GDestroyNotify userDataFreeFunc)

Registers a whole subtree of dynamic objects.

removeFilter
void removeFilter(uint filterId)

Removes a filter.

sendMessage
bool sendMessage(DBusMessage message, GDBusSendMessageFlags flags, out uint outSerial)

Asynchronously sends message to the peer represented by connection.

sendMessageWithReply
void sendMessageWithReply(DBusMessage message, GDBusSendMessageFlags flags, int timeoutMsec, out uint outSerial, Cancellable cancellable, GAsyncReadyCallback callback, void* userData)

Asynchronously sends message to the peer represented by connection.

sendMessageWithReplyFinish
DBusMessage sendMessageWithReplyFinish(AsyncResultIF res)

Finishes an operation started with g_dbus_connection_send_message_with_reply().

sendMessageWithReplySync
DBusMessage sendMessageWithReplySync(DBusMessage message, GDBusSendMessageFlags flags, int timeoutMsec, out uint outSerial, Cancellable cancellable)

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 g_dbus_connection_send_message_with_reply() for the asynchronous version of this method.

setExitOnClose
void setExitOnClose(bool exitOnClose)

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

signalSubscribe
uint signalSubscribe(string sender, string interfaceName, string member, string objectPath, string arg0, GDBusSignalFlags flags, GDBusSignalCallback callback, void* userData, GDestroyNotify userDataFreeFunc)

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.

signalUnsubscribe
void signalUnsubscribe(uint subscriptionId)

Unsubscribes from signals.

startMessageProcessing
void startMessageProcessing()

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

unexportActionGroup
void unexportActionGroup(uint exportId)

Reverses the effect of a previous call to g_dbus_connection_export_action_group().

unexportMenuModel
void unexportMenuModel(uint exportId)

Reverses the effect of a previous call to g_dbus_connection_export_menu_model().

unregisterObject
bool unregisterObject(uint registrationId)

Unregisters an object.

unregisterSubtree
bool unregisterSubtree(uint registrationId)

Unregisters a subtree.

Static functions

get
void get(GBusType busType, Cancellable cancellable, GAsyncReadyCallback callback, void* userData)

Asynchronously connects to the message bus specified by bus_type.

getFinish
DBusConnection getFinish(AsyncResultIF res)

Finishes an operation started with Bus.get.

getSync
DBusConnection getSync(GBusType busType, Cancellable cancellable)

Synchronously connects to the message bus specified by bus_type. Note that the returned object may shared with other callers, e.g. if two separate parts of a process calls this function with the same bus_type, they will share the same object.

getType
GType getType()
newConnection
void newConnection(IOStream stream, string guid, GDBusConnectionFlags flags, DBusAuthObserver observer, Cancellable cancellable, GAsyncReadyCallback callback, void* userData)

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

newForAddress
void newForAddress(string address, GDBusConnectionFlags flags, DBusAuthObserver observer, Cancellable cancellable, GAsyncReadyCallback callback, void* userData)

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.

Variables

gDBusConnection
GDBusConnection* gDBusConnection;

the main Gtk struct

Inherited Members

From ObjectG

gObject
GObject* gObject;

the main Gtk struct

getObjectGStruct
GObject* getObjectGStruct(bool transferOwnership = false)

Get the main Gtk struct

getStruct
void* getStruct()

the main Gtk struct as a void*

opCast
T opCast()
getDObject
RT getDObject(U obj, bool ownedRef = false)

Gets a D Object from the objects table of associations.

setProperty
void setProperty(string propertyName, T value)
addOnNotify
gulong addOnNotify(void delegate(ParamSpec, ObjectG) dlg, string property = "", ConnectFlags connectFlags = cast(ConnectFlags)0)

The notify signal is emitted on an object when one of its properties has been changed. Note that getting this signal doesn't guarantee that the value of the property has actually changed, it may also be emitted when the setter for the property is called to reinstate the previous value.

getType
GType getType()
compatControl
size_t compatControl(size_t what, void* data)
interfaceFindProperty
ParamSpec interfaceFindProperty(TypeInterface gIface, string propertyName)

Find the gobject.ParamSpec with the given name for an interface. Generally, the interface vtable passed in as g_iface will be the default vtable from g_type_default_interface_ref(), or, if you know the interface has already been loaded, g_type_default_interface_peek().

interfaceInstallProperty
void interfaceInstallProperty(TypeInterface gIface, ParamSpec pspec)

Add a property to an interface; this is only useful for interfaces that are added to GObject-derived types. Adding a property to an interface forces all objects classes with that interface to have a compatible property. The compatible property could be a newly created gobject.ParamSpec, but normally ObjectClass.overrideProperty will be used so that the object class only needs to provide an implementation and inherits the property description, default value, bounds, and so forth from the interface property.

interfaceListProperties
ParamSpec[] interfaceListProperties(TypeInterface gIface)

Lists the properties of an interface.Generally, the interface vtable passed in as g_iface will be the default vtable from g_type_default_interface_ref(), or, if you know the interface has already been loaded, g_type_default_interface_peek().

addToggleRef
void addToggleRef(GToggleNotify notify, void* data)

Increases the reference count of the object by one and sets a callback to be called when all other references to the object are dropped, or when this is already the last reference to the object and another reference is established.

addWeakPointer
void addWeakPointer(ref void* weakPointerLocation)

Adds a weak reference from weak_pointer to object to indicate that the pointer located at weak_pointer_location is only valid during the lifetime of object. When the object is finalized, weak_pointer will be set to NULL.

bindProperty
Binding bindProperty(string sourceProperty, ObjectG target, string targetProperty, GBindingFlags flags)

Creates a binding between source_property on source and target_property on target. Whenever the source_property is changed the target_property is updated using the same value. For instance:

bindPropertyFull
Binding bindPropertyFull(string sourceProperty, ObjectG target, string targetProperty, GBindingFlags flags, GBindingTransformFunc transformTo, GBindingTransformFunc transformFrom, void* userData, GDestroyNotify notify)

Complete version of g_object_bind_property().

bindPropertyWithClosures
Binding bindPropertyWithClosures(string sourceProperty, ObjectG target, string targetProperty, GBindingFlags flags, Closure transformTo, Closure transformFrom)

Creates a binding between source_property on source and target_property on target, allowing you to set the transformation functions to be used by the binding.

dupData
void* dupData(string key, GDuplicateFunc dupFunc, void* userData)

This is a variant of g_object_get_data() which returns a 'duplicate' of the value. dup_func defines the meaning of 'duplicate' in this context, it could e.g. take a reference on a ref-counted object.

dupQdata
void* dupQdata(GQuark quark, GDuplicateFunc dupFunc, void* userData)

This is a variant of g_object_get_qdata() which returns a 'duplicate' of the value. dup_func defines the meaning of 'duplicate' in this context, it could e.g. take a reference on a ref-counted object.

forceFloating
void forceFloating()

This function is intended for GObject implementations to re-enforce a floating[floating-ref] object reference. Doing this is seldom required: all GInitiallyUnowneds are created with a floating reference which usually just needs to be sunken by calling g_object_ref_sink().

freezeNotify
void freezeNotify()

Increases the freeze count on object. If the freeze count is non-zero, the emission of "notify" signals on object is stopped. The signals are queued until the freeze count is decreased to zero. Duplicate notifications are squashed so that at most one notify signal is emitted for each property modified while the object is frozen.

getData
void* getData(string key)

Gets a named field from the objects table of associations (see g_object_set_data()).

getProperty
void getProperty(string propertyName, Value value)

Gets a property of an object. value must have been initialized to the expected type of the property (or a type to which the expected type can be transformed) using Value.init.

getQdata
void* getQdata(GQuark quark)

This function gets back user data pointers stored via g_object_set_qdata().

getValist
void getValist(string firstPropertyName, void* varArgs)

Gets properties of an object.

getv
void getv(string[] names, Value[] values)

Gets n_properties properties for an object. Obtained properties will be set to values. All properties must be valid. Warnings will be emitted and undefined behaviour may result if invalid properties are passed in.

isFloating
bool isFloating()

Checks whether object has a floating[floating-ref] reference.

notify
void notify(string propertyName)

Emits a "notify" signal for the property property_name on object.

notifyByPspec
void notifyByPspec(ParamSpec pspec)

Emits a "notify" signal for the property specified by pspec on object.

doref
ObjectG doref()

Increases the reference count of object.

refSink
ObjectG refSink()

Increase the reference count of object, and possibly remove the floating[floating-ref] reference, if object has a floating reference.

removeToggleRef
void removeToggleRef(GToggleNotify notify, void* data)

Removes a reference added with g_object_add_toggle_ref(). The reference count of the object is decreased by one.

removeWeakPointer
void removeWeakPointer(ref void* weakPointerLocation)

Removes a weak reference from object that was previously added using g_object_add_weak_pointer(). The weak_pointer_location has to match the one used with g_object_add_weak_pointer().

replaceData
bool replaceData(string key, void* oldval, void* newval, GDestroyNotify destroy, out GDestroyNotify oldDestroy)

Compares the user data for the key key on object with oldval, and if they are the same, replaces oldval with newval.

replaceQdata
bool replaceQdata(GQuark quark, void* oldval, void* newval, GDestroyNotify destroy, out GDestroyNotify oldDestroy)

Compares the user data for the key quark on object with oldval, and if they are the same, replaces oldval with newval.

runDispose
void runDispose()

Releases all references to other objects. This can be used to break reference cycles.

setData
void setData(string key, void* data)

Each object carries around a table of associations from strings to pointers. This function lets you set an association.

setDataFull
void setDataFull(string key, void* data, GDestroyNotify destroy)

Like g_object_set_data() except it adds notification for when the association is destroyed, either by setting it to a different value or when the object is destroyed.

setProperty
void setProperty(string propertyName, Value value)

Sets a property on an object.

setQdata
void setQdata(GQuark quark, void* data)

This sets an opaque, named pointer on an object. The name is specified through a GQuark (retrived e.g. via g_quark_from_static_string()), and the pointer can be gotten back from the object with g_object_get_qdata() until the object is finalized. Setting a previously set user data pointer, overrides (frees) the old pointer set, using NULL as pointer essentially removes the data stored.

setQdataFull
void setQdataFull(GQuark quark, void* data, GDestroyNotify destroy)

This function works like g_object_set_qdata(), but in addition, a void (*destroy) (gpointer) function may be specified which is called with data as argument when the object is finalized, or the data is being overwritten by a call to g_object_set_qdata() with the same quark.

setValist
void setValist(string firstPropertyName, void* varArgs)

Sets properties on an object.

setv
void setv(string[] names, Value[] values)

Sets n_properties properties for an object. Properties to be set will be taken from values. All properties must be valid. Warnings will be emitted and undefined behaviour may result if invalid properties are passed in.

stealData
void* stealData(string key)

Remove a specified datum from the object's data associations, without invoking the association's destroy handler.

stealQdata
void* stealQdata(GQuark quark)

This function gets back user data pointers stored via g_object_set_qdata() and removes the data from object without invoking its destroy() function (if any was set). Usually, calling this function is only required to update user data pointers with a destroy notifier, for example:

thawNotify
void thawNotify()

Reverts the effect of a previous call to g_object_freeze_notify(). The freeze count is decreased on object and when it reaches zero, queued "notify" signals are emitted.

unref
void unref()

Decreases the reference count of object. When its reference count drops to 0, the object is finalized (i.e. its memory is freed).

watchClosure
void watchClosure(Closure closure)

This function essentially limits the life time of the closure to the life time of the object. That is, when the object is finalized, the closure is invalidated by calling Closure.invalidate on it, in order to prevent invocations of the closure with a finalized (nonexisting) object. Also, g_object_ref() and g_object_unref() are added as marshal guards to the closure, to ensure that an extra reference count is held on object during invocation of the closure. Usually, this function will be called on closures that use this object as closure data.

weakRef
void weakRef(GWeakNotify notify, void* data)

Adds a weak reference callback to an object. Weak references are used for notification when an object is finalized. They are called "weak references" because they allow you to safely hold a pointer to an object without calling g_object_ref() (g_object_ref() adds a strong reference, that is, forces the object to stay alive).

weakUnref
void weakUnref(GWeakNotify notify, void* data)

Removes a weak reference callback to an object.

clearObject
void clearObject(ref ObjectG objectPtr)

Clears a reference to a GObject

From AsyncInitableIF

getAsyncInitableStruct
GAsyncInitable* getAsyncInitableStruct(bool transferOwnership = false)

Get the main Gtk struct

getStruct
void* getStruct()

the main Gtk struct as a void*

getType
GType getType()
newValistAsync
void newValistAsync(GType objectType, string firstPropertyName, void* varArgs, int ioPriority, Cancellable cancellable, GAsyncReadyCallback callback, void* userData)

Helper function for constructing GAsyncInitable object. This is similar to g_object_new_valist() but also initializes the object asynchronously.

newvAsync
void newvAsync(GType objectType, uint nParameters, GParameter* parameters, int ioPriority, Cancellable cancellable, GAsyncReadyCallback callback, void* userData)

Helper function for constructing GAsyncInitable object. This is similar to g_object_newv() but also initializes the object asynchronously.

initAsync
void initAsync(int ioPriority, Cancellable cancellable, GAsyncReadyCallback callback, void* userData)

Starts asynchronous initialization of the object implementing the interface. This must be done before any real use of the object after initial construction. If the object also implements GInitable you can optionally call g_initable_init() instead.

initFinish
bool initFinish(AsyncResultIF res)

Finishes asynchronous initialization and returns the result. See g_async_initable_init_async().

newFinish
ObjectG newFinish(AsyncResultIF res)

Finishes the async construction for the various g_async_initable_new calls, returning the created object or NULL on error.

From InitableIF

getInitableStruct
GInitable* getInitableStruct(bool transferOwnership = false)

Get the main Gtk struct

getStruct
void* getStruct()

the main Gtk struct as a void*

getType
GType getType()
init
bool init(Cancellable cancellable)

Initializes the object implementing the interface.

Meta

Since

2.26