Struct gio::DBusConnection

source ·

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

Expand description

The 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 a 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 g_bus_own_name(), g_bus_watch_name() or DBusProxy::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, DBusConnection’s methods may be called from any thread. This is so that bus_get() and bus_get_sync() can safely return the same DBusConnection when called from any thread.

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

If you construct an uninitialized DBusConnection, such as via glib::Object::new(), you must initialize it via InitableExt::init() or AsyncInitableExt::init_async() before using its methods or properties. Calling methods or accessing properties on a DBusConnection that has not completed initialization successfully is considered to be invalid, and leads to undefined behaviour. In particular, if initialization fails with a glib::Error, the only valid thing you can do with that DBusConnection is to free it with g_object_unref().

An example D-Bus 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}

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

An example for file descriptor passing # {`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}

Here is an example for exporting a glib::Object: gdbus-example-export.c

Struct gio::DBusConnection

Implementations§

impl DBusConnection

pub fn unregister_object( &self, registration_id: RegistrationId ) -> Result<(), BoolError>

pub fn export_action_group<P: IsA<ActionGroup>>( &self, object_path: &str, action_group: &P ) -> Result<ActionGroupExportId, Error>

pub fn unexport_action_group(&self, export_id: ActionGroupExportId)

pub fn export_menu_model<P: IsA<MenuModel>>( &self, object_path: &str, menu: &P ) -> Result<MenuModelExportId, Error>

pub fn unexport_menu_model(&self, export_id: MenuModelExportId)

pub fn add_filter<P: Fn(&DBusConnection, &DBusMessage, bool) -> Option<DBusMessage> + 'static>( &self, filter_function: P ) -> FilterId

pub fn remove_filter(&self, filter_id: FilterId)

pub fn signal_subscribe<P: Fn(&DBusConnection, &str, &str, &str, &str, &Variant) + 'static>( &self, sender: Option<&str>, interface_name: Option<&str>, member: Option<&str>, object_path: Option<&str>, arg0: Option<&str>, flags: DBusSignalFlags, callback: P ) -> SignalSubscriptionId

pub fn signal_unsubscribe(&self, subscription_id: SignalSubscriptionId)

impl DBusConnection

pub fn for_address_sync( address: &str, flags: DBusConnectionFlags, observer: Option<&DBusAuthObserver>, cancellable: Option<&impl IsA<Cancellable>> ) -> Result<DBusConnection, Error>

pub fn new_sync( stream: &impl IsA<IOStream>, guid: Option<&str>, flags: DBusConnectionFlags, observer: Option<&DBusAuthObserver>, cancellable: Option<&impl IsA<Cancellable>> ) -> Result<DBusConnection, Error>

pub fn call_future( &self, bus_name: Option<&str>, object_path: &str, interface_name: &str, method_name: &str, parameters: Option<&Variant>, reply_type: Option<&VariantTy>, flags: DBusCallFlags, timeout_msec: i32 ) -> Pin<Box_<dyn Future<Output = Result<Variant, Error>> + 'static>>

pub fn call_sync( &self, bus_name: Option<&str>, object_path: &str, interface_name: &str, method_name: &str, parameters: Option<&Variant>, reply_type: Option<&VariantTy>, flags: DBusCallFlags, timeout_msec: i32, cancellable: Option<&impl IsA<Cancellable>> ) -> Result<Variant, Error>

pub fn close<P: FnOnce(Result<(), Error>) + 'static>( &self, cancellable: Option<&impl IsA<Cancellable>>, callback: P )

pub fn close_future( &self ) -> Pin<Box_<dyn Future<Output = Result<(), Error>> + 'static>>

pub fn close_sync( &self, cancellable: Option<&impl IsA<Cancellable>> ) -> Result<(), Error>

pub fn emit_signal( &self, destination_bus_name: Option<&str>, object_path: &str, interface_name: &str, signal_name: &str, parameters: Option<&Variant> ) -> Result<(), Error>

pub fn flush<P: FnOnce(Result<(), Error>) + 'static>( &self, cancellable: Option<&impl IsA<Cancellable>>, callback: P )

pub fn flush_future( &self ) -> Pin<Box_<dyn Future<Output = Result<(), Error>> + 'static>>

pub fn flush_sync( &self, cancellable: Option<&impl IsA<Cancellable>> ) -> Result<(), Error>

pub fn capabilities(&self) -> DBusCapabilityFlags

pub fn exits_on_close(&self) -> bool

pub fn flags(&self) -> DBusConnectionFlags

pub fn guid(&self) -> GString

pub fn last_serial(&self) -> u32

pub fn peer_credentials(&self) -> Option<Credentials>

pub fn stream(&self) -> IOStream

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