Function

Giobus_get_sync

since: 2.26

Declaration

GDBusConnection*
g_bus_get_sync (
  GBusType bus_type,
  GCancellable* cancellable,
  GError** error
)

Description

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.

This is a synchronous failable function. See g_bus_get() and g_bus_get_finish() for the asynchronous version.

The returned object is a singleton, that is, shared with other callers of g_bus_get() and g_bus_get_sync() for bus_type. In the event that you need a private message bus connection, use g_dbus_address_get_for_bus_sync() and g_dbus_connection_new_for_address() with G_DBUS_CONNECTION_FLAGS_AUTHENTICATION_CLIENT and G_DBUS_CONNECTION_FLAGS_MESSAGE_BUS_CONNECTION flags.

Note that the returned GDBusConnection object will (usually) have the GDBusConnection:exit-on-close property set to TRUE.

Available since: 2.26

Parameters

bus_type

Type: GBusType

A GBusType.

cancellable

Type: GCancellable

A GCancellable or NULL.

The argument can be NULL.

The data is owned by the caller of the function.

error

Type: GError **

The return location for a recoverable error.

The argument can be NULL.

If the return location is not NULL, then you must initialize it to a NULL GError*.

The argument will left initialized to NULL by the function if there are no errors.

In case of error, the argument will be set to a newly allocated GError; the caller will take ownership of the data, and be responsible for freeing it.

Return value

Type: GDBusConnection

A GDBusConnection or NULL if error is set. Free with g_object_unref().

The caller of the function takes ownership of the data, and is responsible for freeing it.