PipeWire: DBus

PipeWire 1.6.8

Loading...
Searching...
No Matches
DBus
SPA » Support

DBus communication. More...

## Files
file | dbus.h
| spa/support/dbus.h

## Data Structures
struct | spa_dbus
struct | spa_dbus_connection_events
struct | spa_dbus_connection
struct | spa_dbus_methods

## Enumerations
enum | spa_dbus_type { SPA_DBUS_TYPE_SESSION , SPA_DBUS_TYPE_SYSTEM , SPA_DBUS_TYPE_STARTER }

## Macros
#define | SPA_TYPE_INTERFACE_DBus SPA_TYPE_INFO_INTERFACE_BASE "DBus"
#define | SPA_VERSION_DBUS 0
#define | SPA_DBUS_CONNECTION_EVENT_DESTROY 0
#define | SPA_DBUS_CONNECTION_EVENT_DISCONNECTED 1
#define | SPA_DBUS_CONNECTION_EVENT_NUM 2
#define | SPA_VERSION_DBUS_CONNECTION_EVENTS 0
#define | SPA_VERSION_DBUS_CONNECTION 1
#define | SPA_VERSION_DBUS_METHODS 0

## Functions
SPA_API_DBUS void * | spa_dbus_connection_get (struct spa_dbus_connection *conn)
| Get the DBusConnection from a wrapper.
SPA_API_DBUS void | spa_dbus_connection_destroy (struct spa_dbus_connection *conn)
| Destroy a dbus connection wrapper.
SPA_API_DBUS void | spa_dbus_connection_add_listener (struct spa_dbus_connection *conn, struct spa_hook *listener, const struct spa_dbus_connection_events *events, void *data)
| Add a listener for events.
SPA_API_DBUS struct spa_dbus_connection * | spa_dbus_get_connection (struct spa_dbus *dbus, enum spa_dbus_type type)
| Get a new connection wrapper for the given bus type.

## Detailed Description

DBus communication.

## Enumeration Type Documentation

## ◆ spa_dbus_type

enum spa_dbus_type

Enumerator
SPA_DBUS_TYPE_SESSION | The login session bus.
SPA_DBUS_TYPE_SYSTEM | The systemwide bus.
SPA_DBUS_TYPE_STARTER | The bus that started us, if any.

## Macro Definition Documentation

## ◆ SPA_TYPE_INTERFACE_DBus

#define SPA_TYPE_INTERFACE_DBus SPA_TYPE_INFO_INTERFACE_BASE "DBus"

## ◆ SPA_VERSION_DBUS

#define SPA_VERSION_DBUS 0

## ◆ SPA_DBUS_CONNECTION_EVENT_DESTROY

#define SPA_DBUS_CONNECTION_EVENT_DESTROY 0

## ◆ SPA_DBUS_CONNECTION_EVENT_DISCONNECTED

#define SPA_DBUS_CONNECTION_EVENT_DISCONNECTED 1

## ◆ SPA_DBUS_CONNECTION_EVENT_NUM

#define SPA_DBUS_CONNECTION_EVENT_NUM 2

## ◆ SPA_VERSION_DBUS_CONNECTION_EVENTS

#define SPA_VERSION_DBUS_CONNECTION_EVENTS 0

## ◆ SPA_VERSION_DBUS_CONNECTION

#define SPA_VERSION_DBUS_CONNECTION 1

## ◆ SPA_VERSION_DBUS_METHODS

#define SPA_VERSION_DBUS_METHODS 0

## Function Documentation

## ◆ spa_dbus_connection_get()

SPA_API_DBUS void * spa_dbus_connection_get | ( | struct spa_dbus_connection * | conn | ) |

Get the DBusConnection from a wrapper.

Note that the returned handle is closed and unref'd by spa_dbus immediately before emitting the asynchronous "disconnected" event. The caller must either deal with the invalidation, or keep an extra ref on the handle returned.

Parameters

  conn | the spa_dbus_connection wrapper

Returns
  a pointer of type DBusConnection

See also
  spa_dbus_connection.get

## ◆ spa_dbus_connection_destroy()

SPA_API_DBUS void spa_dbus_connection_destroy | ( | struct spa_dbus_connection * | conn | ) |

Destroy a dbus connection wrapper.

Parameters

  conn | the wrapper to destroy

See also
  spa_dbus_connection.destroy

## ◆ spa_dbus_connection_add_listener()

SPA_API_DBUS void spa_dbus_connection_add_listener | ( | struct spa_dbus_connection * | conn,
|  | struct spa_hook * | listener,
|  | const struct spa_dbus_connection_events * | events,
|  | void * | data )

Add a listener for events.

Since version 1

See also
  spa_dbus_connection.add_listener

## ◆ spa_dbus_get_connection()

SPA_API_DBUS struct spa_dbus_connection * spa_dbus_get_connection | ( | struct spa_dbus * | dbus,
|  | enum spa_dbus_type | type )

Get a new connection wrapper for the given bus type.

The connection wrapper is completely configured to operate in the main context of the handle that manages the spa_dbus interface.

Parameters

  dbus | the dbus manager
  type | the bus type to wrap
  error | location for the DBusError

Returns
  a new dbus connection wrapper or NULL on error

See also
  spa_dbus_methods.get_connection