Struct calloop_dbus::DBusSource

pub struct DBusSource<Data: 'static> { /* fields omitted */ }

A event source connection to D-Bus, non-async version where callbacks are Send but not Sync.

Implementations

impl<Data> DBusSource<Data>

pub fn new_session() -> Result<(Self, Sender<Message>)>

Create a new connection to the session bus.

pub fn new_system() -> Result<(Self, Sender<Message>)>

Create a new connection to the system-wide bus.

pub fn unique_name(&self) -> BusName

Get the connection's unique name.

It's usually something like ":1.54"

pub fn with_proxy<'a, 'b, Dest: Into<BusName<'a>>, BusPath: Into<Path<'a>>>(
    &'b self,
    dest: Dest,
    path: BusPath,
    timeout: Duration
) -> Proxy<'a, &'b Self>

pub fn request_name<'a, Name: Into<BusName<'a>>>(
    &self,
    name: Name,
    allow_replacement: bool,
    replace_existing: bool,
    do_not_queue: bool
) -> Result<RequestNameReply, Error>

Request a name on the D-Bus.

For detailed information on the flags and return values, see the libdbus documentation.

pub fn release_name<'a, Name: Into<BusName<'a>>>(
    &self,
    name: Name
) -> Result<ReleaseNameReply, Error>

Release a previously requested name on the D-Bus.

pub fn add_match<Args: ReadAll, Callback>(
    &self,
    match_rule: MatchRule<'static>,
    callback: Callback
) -> Result<Token, Error> where
    Callback: FnMut(Args, &Self, &Message) -> bool + Send + 'static, 

Adds a new match to the connection, and sets up a callback when this message arrives.

The returned value can be used to remove the match. The match is also removed if the callback returns "false".

pub fn add_match_data<Args: ReadAll, Callback>(
    &self,
    match_rule: MatchRule<'static>,
    callback: Callback
) -> Result<Token, Error> where
    Callback: FnMut(Args, &Self, &Message, &mut Data) -> bool + Send + 'static, 

Adds a new match to the connection, and sets up a callback when this message arrives. This callback will be able to access the calloop user data.

The returned value can be used to remove the match. The match is also removed if the callback returns "false".

pub fn remove_match(&self, id: Token) -> Result<(), Error>

Removes a previously added match and callback from the connection.

pub fn process(&mut self, timeout: Duration) -> Result<bool, Error>

pub fn channel(&self) -> &Channel

The Channel for this connection

pub fn quick_insert(
    self,
    handle: LoopHandle<Data>,
    panic_on_orphan: bool
) -> Result<Source<DBusSource<Data>>, InsertError<DBusSource<Data>>>

Insert this source into the given event loop with an adapder that ether panics on orphan events or just logs it at warn level. You probably only what this if you set eavesdrop on a MatchRule.

Trait Implementations

impl<Data> BlockingSender for DBusSource<Data>

fn send_with_reply_and_block(
    &self,
    msg: Message,
    timeout: Duration
) -> Result<Message, Error>

Sends a message over the D-Bus and blocks, waiting for a reply or a timeout. This is used for method calls.

impl<Data> EventSource for DBusSource<Data>

type Event = Message

The type of events generated by your source.

type Metadata = DBusSource<Data>

Some metadata of your event source

type Ret = Option<Token>

The return type of the user callback

fn process_events<Callback>(
    &mut self,
    readiness: Readiness,
    token: Token,
    callback: Callback
) -> Result<()> where
    Callback: FnMut(Self::Event, &mut Self::Metadata) -> Self::Ret, 

Process any relevant events

fn register(&mut self, poll: &mut Poll, token: Token) -> Result<()>

Register yourself to this poll instance

fn reregister(&mut self, poll: &mut Poll, token: Token) -> Result<()>

Re-register your file descriptors

fn unregister(&mut self, poll: &mut Poll) -> Result<()>

Unregister your file descriptors

impl<Args: ReadAll, Callback: FnMut(Args, &DBusSource<Data>, &Message, &mut Data) -> bool + Send + 'static, Data> MakeDataSignal<Box<dyn FnMut(Message, &DBusSource<Data>, &mut Data) + 'static + Send>, Args, DBusSource<Data>> for Callback

fn make(
    self,
    match_str: String
) -> Box<dyn FnMut(Message, &DBusSource<Data>, &mut Data) -> bool + Send + 'static>

Internal helper trait

impl<Args: ReadAll, Callback: FnMut(Args, &DBusSource<Data>, &Message) -> bool + Send + 'static, Data> MakeSignal<Box<dyn FnMut(Message, &DBusSource<Data>, &mut Data) + 'static + Send>, Args, DBusSource<Data>> for Callback

fn make(
    self,
    match_str: String
) -> Box<dyn FnMut(Message, &DBusSource<Data>, &mut Data) -> bool + Send + 'static>

Internal helper trait

impl<Data> MatchingReceiver for DBusSource<Data>

type F = Box<dyn FnMut(Message, &DBusSource<Data>, &mut Data) -> bool + Send + 'static>

Type of callback

fn start_receive(
    &self,
    match_rule: MatchRule<'static>,
    callback: Self::F
) -> Token

Add a callback to be called in case a message matches.

fn stop_receive(&self, id: Token) -> Option<(MatchRule<'static>, Self::F)>

Remove a previously added callback.

impl<Data> Sender for DBusSource<Data>

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

Schedules a message for sending.