Struct zbus::blocking::Connection

pub struct Connection { /* fields omitted */ }

A blocking wrapper of zbus::Connection.

Most of the API is very similar to zbus::Connection, except it’s blocking. One notable difference is that there is no equivalent of Sink implementation provided.

Implementations

impl Connection

pub fn session() -> Result<Self>

Create a Connection to the session/user message bus.

pub fn system() -> Result<Self>

Create a Connection to the system-wide message bus.

pub fn max_queued(&self) -> usize

Max number of messages to queue.

pub fn set_max_queued(self, max: usize)

Set the max number of messages to queue.

pub fn server_guid(&self) -> &str

The server’s GUID.

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

The unique name as assigned by the message bus or None if not a message bus connection.

pub fn send_message(&self, msg: Message) -> Result<u32>

Send msg to the peer.

The connection sets a unique serial number on the message before sending it off.

On successfully sending off msg, the assigned serial number is returned.

pub fn call_method<'d, 'p, 'i, 'm, D, P, I, M, B>(
    &self,
    destination: Option<D>,
    path: P,
    iface: Option<I>,
    method_name: M,
    body: &B
) -> Result<Arc<Message>> where
    D: TryInto<BusName<'d>>,
    P: TryInto<ObjectPath<'p>>,
    I: TryInto<InterfaceName<'i>>,
    M: TryInto<MemberName<'m>>,
    D::Error: Into<Error>,
    P::Error: Into<Error>,
    I::Error: Into<Error>,
    M::Error: Into<Error>,
    B: Serialize + DynamicType, 

Send a method call.

Create a method-call message, send it over the connection, then wait for the reply. Incoming messages are received through receive_message until the matching method reply (error or return) is received.

On successful reply, an Ok(Message) is returned. On error, an Err is returned. D-Bus error replies are returned as MethodError.

pub fn emit_signal<'d, 'p, 'i, 'm, D, P, I, M, B>(
    &self,
    destination: Option<D>,
    path: P,
    iface: I,
    signal_name: M,
    body: &B
) -> Result<()> where
    D: TryInto<BusName<'d>>,
    P: TryInto<ObjectPath<'p>>,
    I: TryInto<InterfaceName<'i>>,
    M: TryInto<MemberName<'m>>,
    D::Error: Into<Error>,
    P::Error: Into<Error>,
    I::Error: Into<Error>,
    M::Error: Into<Error>,
    B: Serialize + DynamicType, 

Emit a signal.

Create a signal message, and send it over the connection.

pub fn reply<B>(&self, call: &Message, body: &B) -> Result<u32> where
    B: Serialize + DynamicType, 

Reply to a message.

Given an existing message (likely a method call), send a reply back to the caller with the given body.

Returns the message serial number.

pub fn reply_error<'e, E, B>(
    &self,
    call: &Message,
    error_name: E,
    body: &B
) -> Result<u32> where
    B: Serialize + DynamicType,
    E: TryInto<ErrorName<'e>>,
    E::Error: Into<Error>, 

Reply an error to a message.

Given an existing message (likely a method call), send an error reply back to the caller with the given error_name and body.

Returns the message serial number.

pub fn reply_dbus_error(
    &self,
    call: &MessageHeader<'_>,
    err: impl DBusError
) -> Result<u32>

Reply to a method call with an error.

Given an existing method call message header, send an error reply back to the caller using one of the standard interface reply types.

Returns the message serial number.

pub fn request_name<'w, W>(&self, well_known_name: W) -> Result<()> where
    W: TryInto<WellKnownName<'w>>,
    W::Error: Into<Error>, 

Register a well-known name for this service on the bus.

You can request multiple names for the same ObjectServer. Use Connection::release_name for deregistering names registered through this method.

Note that exclusive ownership without queueing is requested (using crate::fdo::RequestNameFlags::ReplaceExisting and crate::fdo::RequestNameFlags::DoNotQueue flags) since that is the most typical case. If that is not what you want, you should use crate::fdo::DBusProxy::request_name instead (but make sure then that name is requested after you’ve setup your service implementation with the ObjectServer).

pub fn release_name<'w, W>(&self, well_known_name: W) -> Result<bool> where
    W: TryInto<WellKnownName<'w>>,
    W::Error: Into<Error>, 

Deregister a previously registered well-known name for this service on the bus.

Use this method to deregister a well-known name, registered through Connection::request_name.

Unless an error is encountered, returns Ok(true) if name was previously registered with the bus through self and it has now been successfully deregistered, Ok(false) if name was not previously registered or already deregistered.

pub fn is_bus(&self) -> bool

Checks if self is a connection to a message bus.

This will return false for p2p connections.

pub fn object_server(&self) -> impl Deref<Target = ObjectServer> + '_

Get a reference to the associated ObjectServer.

The ObjectServer is created on-demand.

pub fn inner(&self) -> &Connection

Get a reference to the underlying async Connection.

pub fn into_inner(self) -> Connection

Get the underlying async Connection, consuming self.

pub fn monitor_activity(&self) -> EventListener

Returns a listener, notified on various connection activity.

This function is meant for the caller to implement idle or timeout on inactivity.

Trait Implementations

impl Clone for Connection

fn clone(&self) -> Connection

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Connection

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

Formats the value using the given formatter.

impl From<&'_ Connection> for MessageIterator

fn from(conn: &Connection) -> Self

Performs the conversion.

impl From<Connection> for Connection

fn from(conn: Connection) -> Self

Performs the conversion.

impl From<Connection> for Connection

fn from(conn: Connection) -> Self

Performs the conversion.

impl From<Connection> for MessageIterator

fn from(conn: Connection) -> Self

Performs the conversion.