zbus/object_server.rs
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811
use event_listener::{Event, EventListener};
use serde::Serialize;
use std::{
collections::{hash_map::Entry, HashMap},
convert::TryInto,
fmt::Write,
marker::PhantomData,
ops::{Deref, DerefMut},
sync::Arc,
};
use tracing::{debug, instrument, trace};
use static_assertions::assert_impl_all;
use zbus_names::InterfaceName;
use zvariant::{ObjectPath, OwnedObjectPath, OwnedValue, Signature, Type, Value};
use crate::{
async_lock::{RwLock, RwLockReadGuard, RwLockWriteGuard},
fdo,
fdo::{Introspectable, ManagedObjects, ObjectManager, Peer, Properties},
Connection, DispatchResult, Error, Interface, Message, Result, SignalContext, WeakConnection,
};
/// Opaque structure that derefs to an `Interface` type.
pub struct InterfaceDeref<'d, I> {
iface: RwLockReadGuard<'d, dyn Interface>,
phantom: PhantomData<I>,
}
impl<I> Deref for InterfaceDeref<'_, I>
where
I: Interface,
{
type Target = I;
fn deref(&self) -> &I {
self.iface.downcast_ref::<I>().unwrap()
}
}
/// Opaque structure that mutably derefs to an `Interface` type.
pub struct InterfaceDerefMut<'d, I> {
iface: RwLockWriteGuard<'d, dyn Interface>,
phantom: PhantomData<I>,
}
impl<I> Deref for InterfaceDerefMut<'_, I>
where
I: Interface,
{
type Target = I;
fn deref(&self) -> &I {
self.iface.downcast_ref::<I>().unwrap()
}
}
impl<I> DerefMut for InterfaceDerefMut<'_, I>
where
I: Interface,
{
fn deref_mut(&mut self) -> &mut Self::Target {
self.iface.downcast_mut::<I>().unwrap()
}
}
/// Wrapper over an interface, along with its corresponding `SignalContext`
/// instance. A reference to the underlying interface may be obtained via
/// [`InterfaceRef::get`] and [`InterfaceRef::get_mut`].
pub struct InterfaceRef<I> {
ctxt: SignalContext<'static>,
lock: Arc<RwLock<dyn Interface>>,
phantom: PhantomData<I>,
}
impl<I> InterfaceRef<I>
where
I: 'static,
{
/// Get a reference to the underlying interface.
///
/// **WARNING:** If methods (e.g property setters) in `ObjectServer` require `&mut self`
/// `ObjectServer` will not be able to access the interface in question until all references
/// of this method are dropped, it is highly recommended that the scope of the interface
/// returned is restricted.
pub async fn get(&self) -> InterfaceDeref<'_, I> {
let iface = self.lock.read().await;
iface
.downcast_ref::<I>()
.expect("Unexpected interface type");
InterfaceDeref {
iface,
phantom: PhantomData,
}
}
/// Get a reference to the underlying interface.
///
/// **WARNINGS:** Since the `ObjectServer` will not be able to access the interface in question
/// until the return value of this method is dropped, it is highly recommended that the scope
/// of the interface returned is restricted.
///
/// # Errors
///
/// If the interface at this instance's path is not valid, `Error::InterfaceNotFound` error is
/// returned.
///
/// # Examples
///
/// ```no_run
/// # use std::error::Error;
/// # use async_io::block_on;
/// # use zbus::{Connection, dbus_interface};
///
/// struct MyIface(u32);
///
/// #[dbus_interface(name = "org.myiface.MyIface")]
/// impl MyIface {
/// #[dbus_interface(property)]
/// async fn count(&self) -> u32 {
/// self.0
/// }
/// }
///
/// # block_on(async {
/// // Setup connection and object_server etc here and then in another part of the code:
/// # let connection = Connection::session().await?;
/// #
/// # let path = "/org/zbus/path";
/// # connection.object_server().at(path, MyIface(22)).await?;
/// let object_server = connection.object_server();
/// let iface_ref = object_server.interface::<_, MyIface>(path).await?;
/// let mut iface = iface_ref.get_mut().await;
/// iface.0 = 42;
/// iface.count_changed(iface_ref.signal_context()).await?;
/// # Ok::<_, Box<dyn Error + Send + Sync>>(())
/// # })?;
/// #
/// # Ok::<_, Box<dyn Error + Send + Sync>>(())
/// ```
pub async fn get_mut(&self) -> InterfaceDerefMut<'_, I> {
let mut iface = self.lock.write().await;
iface
.downcast_ref::<I>()
.expect("Unexpected interface type");
iface
.downcast_mut::<I>()
.expect("Unexpected interface type");
InterfaceDerefMut {
iface,
phantom: PhantomData,
}
}
pub fn signal_context(&self) -> &SignalContext<'static> {
&self.ctxt
}
}
impl<I> Clone for InterfaceRef<I> {
fn clone(&self) -> Self {
Self {
ctxt: self.ctxt.clone(),
lock: self.lock.clone(),
phantom: PhantomData,
}
}
}
#[derive(Default, derivative::Derivative)]
#[derivative(Debug)]
pub(crate) struct Node {
path: OwnedObjectPath,
children: HashMap<String, Node>,
#[derivative(Debug = "ignore")]
interfaces: HashMap<InterfaceName<'static>, Arc<RwLock<dyn Interface>>>,
}
impl Node {
pub(crate) fn new(path: OwnedObjectPath) -> Self {
let mut node = Self {
path,
..Default::default()
};
node.at(Peer::name(), || Arc::new(RwLock::new(Peer)));
node.at(Introspectable::name(), || {
Arc::new(RwLock::new(Introspectable))
});
node.at(Properties::name(), || Arc::new(RwLock::new(Properties)));
node
}
// Get the child Node at path.
pub(crate) fn get_child(&self, path: &ObjectPath<'_>) -> Option<&Node> {
let mut node = self;
for i in path.split('/').skip(1) {
if i.is_empty() {
continue;
}
match node.children.get(i) {
Some(n) => node = n,
None => return None,
}
}
Some(node)
}
// Get the child Node at path. Optionally create one if it doesn't exist.
// It also returns the path of parent node that implements ObjectManager (if any). If multiple
// parents implement it (they shouldn't), then the closest one is returned.
fn get_child_mut(
&mut self,
path: &ObjectPath<'_>,
create: bool,
) -> (Option<&mut Node>, Option<ObjectPath<'_>>) {
let mut node = self;
let mut node_path = String::new();
let mut obj_manager_path = None;
for i in path.split('/').skip(1) {
if i.is_empty() {
continue;
}
if node.interfaces.contains_key(&ObjectManager::name()) {
obj_manager_path = Some((*node.path).clone());
}
write!(&mut node_path, "/{i}").unwrap();
match node.children.entry(i.into()) {
Entry::Vacant(e) => {
if create {
let path = node_path.as_str().try_into().expect("Invalid Object Path");
node = e.insert(Node::new(path));
} else {
return (None, obj_manager_path);
}
}
Entry::Occupied(e) => node = e.into_mut(),
}
}
(Some(node), obj_manager_path)
}
pub(crate) fn interface_lock(
&self,
interface_name: InterfaceName<'_>,
) -> Option<Arc<RwLock<dyn Interface>>> {
self.interfaces.get(&interface_name).cloned()
}
fn remove_interface(&mut self, interface_name: InterfaceName<'static>) -> bool {
self.interfaces.remove(&interface_name).is_some()
}
fn is_empty(&self) -> bool {
!self.interfaces.keys().any(|k| {
*k != Peer::name()
&& *k != Introspectable::name()
&& *k != Properties::name()
&& *k != ObjectManager::name()
})
}
fn remove_node(&mut self, node: &str) -> bool {
self.children.remove(node).is_some()
}
// Takes a closure so caller can avoid having to create an Arc & RwLock in case interface was
// already added.
fn at<F>(&mut self, name: InterfaceName<'static>, iface_creator: F) -> bool
where
F: FnOnce() -> Arc<RwLock<dyn Interface>>,
{
match self.interfaces.entry(name) {
Entry::Vacant(e) => e.insert(iface_creator()),
Entry::Occupied(_) => return false,
};
true
}
#[async_recursion::async_recursion]
async fn introspect_to_writer<W: Write + Send>(&self, writer: &mut W, level: usize) {
if level == 0 {
writeln!(
writer,
r#"
<!DOCTYPE node PUBLIC "-//freedesktop//DTD D-BUS Object Introspection 1.0//EN"
"http://www.freedesktop.org/standards/dbus/1.0/introspect.dtd">
<node>"#
)
.unwrap();
}
for iface in self.interfaces.values() {
iface.read().await.introspect_to_writer(writer, level + 2);
}
for (path, node) in &self.children {
let level = level + 2;
writeln!(
writer,
"{:indent$}<node name=\"{}\">",
"",
path,
indent = level
)
.unwrap();
node.introspect_to_writer(writer, level).await;
writeln!(writer, "{:indent$}</node>", "", indent = level).unwrap();
}
if level == 0 {
writeln!(writer, "</node>").unwrap();
}
}
pub(crate) async fn introspect(&self) -> String {
let mut xml = String::with_capacity(1024);
self.introspect_to_writer(&mut xml, 0).await;
xml
}
#[async_recursion::async_recursion]
pub(crate) async fn get_managed_objects(&self) -> ManagedObjects {
// Recursively get all properties of all interfaces of descendants.
let mut managed_objects = ManagedObjects::new();
for node in self.children.values() {
let mut interfaces = HashMap::new();
for iface_name in node.interfaces.keys().filter(|n| {
// Filter standard interfaces.
*n != &Peer::name()
&& *n != &Introspectable::name()
&& *n != &Properties::name()
&& *n != &ObjectManager::name()
}) {
let props = node.get_properties(iface_name.clone()).await;
interfaces.insert(iface_name.clone().into(), props);
}
managed_objects.insert(node.path.clone(), interfaces);
managed_objects.extend(node.get_managed_objects().await);
}
managed_objects
}
async fn get_properties(
&self,
interface_name: InterfaceName<'_>,
) -> HashMap<String, OwnedValue> {
self.interface_lock(interface_name)
.expect("Interface was added but not found")
.read()
.await
.get_all()
.await
}
}
/// An object server, holding server-side D-Bus objects & interfaces.
///
/// Object servers hold interfaces on various object paths, and expose them over D-Bus.
///
/// All object paths will have the standard interfaces implemented on your behalf, such as
/// `org.freedesktop.DBus.Introspectable` or `org.freedesktop.DBus.Properties`.
///
/// # Example
///
/// This example exposes the `org.myiface.Example.Quit` method on the `/org/zbus/path`
/// path.
///
/// ```no_run
/// # use std::error::Error;
/// use zbus::{Connection, dbus_interface};
/// use event_listener::Event;
/// # use async_io::block_on;
///
/// struct Example {
/// // Interfaces are owned by the ObjectServer. They can have
/// // `&mut self` methods.
/// quit_event: Event,
/// }
///
/// impl Example {
/// fn new(quit_event: Event) -> Self {
/// Self { quit_event }
/// }
/// }
///
/// #[dbus_interface(name = "org.myiface.Example")]
/// impl Example {
/// // This will be the "Quit" D-Bus method.
/// async fn quit(&mut self) {
/// self.quit_event.notify(1);
/// }
///
/// // See `dbus_interface` documentation to learn
/// // how to expose properties & signals as well.
/// }
///
/// # block_on(async {
/// let connection = Connection::session().await?;
///
/// let quit_event = Event::new();
/// let quit_listener = quit_event.listen();
/// let interface = Example::new(quit_event);
/// connection
/// .object_server()
/// .at("/org/zbus/path", interface)
/// .await?;
///
/// quit_listener.await;
/// # Ok::<_, Box<dyn Error + Send + Sync>>(())
/// # })?;
/// # Ok::<_, Box<dyn Error + Send + Sync>>(())
/// ```
#[derive(Debug)]
pub struct ObjectServer {
conn: WeakConnection,
root: RwLock<Node>,
}
assert_impl_all!(ObjectServer: Send, Sync, Unpin);
impl ObjectServer {
/// Creates a new D-Bus `ObjectServer`.
pub(crate) fn new(conn: &Connection) -> Self {
Self {
conn: conn.into(),
root: RwLock::new(Node::new("/".try_into().expect("zvariant bug"))),
}
}
pub(crate) fn root(&self) -> &RwLock<Node> {
&self.root
}
/// Register a D-Bus [`Interface`] at a given path. (see the example above)
///
/// Typically you'd want your interfaces to be registered immediately after the associated
/// connection is established and therefore use [`zbus::ConnectionBuilder::serve_at`] instead.
/// However, there are situations where you'd need to register interfaces dynamically and that's
/// where this method becomes useful.
///
/// If the interface already exists at this path, returns false.
pub async fn at<'p, P, I>(&self, path: P, iface: I) -> Result<bool>
where
I: Interface,
P: TryInto<ObjectPath<'p>>,
P::Error: Into<Error>,
{
self.at_ready(path, I::name(), move || Arc::new(RwLock::new(iface)))
.await
}
/// Same as `at` but expects an interface already in `Arc<RwLock<dyn Interface>>` form.
// FIXME: Better name?
pub(crate) async fn at_ready<'node, 'p, P, F>(
&'node self,
path: P,
name: InterfaceName<'static>,
iface_creator: F,
) -> Result<bool>
where
// Needs to be hardcoded as 'static instead of 'p like most other
// functions, due to https://github.com/rust-lang/rust/issues/63033
// (It doesn't matter a whole lot since this is an internal-only API
// anyway.)
P: TryInto<ObjectPath<'p>>,
P::Error: Into<Error>,
F: FnOnce() -> Arc<RwLock<dyn Interface + 'static>>,
{
let path = path.try_into().map_err(Into::into)?;
let mut root = self.root().write().await;
let (node, manager_path) = root.get_child_mut(&path, true);
let node = node.unwrap();
let added = node.at(name.clone(), iface_creator);
if added {
if name == ObjectManager::name() {
// Just added an object manager. Need to signal all managed objects under it.
let ctxt = SignalContext::new(&self.connection(), path)?;
let objects = node.get_managed_objects().await;
for (path, owned_interfaces) in objects {
let interfaces = owned_interfaces
.iter()
.map(|(i, props)| {
let props = props
.iter()
.map(|(k, v)| (k.as_str(), Value::from(v)))
.collect();
(i.into(), props)
})
.collect();
ObjectManager::interfaces_added(&ctxt, &path, &interfaces).await?;
}
} else if let Some(manager_path) = manager_path {
let ctxt = SignalContext::new(&self.connection(), manager_path.clone())?;
let mut interfaces = HashMap::new();
let owned_props = node.get_properties(name.clone()).await;
let props = owned_props
.iter()
.map(|(k, v)| (k.as_str(), Value::from(v)))
.collect();
interfaces.insert(name, props);
ObjectManager::interfaces_added(&ctxt, &path, &interfaces).await?;
}
}
Ok(added)
}
/// Unregister a D-Bus [`Interface`] at a given path.
///
/// If there are no more interfaces left at that path, destroys the object as well.
/// Returns whether the object was destroyed.
pub async fn remove<'p, I, P>(&self, path: P) -> Result<bool>
where
I: Interface,
P: TryInto<ObjectPath<'p>>,
P::Error: Into<Error>,
{
let path = path.try_into().map_err(Into::into)?;
let mut root = self.root.write().await;
let (node, manager_path) = root.get_child_mut(&path, false);
let node = node.ok_or(Error::InterfaceNotFound)?;
if !node.remove_interface(I::name()) {
return Err(Error::InterfaceNotFound);
}
if let Some(manager_path) = manager_path {
let ctxt = SignalContext::new(&self.connection(), manager_path.clone())?;
ObjectManager::interfaces_removed(&ctxt, &path, &[I::name()]).await?;
}
if node.is_empty() {
let mut path_parts = path.rsplit('/').filter(|i| !i.is_empty());
let last_part = path_parts.next().unwrap();
let ppath = ObjectPath::from_string_unchecked(
path_parts.fold(String::new(), |a, p| format!("/{p}{a}")),
);
root.get_child_mut(&ppath, false)
.0
.unwrap()
.remove_node(last_part);
return Ok(true);
}
Ok(false)
}
/// Get the interface at the given path.
///
/// # Errors
///
/// If the interface is not registered at the given path, `Error::InterfaceNotFound` error is
/// returned.
///
/// # Examples
///
/// The typical use of this is property changes outside of a dispatched handler:
///
/// ```no_run
/// # use std::error::Error;
/// # use zbus::{Connection, dbus_interface};
/// # use async_io::block_on;
/// #
/// struct MyIface(u32);
///
/// #[dbus_interface(name = "org.myiface.MyIface")]
/// impl MyIface {
/// #[dbus_interface(property)]
/// async fn count(&self) -> u32 {
/// self.0
/// }
/// }
///
/// # block_on(async {
/// # let connection = Connection::session().await?;
/// #
/// # let path = "/org/zbus/path";
/// # connection.object_server().at(path, MyIface(0)).await?;
/// let iface_ref = connection
/// .object_server()
/// .interface::<_, MyIface>(path).await?;
/// let mut iface = iface_ref.get_mut().await;
/// iface.0 = 42;
/// iface.count_changed(iface_ref.signal_context()).await?;
/// # Ok::<_, Box<dyn Error + Send + Sync>>(())
/// # })?;
/// #
/// # Ok::<_, Box<dyn Error + Send + Sync>>(())
/// ```
pub async fn interface<'p, P, I>(&self, path: P) -> Result<InterfaceRef<I>>
where
I: Interface,
P: TryInto<ObjectPath<'p>>,
P::Error: Into<Error>,
{
let path = path.try_into().map_err(Into::into)?;
let root = self.root().read().await;
let node = root.get_child(&path).ok_or(Error::InterfaceNotFound)?;
let lock = node
.interface_lock(I::name())
.ok_or(Error::InterfaceNotFound)?
.clone();
// Ensure what we return can later be dowcasted safely.
lock.read()
.await
.downcast_ref::<I>()
.ok_or(Error::InterfaceNotFound)?;
let conn = self.connection();
// SAFETY: We know that there is a valid path on the node as we already converted w/o error.
let ctxt = SignalContext::new(&conn, path).unwrap().into_owned();
Ok(InterfaceRef {
ctxt,
lock,
phantom: PhantomData,
})
}
#[instrument(skip(self, connection))]
async fn dispatch_method_call_try(
&self,
connection: &Connection,
msg: &Message,
) -> fdo::Result<Result<()>> {
let path = msg
.path()
.ok_or_else(|| fdo::Error::Failed("Missing object path".into()))?;
let iface_name = msg
.interface()
// TODO: In the absence of an INTERFACE field, if two or more interfaces on the same
// object have a method with the same name, it is undefined which of those
// methods will be invoked. Implementations may choose to either return an
// error, or deliver the message as though it had an arbitrary one of those
// interfaces.
.ok_or_else(|| fdo::Error::Failed("Missing interface".into()))?;
let member = msg
.member()
.ok_or_else(|| fdo::Error::Failed("Missing member".into()))?;
// Ensure the root lock isn't held while dispatching the message. That
// way, the object server can be mutated during that time.
let iface = {
let root = self.root.read().await;
let node = root
.get_child(&path)
.ok_or_else(|| fdo::Error::UnknownObject(format!("Unknown object '{path}'")))?;
node.interface_lock(iface_name.as_ref()).ok_or_else(|| {
fdo::Error::UnknownInterface(format!("Unknown interface '{iface_name}'"))
})?
};
trace!("acquiring read lock on interface `{}`", iface_name);
let read_lock = iface.read().await;
trace!("acquired read lock on interface `{}`", iface_name);
match read_lock.call(self, connection, msg, member.as_ref()) {
DispatchResult::NotFound => {
return Err(fdo::Error::UnknownMethod(format!(
"Unknown method '{member}'"
)));
}
DispatchResult::Async(f) => {
return Ok(f.await);
}
DispatchResult::RequiresMut => {}
}
drop(read_lock);
trace!("acquiring write lock on interface `{}`", iface_name);
let mut write_lock = iface.write().await;
trace!("acquired write lock on interface `{}`", iface_name);
match write_lock.call_mut(self, connection, msg, member.as_ref()) {
DispatchResult::NotFound => {}
DispatchResult::RequiresMut => {}
DispatchResult::Async(f) => {
return Ok(f.await);
}
}
drop(write_lock);
Err(fdo::Error::UnknownMethod(format!(
"Unknown method '{member}'"
)))
}
#[instrument(skip(self, connection))]
async fn dispatch_method_call(&self, connection: &Connection, msg: &Message) -> Result<()> {
match self.dispatch_method_call_try(connection, msg).await {
Err(e) => {
let hdr = msg.header()?;
debug!("Returning error: {}", e);
connection.reply_dbus_error(&hdr, e).await?;
Ok(())
}
Ok(r) => r,
}
}
/// Dispatch an incoming message to a registered interface.
///
/// The object server will handle the message by:
///
/// - looking up the called object path & interface,
///
/// - calling the associated method if one exists,
///
/// - returning a message (responding to the caller with either a return or error message) to
/// the caller through the associated server connection.
///
/// Returns an error if the message is malformed, true if it's handled, false otherwise.
#[instrument(skip(self))]
pub(crate) async fn dispatch_message(&self, msg: &Message) -> Result<bool> {
let conn = self.connection();
self.dispatch_method_call(&conn, msg).await?;
trace!("Handled: {}", msg);
Ok(true)
}
pub(crate) fn connection(&self) -> Connection {
self.conn
.upgrade()
.expect("ObjectServer can't exist w/o an associated Connection")
}
}
impl From<crate::blocking::ObjectServer> for ObjectServer {
fn from(server: crate::blocking::ObjectServer) -> Self {
server.into_inner()
}
}
/// A response wrapper that notifies after response has been sent.
///
/// Sometimes in [`dbus_interface`] method implemenations we need to do some other work after the
/// response has been sent off. This wrapper type allows us to do that. Instead of returning your
/// intended response type directly, wrap it in this type and return it from your method. The
/// returned `EventListener` from `new` method will be notified when the response has been sent.
///
/// A typical use case is sending off signals after the response has been sent. The easiest way to
/// do that is to spawn a task from the method that sends the signal but only after being notified
/// of the response dispatch.
///
/// # Caveats
///
/// The notification indicates that the response has been sent off, not that destination peer has
/// received it. That can only be guaranteed for a peer-to-peer connection.
///
/// [`dbus_interface`]: crate::dbus_interface
#[derive(Debug)]
pub struct ResponseDispatchNotifier<R> {
response: R,
event: Option<Event>,
}
impl<R> ResponseDispatchNotifier<R> {
/// Create a new `NotifyResponse`.
pub fn new(response: R) -> (Self, EventListener) {
let event = Event::new();
let listener = event.listen();
(
Self {
response,
event: Some(event),
},
listener,
)
}
}
impl<R> Serialize for ResponseDispatchNotifier<R>
where
R: Serialize,
{
fn serialize<S>(&self, serializer: S) -> std::result::Result<S::Ok, S::Error>
where
S: serde::Serializer,
{
self.response.serialize(serializer)
}
}
impl<R> Type for ResponseDispatchNotifier<R>
where
R: Type,
{
fn signature() -> Signature<'static> {
R::signature()
}
}
impl<T> Drop for ResponseDispatchNotifier<T> {
fn drop(&mut self) {
if let Some(event) = self.event.take() {
event.notify(usize::MAX);
}
}
}