DBusServer

Added in version 2.26.

class DBusServer(**properties: Any)

Superclasses: Object

Implemented Interfaces: Initable

GDBusServer is a helper for listening to and accepting D-Bus connections. This can be used to create a new D-Bus server, allowing two peers to use the D-Bus protocol for their own specialized communication. A server instance provided in this way will not perform message routing or implement the `org.freedesktop.DBus interface <https://dbus.freedesktop.org/doc/dbus-specification.html#message-bus-messages>`_.

To just export an object on a well-known name on a message bus, such as the session or system bus, you should instead use bus_own_name.

An example of peer-to-peer communication with GDBus can be found in gdbus-example-peer.c.

Note that a minimal GDBusServer will accept connections from any peer. In many use-cases it will be necessary to add a DBusAuthObserver that only accepts connections that have successfully authenticated as the same user that is running the GDBusServer. Since GLib 2.68 this can be achieved more simply by passing the G_DBUS_SERVER_FLAGS_AUTHENTICATION_REQUIRE_SAME_USER flag to the server.

Constructors

class DBusServer
classmethod new_sync(address: str, flags: DBusServerFlags, guid: str, observer: DBusAuthObserver | None = None, cancellable: Cancellable | None = None) → DBusServer

Creates a new D-Bus server that listens on the first address in address that works.

Once constructed, you can use get_client_address() to get a D-Bus address string that clients can use to connect.

To have control over the available authentication mechanisms and the users that are authorized to connect, it is strongly recommended to provide a non-None DBusAuthObserver.

Connect to the DBusServer::new-connection signal to handle incoming connections.

The returned DBusServer isn’t active - you have to start it with start().

DBusServer is used in this [example][gdbus-peer-to-peer].

This is a synchronous failable constructor. There is currently no asynchronous version.

Added in version 2.26.

Parameters:

Methods

class DBusServer
get_client_address() → str

Gets a D-Bus address string that can be used by clients to connect to server.

This is valid and non-empty if initializing the DBusServer succeeded.

Added in version 2.26.

get_flags() → DBusServerFlags

Gets the flags for server.

Added in version 2.26.

get_guid() → str

Gets the GUID for server, as provided to new_sync().

Added in version 2.26.

is_active() → bool

Gets whether server is active.

Added in version 2.26.

start() → None

Starts server.

Added in version 2.26.

stop() → None

Stops server.

Added in version 2.26.

Properties

class DBusServer
props.active: bool

Whether the server is currently active.

Added in version 2.26.

props.address: str

The D-Bus address to listen on.

Added in version 2.26.

props.authentication_observer: DBusAuthObserver

A DBusAuthObserver object to assist in the authentication process or None.

Added in version 2.26.

props.client_address: str

The D-Bus address that clients can use.

Added in version 2.26.

props.flags: DBusServerFlags

Flags from the DBusServerFlags enumeration.

Added in version 2.26.

props.guid: str

The GUID of the server.

See DBusConnection:guid for more details.

Added in version 2.26.

Signals

class DBusServer.signals
new_connection(connection: DBusConnection) → bool

Emitted when a new authenticated connection has been made. Use get_peer_credentials() to figure out what identity (if any), was authenticated.

If you want to accept the connection, take a reference to the connection object and return True. When you are done with the connection call close() and give up your reference. Note that the other peer may disconnect at any time - a typical thing to do when accepting a connection is to listen to the DBusConnection::closed signal.

If DBusServer:flags contains RUN_IN_THREAD then the signal is emitted in a new thread dedicated to the connection. Otherwise the signal is emitted in the [thread-default main context][g-main-context-push-thread-default] of the thread that server was constructed in.

You are guaranteed that signal handlers for this signal runs before incoming messages on connection are processed. This means that it’s suitable to call register_object() or similar from the signal handler.

Added in version 2.26.

Parameters:

connection – A DBusConnection for the new connection.