Struct gio::DBusServer

#[repr(transparent)]
pub struct DBusServer { /* private fields */ }

DBusServer 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.

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 g_bus_own_name().

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

Note that a minimal DBusServer 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 DBusServer. Since GLib 2.68 this can be achieved more simply by passing the DBusServerFlags::AUTHENTICATION_REQUIRE_SAME_USER flag to the server.

Properties

active

Whether the server is currently active.

Readable

address

The D-Bus address to listen on.

Readable | Writeable | Construct Only

authentication-observer

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

Readable | Writeable | Construct Only

client-address

The D-Bus address that clients can use.

Readable

flags

Flags from the DBusServerFlags enumeration.

Readable | Writeable | Construct Only

guid

The GUID of the server.

See guid for more details.

Readable | Writeable | Construct Only

Signals

new-connection

Emitted when a new authenticated connection has been made. Use DBusConnection::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 DBusConnection::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 closed signal.

If flags contains DBusServerFlags::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 g_dbus_connection_register_object() or similar from the signal handler.

Implements

glib::ObjectExt, InitableExt

Implementations

impl DBusServer

pub fn new_sync( address: &str, flags: DBusServerFlags, guid: &str, observer: Option<&DBusAuthObserver>, cancellable: Option<&impl IsA<Cancellable>> ) -> Result<DBusServer, Error>

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

Once constructed, you can use 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 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.

address

A D-Bus address.

flags

Flags from the DBusServerFlags enumeration.

guid

A D-Bus GUID.

observer

A DBusAuthObserver or None.

cancellable

A Cancellable or None.

Returns

A DBusServer or None if error is set. Free with g_object_unref().

pub fn client_address(&self) -> GString

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

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

Returns

A D-Bus address string. Do not free, the string is owned by self.

pub fn flags(&self) -> DBusServerFlags

Gets the flags for self.

Returns

A set of flags from the DBusServerFlags enumeration.

pub fn guid(&self) -> GString

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

Returns

A D-Bus GUID. Do not free this string, it is owned by self.

pub fn is_active(&self) -> bool

Gets whether self is active.

Returns

true if server is active, false otherwise.

pub fn start(&self)

Starts self.

pub fn stop(&self)

Stops self.

pub fn address(&self) -> Option<GString>

The D-Bus address to listen on.

pub fn authentication_observer(&self) -> Option<DBusAuthObserver>

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

pub fn connect_new_connection<F: Fn(&Self, &DBusConnection) -> bool + 'static>( &self, f: F ) -> SignalHandlerId

Emitted when a new authenticated connection has been made. Use DBusConnection::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 DBusConnection::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 closed signal.

If flags contains DBusServerFlags::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 g_dbus_connection_register_object() or similar from the signal handler.

connection

A DBusConnection for the new connection.

Returns

true to claim connection, false to let other handlers run.

pub fn connect_active_notify<F: Fn(&Self) + 'static>( &self, f: F ) -> SignalHandlerId

pub fn connect_client_address_notify<F: Fn(&Self) + 'static>( &self, f: F ) -> SignalHandlerId

Trait Implementations

impl Clone for DBusServer

fn clone(&self) -> Self

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for DBusServer

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Display for DBusServer

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl HasParamSpec for DBusServer

type ParamSpec = ParamSpecObject

type SetValue = DBusServer

Preferred value to be used as setter for the associated ParamSpec.

type BuilderFn = fn(_: &str) -> ParamSpecObjectBuilder<'_, DBusServer>

fn param_spec_builder() -> Self::BuilderFn

impl Hash for DBusServer

fn hash<H>(&self, state: &mut H)where H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for DBusServer

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Selfwhere Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Selfwhere Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Selfwhere Self: Sized + PartialOrd<Self>,

Restrict a value to a certain interval.

impl ParentClassIs for DBusServer

type Parent = Object

impl<OT: ObjectType> PartialEq<OT> for DBusServer

fn eq(&self, other: &OT) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<OT: ObjectType> PartialOrd<OT> for DBusServer

fn partial_cmp(&self, other: &OT) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl StaticType for DBusServer

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for DBusServer

impl IsA<Initable> for DBusServer