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 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497
use enumflags2::{bitflags, BitFlags};
use event_listener::{Event, EventListener};
use futures_core::{ready, stream};
use futures_util::{future::Either, stream::Map};
use once_cell::sync::OnceCell;
use ordered_stream::{join as join_streams, FromFuture, Join, OrderedStream, PollResult};
use static_assertions::assert_impl_all;
use std::{
collections::{HashMap, HashSet},
convert::{TryFrom, TryInto},
future::Future,
ops::Deref,
pin::Pin,
sync::{Arc, RwLock, RwLockReadGuard},
task::{Context, Poll},
};
use tracing::{debug, info_span, instrument, trace, Instrument};
use zbus_names::{BusName, InterfaceName, MemberName, UniqueName};
use zvariant::{ObjectPath, OwnedValue, Str, Value};
use crate::{
fdo::{self, IntrospectableProxy, NameOwnerChanged, PropertiesChangedStream, PropertiesProxy},
AsyncDrop, CacheProperties, Connection, Error, Executor, MatchRule, Message, MessageFlags,
MessageSequence, MessageStream, MessageType, OwnedMatchRule, ProxyBuilder, Result, Task,
};
/// A client-side interface proxy.
///
/// A `Proxy` is a helper to interact with an interface on a remote object.
///
/// # Example
///
/// ```
/// use std::result::Result;
/// use std::error::Error;
/// use zbus::{Connection, Proxy};
///
/// #[tokio::main]
/// async fn main() -> Result<(), Box<dyn Error>> {
/// let connection = Connection::session().await?;
/// let p = Proxy::new(
/// &connection,
/// "org.freedesktop.DBus",
/// "/org/freedesktop/DBus",
/// "org.freedesktop.DBus",
/// ).await?;
/// // owned return value
/// let _id: String = p.call("GetId", &()).await?;
/// // borrowed return value
/// let _id: &str = p.call_method("GetId", &()).await?.body()?;
///
/// Ok(())
/// }
/// ```
///
/// # Note
///
/// It is recommended to use the [`dbus_proxy`] macro, which provides a more convenient and
/// type-safe *façade* `Proxy` derived from a Rust trait.
///
/// [`futures` crate]: https://crates.io/crates/futures
/// [`dbus_proxy`]: attr.dbus_proxy.html
#[derive(Clone, Debug)]
pub struct Proxy<'a> {
pub(crate) inner: Arc<ProxyInner<'a>>,
}
assert_impl_all!(Proxy<'_>: Send, Sync, Unpin);
/// This is required to avoid having the Drop impl extend the lifetime 'a, which breaks zbus_xmlgen
/// (and possibly other crates).
#[derive(derivative::Derivative)]
#[derivative(Debug)]
pub(crate) struct ProxyInnerStatic {
#[derivative(Debug = "ignore")]
pub(crate) conn: Connection,
dest_owner_change_match_rule: OnceCell<OwnedMatchRule>,
}
#[derive(Debug)]
pub(crate) struct ProxyInner<'a> {
inner_without_borrows: ProxyInnerStatic,
pub(crate) destination: BusName<'a>,
pub(crate) path: ObjectPath<'a>,
pub(crate) interface: InterfaceName<'a>,
/// Cache of property values.
property_cache: Option<OnceCell<(Arc<PropertiesCache>, Task<()>)>>,
/// Set of properties which do not get cached, by name.
/// This overrides proxy-level caching behavior.
uncached_properties: HashSet<Str<'a>>,
}
impl Drop for ProxyInnerStatic {
fn drop(&mut self) {
if let Some(rule) = self.dest_owner_change_match_rule.take() {
self.conn.queue_remove_match(rule);
}
}
}
/// A property changed event.
///
/// The property changed event generated by [`PropertyStream`].
pub struct PropertyChanged<'a, T> {
name: &'a str,
properties: Arc<PropertiesCache>,
proxy: Proxy<'a>,
phantom: std::marker::PhantomData<T>,
}
impl<'a, T> PropertyChanged<'a, T> {
// The name of the property that changed.
pub fn name(&self) -> &str {
self.name
}
// Get the raw value of the property that changed.
//
// If the notification signal contained the new value, it has been cached already and this call
// will return that value. Otherwise (i-e invalidated property), a D-Bus call is made to fetch
// and cache the new value.
pub async fn get_raw<'p>(&'p self) -> Result<impl Deref<Target = Value<'static>> + 'p> {
struct Wrapper<'w> {
name: &'w str,
values: RwLockReadGuard<'w, HashMap<String, PropertyValue>>,
}
impl<'w> Deref for Wrapper<'w> {
type Target = Value<'static>;
fn deref(&self) -> &Self::Target {
self.values
.get(self.name)
.expect("PropertyStream with no corresponding property")
.value
.as_ref()
.expect("PropertyStream with no corresponding property")
}
}
{
let values = self.properties.values.read().expect("lock poisoned");
if values
.get(self.name)
.expect("PropertyStream with no corresponding property")
.value
.is_some()
{
return Ok(Wrapper {
name: self.name,
values,
});
}
}
// The property was invalidated, so we need to fetch the new value.
let properties_proxy = self.proxy.properties_proxy();
let value = properties_proxy
.get(self.proxy.inner.interface.clone(), self.name)
.await
.map_err(crate::Error::from)?;
// Save the new value
{
let mut values = self.properties.values.write().expect("lock poisoned");
values
.get_mut(self.name)
.expect("PropertyStream with no corresponding property")
.value = Some(value);
}
Ok(Wrapper {
name: self.name,
values: self.properties.values.read().expect("lock poisoned"),
})
}
}
impl<T> PropertyChanged<'_, T>
where
T: TryFrom<zvariant::OwnedValue>,
T::Error: Into<crate::Error>,
{
// Get the value of the property that changed.
//
// If the notification signal contained the new value, it has been cached already and this call
// will return that value. Otherwise (i-e invalidated property), a D-Bus call is made to fetch
// and cache the new value.
pub async fn get(&self) -> Result<T> {
self.get_raw()
.await
.and_then(|v| T::try_from(OwnedValue::from(&*v)).map_err(Into::into))
}
}
/// A [`stream::Stream`] implementation that yields property change notifications.
///
/// Use [`Proxy::receive_property_changed`] to create an instance of this type.
#[derive(derivative::Derivative)]
#[derivative(Debug)]
pub struct PropertyStream<'a, T> {
name: &'a str,
proxy: Proxy<'a>,
changed_listener: EventListener,
phantom: std::marker::PhantomData<T>,
}
impl<'a, T> stream::Stream for PropertyStream<'a, T>
where
T: Unpin,
{
type Item = PropertyChanged<'a, T>;
fn poll_next(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Option<Self::Item>> {
let m = self.get_mut();
let properties = match m.proxy.get_property_cache() {
Some(properties) => properties.clone(),
// With no cache, we will get no updates; return immediately
None => return Poll::Ready(None),
};
ready!(Pin::new(&mut m.changed_listener).poll(cx));
m.changed_listener = properties
.values
.read()
.expect("lock poisoned")
.get(m.name)
.expect("PropertyStream with no corresponding property")
.event
.listen();
Poll::Ready(Some(PropertyChanged {
name: m.name,
properties,
proxy: m.proxy.clone(),
phantom: std::marker::PhantomData,
}))
}
}
#[derive(Debug)]
pub(crate) struct PropertiesCache {
values: RwLock<HashMap<String, PropertyValue>>,
caching_result: RwLock<CachingResult>,
}
#[derive(Debug)]
enum CachingResult {
Caching { ready: Event },
Cached { result: Result<()> },
}
impl PropertiesCache {
#[instrument(skip_all)]
fn new(
proxy: PropertiesProxy<'static>,
interface: InterfaceName<'static>,
executor: &Executor<'_>,
uncached_properties: HashSet<zvariant::Str<'static>>,
) -> (Arc<Self>, Task<()>) {
let cache = Arc::new(PropertiesCache {
values: Default::default(),
caching_result: RwLock::new(CachingResult::Caching {
ready: Event::new(),
}),
});
let cache_clone = cache.clone();
let task_name = format!("{interface} proxy caching");
let proxy_caching = async move {
let result = cache_clone
.init(proxy, interface, uncached_properties)
.await;
let (prop_changes, interface, uncached_properties) = {
let mut caching_result = cache_clone.caching_result.write().expect("lock poisoned");
let ready = match &*caching_result {
CachingResult::Caching { ready } => ready,
// SAFETY: This is the only part of the code that changes this state and it's
// only run once.
_ => unreachable!(),
};
match result {
Ok((prop_changes, interface, uncached_properties)) => {
ready.notify(usize::MAX);
*caching_result = CachingResult::Cached { result: Ok(()) };
(prop_changes, interface, uncached_properties)
}
Err(e) => {
ready.notify(usize::MAX);
*caching_result = CachingResult::Cached { result: Err(e) };
return;
}
}
};
if let Err(e) = cache_clone
.keep_updated(prop_changes, interface, uncached_properties)
.await
{
debug!("Error keeping properties cache updated: {e}");
}
}
.instrument(info_span!("{}", task_name));
let task = executor.spawn(proxy_caching, &task_name);
(cache, task)
}
// new() runs this in a task it spawns for initialization of properties cache.
async fn init(
&self,
proxy: PropertiesProxy<'static>,
interface: InterfaceName<'static>,
uncached_properties: HashSet<zvariant::Str<'static>>,
) -> Result<(
PropertiesChangedStream<'static>,
InterfaceName<'static>,
HashSet<zvariant::Str<'static>>,
)> {
use ordered_stream::OrderedStreamExt;
let prop_changes = proxy.receive_properties_changed().await?.map(Either::Left);
let get_all = proxy
.connection()
.call_method_raw(
Some(proxy.destination()),
proxy.path(),
Some(proxy.interface()),
"GetAll",
BitFlags::empty(),
&interface,
)
.await
.map(|r| FromFuture::from(r.expect("no reply")).map(Either::Right))?;
let mut join = join_streams(prop_changes, get_all);
loop {
match join.next().await {
Some(Either::Left(_update)) => {
// discard updates prior to the initial population
}
Some(Either::Right(populate)) => {
populate?.body().map(|values| {
self.update_cache(&uncached_properties, &values, Vec::new(), &interface);
})?;
break;
}
None => break,
}
}
if let Some((Either::Left(update), _)) = Pin::new(&mut join).take_buffered() {
// if an update was buffered, then it happened after the get_all returned and needs to
// be applied before we discard the join
if let Ok(args) = update.args() {
if args.interface_name == interface {
self.update_cache(
&uncached_properties,
&args.changed_properties,
args.invalidated_properties,
&interface,
);
}
}
}
// This is needed to avoid a "implementation of `OrderedStream` is not general enough"
// error that occurs if you apply the map and join to Pin::new(&mut prop_changes) instead
// of directly to the stream.
let prop_changes = join.into_inner().0.into_inner();
Ok((prop_changes, interface, uncached_properties))
}
// new() runs this in a task it spawns for keeping the cache in sync.
#[instrument(skip_all)]
async fn keep_updated(
&self,
mut prop_changes: PropertiesChangedStream<'static>,
interface: InterfaceName<'static>,
uncached_properties: HashSet<zvariant::Str<'static>>,
) -> Result<()> {
use futures_util::StreamExt;
trace!("Listening for property changes on {interface}...");
while let Some(update) = prop_changes.next().await {
if let Ok(args) = update.args() {
if args.interface_name == interface {
self.update_cache(
&uncached_properties,
&args.changed_properties,
args.invalidated_properties,
&interface,
);
}
}
}
Ok(())
}
fn update_cache(
&self,
uncached_properties: &HashSet<Str<'_>>,
changed: &HashMap<&str, Value<'_>>,
invalidated: Vec<&str>,
interface: &InterfaceName<'_>,
) {
let mut values = self.values.write().expect("lock poisoned");
for inval in invalidated {
if uncached_properties.contains(&Str::from(inval)) {
debug!(
"Ignoring invalidation of uncached property `{}.{}`",
interface, inval
);
continue;
}
trace!("Property `{interface}.{inval}` invalidated");
if let Some(entry) = values.get_mut(inval) {
entry.value = None;
entry.event.notify(usize::MAX);
}
}
for (property_name, value) in changed {
if uncached_properties.contains(&Str::from(*property_name)) {
debug!(
"Ignoring update of uncached property `{}.{}`",
interface, property_name
);
continue;
}
trace!("Property `{interface}.{property_name}` updated");
let entry = values.entry(property_name.to_string()).or_default();
entry.value = Some(OwnedValue::from(value));
entry.event.notify(usize::MAX);
}
}
/// Wait for the cache to be populated and return any error encountered during population
pub(crate) async fn ready(&self) -> Result<()> {
let listener = match &*self.caching_result.read().expect("lock poisoned") {
CachingResult::Caching { ready } => ready.listen(),
CachingResult::Cached { result } => return result.clone(),
};
listener.await;
// It must be ready now.
match &*self.caching_result.read().expect("lock poisoned") {
// SAFETY: We were just notified that state has changed to `Cached` and we never go back
// to `Caching` once in `Cached`.
CachingResult::Caching { .. } => unreachable!(),
CachingResult::Cached { result } => result.clone(),
}
}
}
impl<'a> ProxyInner<'a> {
pub(crate) fn new(
conn: Connection,
destination: BusName<'a>,
path: ObjectPath<'a>,
interface: InterfaceName<'a>,
cache: CacheProperties,
uncached_properties: HashSet<Str<'a>>,
) -> Self {
let property_cache = match cache {
CacheProperties::Yes | CacheProperties::Lazily => Some(OnceCell::new()),
CacheProperties::No => None,
};
Self {
inner_without_borrows: ProxyInnerStatic {
conn,
dest_owner_change_match_rule: OnceCell::new(),
},
destination,
path,
interface,
property_cache,
uncached_properties,
}
}
/// Subscribe to the "NameOwnerChanged" signal on the bus for our destination.
///
/// If the destination is a unique name, we will not subscribe to the signal.
pub(crate) async fn subscribe_dest_owner_change(&self) -> Result<()> {
if !self.inner_without_borrows.conn.is_bus() {
// Names don't mean much outside the bus context.
return Ok(());
}
let well_known_name = match &self.destination {
BusName::WellKnown(well_known_name) => well_known_name,
BusName::Unique(_) => return Ok(()),
};
if self
.inner_without_borrows
.dest_owner_change_match_rule
.get()
.is_some()
{
// Already watching over the bus for any name updates so nothing to do here.
return Ok(());
}
let conn = &self.inner_without_borrows.conn;
let signal_rule: OwnedMatchRule = MatchRule::builder()
.msg_type(MessageType::Signal)
.sender("org.freedesktop.DBus")?
.path("/org/freedesktop/DBus")?
.interface("org.freedesktop.DBus")?
.member("NameOwnerChanged")?
.add_arg(well_known_name.as_str())?
.build()
.to_owned()
.into();
conn.add_match(
signal_rule.clone(),
Some(MAX_NAME_OWNER_CHANGED_SIGNALS_QUEUED),
)
.await?;
if self
.inner_without_borrows
.dest_owner_change_match_rule
.set(signal_rule.clone())
.is_err()
{
// we raced another destination_unique_name call and added it twice
conn.remove_match(signal_rule).await?;
}
Ok(())
}
}
const MAX_NAME_OWNER_CHANGED_SIGNALS_QUEUED: usize = 8;
impl<'a> Proxy<'a> {
/// Create a new `Proxy` for the given destination/path/interface.
pub async fn new<D, P, I>(
conn: &Connection,
destination: D,
path: P,
interface: I,
) -> Result<Proxy<'a>>
where
D: TryInto<BusName<'a>>,
P: TryInto<ObjectPath<'a>>,
I: TryInto<InterfaceName<'a>>,
D::Error: Into<Error>,
P::Error: Into<Error>,
I::Error: Into<Error>,
{
ProxyBuilder::new_bare(conn)
.destination(destination)?
.path(path)?
.interface(interface)?
.build()
.await
}
/// Create a new `Proxy` for the given destination/path/interface, taking ownership of all
/// passed arguments.
pub async fn new_owned<D, P, I>(
conn: Connection,
destination: D,
path: P,
interface: I,
) -> Result<Proxy<'a>>
where
D: TryInto<BusName<'static>>,
P: TryInto<ObjectPath<'static>>,
I: TryInto<InterfaceName<'static>>,
D::Error: Into<Error>,
P::Error: Into<Error>,
I::Error: Into<Error>,
{
ProxyBuilder::new_bare(&conn)
.destination(destination)?
.path(path)?
.interface(interface)?
.build()
.await
}
/// Get a reference to the associated connection.
pub fn connection(&self) -> &Connection {
&self.inner.inner_without_borrows.conn
}
/// Get a reference to the destination service name.
pub fn destination(&self) -> &BusName<'_> {
&self.inner.destination
}
/// Get a reference to the object path.
pub fn path(&self) -> &ObjectPath<'_> {
&self.inner.path
}
/// Get a reference to the interface.
pub fn interface(&self) -> &InterfaceName<'_> {
&self.inner.interface
}
/// Introspect the associated object, and return the XML description.
///
/// See the [xml](xml/index.html) or [quick_xml](quick_xml/index.html) module for parsing the
/// result.
pub async fn introspect(&self) -> fdo::Result<String> {
let proxy = IntrospectableProxy::builder(&self.inner.inner_without_borrows.conn)
.destination(&self.inner.destination)?
.path(&self.inner.path)?
.build()
.await?;
proxy.introspect().await
}
fn properties_proxy(&self) -> PropertiesProxy<'_> {
PropertiesProxy::builder(&self.inner.inner_without_borrows.conn)
// Safe because already checked earlier
.destination(self.inner.destination.as_ref())
.unwrap()
// Safe because already checked earlier
.path(self.inner.path.as_ref())
.unwrap()
// does not have properties
.cache_properties(CacheProperties::No)
.build_internal()
.unwrap()
.into()
}
fn owned_properties_proxy(&self) -> PropertiesProxy<'static> {
PropertiesProxy::builder(&self.inner.inner_without_borrows.conn)
// Safe because already checked earlier
.destination(self.inner.destination.to_owned())
.unwrap()
// Safe because already checked earlier
.path(self.inner.path.to_owned())
.unwrap()
// does not have properties
.cache_properties(CacheProperties::No)
.build_internal()
.unwrap()
.into()
}
/// Get the cache, starting it in the background if needed.
///
/// Use PropertiesCache::ready() to wait for the cache to be populated and to get any errors
/// encountered in the population.
pub(crate) fn get_property_cache(&self) -> Option<&Arc<PropertiesCache>> {
let cache = match &self.inner.property_cache {
Some(cache) => cache,
None => return None,
};
let (cache, _) = &cache.get_or_init(|| {
let proxy = self.owned_properties_proxy();
let interface = self.interface().to_owned();
let uncached_properties: HashSet<zvariant::Str<'static>> = self
.inner
.uncached_properties
.iter()
.map(|s| s.to_owned())
.collect();
let executor = self.connection().executor();
PropertiesCache::new(proxy, interface, executor, uncached_properties)
});
Some(cache)
}
/// Get the cached value of the property `property_name`.
///
/// This returns `None` if the property is not in the cache. This could be because the cache
/// was invalidated by an update, because caching was disabled for this property or proxy, or
/// because the cache has not yet been populated. Use `get_property` to fetch the value from
/// the peer.
pub fn cached_property<T>(&self, property_name: &str) -> Result<Option<T>>
where
T: TryFrom<OwnedValue>,
T::Error: Into<Error>,
{
self.cached_property_raw(property_name)
.as_deref()
.map(|v| T::try_from(OwnedValue::from(v)))
.transpose()
.map_err(Into::into)
}
/// Get the cached value of the property `property_name`.
///
/// Same as `cached_property`, but gives you access to the raw value stored in the cache. This
/// is useful if you want to avoid allocations and cloning.
pub fn cached_property_raw<'p>(
&'p self,
property_name: &'p str,
) -> Option<impl Deref<Target = Value<'static>> + 'p> {
if let Some(values) = self
.inner
.property_cache
.as_ref()
.and_then(OnceCell::get)
.map(|c| c.0.values.read().expect("lock poisoned"))
{
// ensure that the property is in the cache.
values
.get(property_name)
// if the property value has not yet been cached, this will return None.
.and_then(|e| e.value.as_ref())?;
struct Wrapper<'a> {
values: RwLockReadGuard<'a, HashMap<String, PropertyValue>>,
property_name: &'a str,
}
impl Deref for Wrapper<'_> {
type Target = Value<'static>;
fn deref(&self) -> &Self::Target {
self.values
.get(self.property_name)
.and_then(|e| e.value.as_ref())
.map(|v| v.deref())
.expect("inexistent property")
}
}
Some(Wrapper {
values,
property_name,
})
} else {
None
}
}
async fn get_proxy_property(&self, property_name: &str) -> Result<OwnedValue> {
Ok(self
.properties_proxy()
.get(self.inner.interface.as_ref(), property_name)
.await?)
}
/// Get the property `property_name`.
///
/// Get the property value from the cache (if caching is enabled) or call the
/// `Get` method of the `org.freedesktop.DBus.Properties` interface.
pub async fn get_property<T>(&self, property_name: &str) -> Result<T>
where
T: TryFrom<OwnedValue>,
T::Error: Into<Error>,
{
if let Some(cache) = self.get_property_cache() {
cache.ready().await?;
}
if let Some(value) = self.cached_property(property_name)? {
return Ok(value);
}
let value = self.get_proxy_property(property_name).await?;
value.try_into().map_err(Into::into)
}
/// Set the property `property_name`.
///
/// Effectively, call the `Set` method of the `org.freedesktop.DBus.Properties` interface.
pub async fn set_property<'t, T: 't>(&self, property_name: &str, value: T) -> fdo::Result<()>
where
T: Into<Value<'t>>,
{
self.properties_proxy()
.set(self.inner.interface.as_ref(), property_name, &value.into())
.await
}
/// Call a method and return the reply.
///
/// Typically, you would want to use [`call`] method instead. Use this method if you need to
/// deserialize the reply message manually (this way, you can avoid the memory
/// allocation/copying, by deserializing the reply to an unowned type).
///
/// [`call`]: struct.Proxy.html#method.call
pub async fn call_method<'m, M, B>(&self, method_name: M, body: &B) -> Result<Arc<Message>>
where
M: TryInto<MemberName<'m>>,
M::Error: Into<Error>,
B: serde::ser::Serialize + zvariant::DynamicType,
{
self.inner
.inner_without_borrows
.conn
.call_method(
Some(&self.inner.destination),
self.inner.path.as_str(),
Some(&self.inner.interface),
method_name,
body,
)
.await
}
/// Call a method and return the reply body.
///
/// Use [`call_method`] instead if you need to deserialize the reply manually/separately.
///
/// [`call_method`]: struct.Proxy.html#method.call_method
pub async fn call<'m, M, B, R>(&self, method_name: M, body: &B) -> Result<R>
where
M: TryInto<MemberName<'m>>,
M::Error: Into<Error>,
B: serde::ser::Serialize + zvariant::DynamicType,
R: serde::de::DeserializeOwned + zvariant::Type,
{
let reply = self.call_method(method_name, body).await?;
reply.body()
}
/// Call a method and return the reply body, optionally supplying a set of
/// method flags to control the way the method call message is sent and handled.
///
/// Use [`call`] instead if you do not need any special handling via additional flags.
/// If the `NoReplyExpected` flag is passed , this will return None immediately
/// after sending the message, similar to [`call_noreply`]
///
/// [`call`]: struct.Proxy.html#method.call
/// [`call_noreply`]: struct.Proxy.html#method.call_noreply
pub async fn call_with_flags<'m, M, B, R>(
&self,
method_name: M,
flags: BitFlags<MethodFlags>,
body: &B,
) -> Result<Option<R>>
where
M: TryInto<MemberName<'m>>,
M::Error: Into<Error>,
B: serde::ser::Serialize + zvariant::DynamicType,
R: serde::de::DeserializeOwned + zvariant::Type,
{
let flags = flags
.iter()
.map(MessageFlags::from)
.collect::<BitFlags<_>>();
match self
.inner
.inner_without_borrows
.conn
.call_method_raw(
Some(self.destination()),
self.path(),
Some(self.interface()),
method_name,
flags,
body,
)
.await?
{
Some(reply) => reply.await?.body().map(Some),
None => Ok(None),
}
}
/// Call a method without expecting a reply
///
/// This sets the `NoReplyExpected` flag on the calling message and does not wait for a reply.
pub async fn call_noreply<'m, M, B>(&self, method_name: M, body: &B) -> Result<()>
where
M: TryInto<MemberName<'m>>,
M::Error: Into<Error>,
B: serde::ser::Serialize + zvariant::DynamicType,
{
self.call_with_flags::<_, _, ()>(method_name, MethodFlags::NoReplyExpected.into(), body)
.await?;
Ok(())
}
/// Create a stream for signal named `signal_name`.
pub async fn receive_signal<'m, M>(&self, signal_name: M) -> Result<SignalStream<'m>>
where
M: TryInto<MemberName<'m>>,
M::Error: Into<Error>,
{
self.receive_signal_with_args(signal_name, &[]).await
}
/// Same as [`Proxy::receive_signal`] but with a filter.
///
/// The D-Bus specification allows you to filter signals by their arguments, which helps avoid
/// a lot of unnecessary traffic and processing since the filter is run on the server side. Use
/// this method where possible. Note that this filtering is limited to arguments of string
/// types.
///
/// The arguments are passed as a tuples of argument index and expected value.
pub async fn receive_signal_with_args<'m, M>(
&self,
signal_name: M,
args: &[(u8, &str)],
) -> Result<SignalStream<'m>>
where
M: TryInto<MemberName<'m>>,
M::Error: Into<Error>,
{
let signal_name = signal_name.try_into().map_err(Into::into)?;
self.receive_signals(Some(signal_name), args).await
}
async fn receive_signals<'m>(
&self,
signal_name: Option<MemberName<'m>>,
args: &[(u8, &str)],
) -> Result<SignalStream<'m>> {
self.inner.subscribe_dest_owner_change().await?;
SignalStream::new(self.clone(), signal_name, args).await
}
/// Create a stream for all signals emitted by this service.
pub async fn receive_all_signals(&self) -> Result<SignalStream<'static>> {
self.receive_signals(None, &[]).await
}
/// Get a stream to receive property changed events.
///
/// Note that zbus doesn't queue the updates. If the listener is slower than the receiver, it
/// will only receive the last update.
///
/// If caching is not enabled on this proxy, the resulting stream will not return any events.
pub async fn receive_property_changed<'name: 'a, T>(
&self,
name: &'name str,
) -> PropertyStream<'a, T> {
let properties = self.get_property_cache();
let changed_listener = if let Some(properties) = &properties {
let mut values = properties.values.write().expect("lock poisoned");
let entry = values
.entry(name.to_string())
.or_insert_with(PropertyValue::default);
entry.event.listen()
} else {
Event::new().listen()
};
PropertyStream {
name,
proxy: self.clone(),
changed_listener,
phantom: std::marker::PhantomData,
}
}
/// Get a stream to receive destination owner changed events.
///
/// If the proxy destination is a unique name, the stream will be notified of the peer
/// disconnection from the bus (with a `None` value).
///
/// If the proxy destination is a well-known name, the stream will be notified whenever the name
/// owner is changed, either by a new peer being granted ownership (`Some` value) or when the
/// name is released (with a `None` value).
///
/// Note that zbus doesn't queue the updates. If the listener is slower than the receiver, it
/// will only receive the last update.
pub async fn receive_owner_changed(&self) -> Result<OwnerChangedStream<'_>> {
use futures_util::StreamExt;
let dbus_proxy = fdo::DBusProxy::builder(self.connection())
.cache_properties(CacheProperties::No)
.build()
.await?;
Ok(OwnerChangedStream {
stream: dbus_proxy
.receive_name_owner_changed_with_args(&[(0, self.destination().as_str())])
.await?
.map(Box::new(move |signal| {
let args = signal.args().unwrap();
let new_owner = args.new_owner().as_ref().map(|owner| owner.to_owned());
new_owner
})),
name: self.destination().clone(),
})
}
}
#[derive(Debug, Default)]
struct PropertyValue {
value: Option<OwnedValue>,
event: Event,
}
/// Flags to use with [`Proxy::call_with_flags`].
#[bitflags]
#[repr(u8)]
#[derive(Debug, Copy, Clone, PartialEq, Eq)]
pub enum MethodFlags {
/// No response is expected from this method call, regardless of whether the
/// signature for the interface method indicates a reply type. When passed,
/// `call_with_flags` will return `Ok(None)` immediately after successfully
/// sending the method call.
///
/// Errors encountered while *making* the call will still be returned as
/// an `Err` variant, but any errors that are triggered by the receiver's
/// handling of the call will not be delivered.
NoReplyExpected = 0x1,
/// When set on a call whose destination is a message bus, this flag will instruct
/// the bus not to [launch][al] a service to handle the call if no application
/// on the bus owns the requested name.
///
/// This flag is ignored when using a peer-to-peer connection.
///
/// [al]: https://dbus.freedesktop.org/doc/dbus-specification.html#message-bus-starting-services
NoAutoStart = 0x2,
/// Indicates to the receiver that this client is prepared to wait for interactive
/// authorization, which might take a considerable time to complete. For example, the receiver
/// may query the user for confirmation via [polkit] or a similar framework.
///
/// [polkit]: https://gitlab.freedesktop.org/polkit/polkit/
AllowInteractiveAuth = 0x4,
}
assert_impl_all!(MethodFlags: Send, Sync, Unpin);
impl From<MethodFlags> for MessageFlags {
fn from(method_flag: MethodFlags) -> Self {
match method_flag {
MethodFlags::NoReplyExpected => Self::NoReplyExpected,
MethodFlags::NoAutoStart => Self::NoAutoStart,
MethodFlags::AllowInteractiveAuth => Self::AllowInteractiveAuth,
}
}
}
type OwnerChangedStreamMap<'a> = Map<
fdo::NameOwnerChangedStream<'a>,
Box<dyn FnMut(fdo::NameOwnerChanged) -> Option<UniqueName<'static>> + Send + Sync + Unpin>,
>;
/// A [`stream::Stream`] implementation that yields `UniqueName` when the bus owner changes.
///
/// Use [`Proxy::receive_owner_changed`] to create an instance of this type.
pub struct OwnerChangedStream<'a> {
stream: OwnerChangedStreamMap<'a>,
name: BusName<'a>,
}
assert_impl_all!(OwnerChangedStream<'_>: Send, Sync, Unpin);
impl OwnerChangedStream<'_> {
/// The bus name being tracked.
pub fn name(&self) -> &BusName<'_> {
&self.name
}
}
impl<'a> stream::Stream for OwnerChangedStream<'a> {
type Item = Option<UniqueName<'static>>;
fn poll_next(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Option<Self::Item>> {
use futures_util::StreamExt;
self.get_mut().stream.poll_next_unpin(cx)
}
}
/// A [`stream::Stream`] implementation that yields signal [messages](`Message`).
///
/// Use [`Proxy::receive_signal`] to create an instance of this type.
///
/// This type uses a [`MessageStream::for_match_rule`] internally and therefore the note about match
/// rule registration and [`AsyncDrop`] in its documentation applies here as well.
#[derive(Debug)]
pub struct SignalStream<'a> {
stream: Join<MessageStream, Option<MessageStream>>,
src_unique_name: Option<UniqueName<'static>>,
signal_name: Option<MemberName<'a>>,
}
impl<'a> SignalStream<'a> {
/// The signal name.
pub fn name(&self) -> Option<&MemberName<'a>> {
self.signal_name.as_ref()
}
async fn new(
proxy: Proxy<'_>,
signal_name: Option<MemberName<'a>>,
args: &[(u8, &str)],
) -> Result<SignalStream<'a>> {
let mut rule_builder = MatchRule::builder()
.msg_type(MessageType::Signal)
.sender(proxy.destination())?
.path(proxy.path())?
.interface(proxy.interface())?;
if let Some(name) = &signal_name {
rule_builder = rule_builder.member(name)?;
}
for (i, arg) in args {
rule_builder = rule_builder.arg(*i, *arg)?;
}
let signal_rule: OwnedMatchRule = rule_builder.build().to_owned().into();
let conn = proxy.connection();
let (src_unique_name, stream) = match proxy.destination().to_owned() {
BusName::Unique(name) => (
Some(name),
join_streams(
MessageStream::for_match_rule(signal_rule, conn, None).await?,
None,
),
),
BusName::WellKnown(name) => {
use ordered_stream::OrderedStreamExt;
let name_owner_changed_rule = MatchRule::builder()
.msg_type(MessageType::Signal)
.sender("org.freedesktop.DBus")?
.path("/org/freedesktop/DBus")?
.interface("org.freedesktop.DBus")?
.member("NameOwnerChanged")?
.add_arg(name.as_str())?
.build();
let name_owner_changed_stream = MessageStream::for_match_rule(
name_owner_changed_rule,
conn,
Some(MAX_NAME_OWNER_CHANGED_SIGNALS_QUEUED),
)
.await?
.map(Either::Left);
let get_name_owner = conn
.call_method_raw(
Some("org.freedesktop.DBus"),
"/org/freedesktop/DBus",
Some("org.freedesktop.DBus"),
"GetNameOwner",
BitFlags::empty(),
&name,
)
.await
.map(|r| FromFuture::from(r.expect("no reply")).map(Either::Right))?;
let mut join = join_streams(name_owner_changed_stream, get_name_owner);
let mut src_unique_name = loop {
match join.next().await {
Some(Either::Left(Ok(msg))) => {
let signal = NameOwnerChanged::from_message(msg)
.expect("`NameOwnerChanged` signal stream got wrong message");
{
break signal
.args()
// SAFETY: The filtering code couldn't have let this through if
// args were not in order.
.expect("`NameOwnerChanged` signal has no args")
.new_owner()
.as_ref()
.map(UniqueName::to_owned);
}
}
Some(Either::Left(Err(_))) => (),
Some(Either::Right(Ok(response))) => {
break Some(response.body::<UniqueName<'_>>()?.to_owned())
}
Some(Either::Right(Err(e))) => {
// Probably the name is not owned. Not a problem but let's still log it.
debug!("Failed to get owner of {name}: {e}");
break None;
}
None => {
return Err(Error::InputOutput(
std::io::Error::new(
std::io::ErrorKind::BrokenPipe,
"connection closed",
)
.into(),
))
}
}
};
// Let's take into account any buffered NameOwnerChanged signal.
let (stream, _, queued) = join.into_inner();
if let Some(msg) = queued.and_then(|e| match e.0 {
Either::Left(Ok(msg)) => Some(msg),
Either::Left(Err(_)) | Either::Right(_) => None,
}) {
if let Some(signal) = NameOwnerChanged::from_message(msg) {
if let Ok(args) = signal.args() {
match (args.name(), args.new_owner().deref()) {
(BusName::WellKnown(n), Some(new_owner)) if n == &name => {
src_unique_name = Some(new_owner.to_owned());
}
_ => (),
}
}
}
}
let name_owner_changed_stream = stream.into_inner();
let stream = join_streams(
MessageStream::for_match_rule(signal_rule, conn, None).await?,
Some(name_owner_changed_stream),
);
(src_unique_name, stream)
}
};
Ok(SignalStream {
stream,
src_unique_name,
signal_name,
})
}
fn filter(&mut self, msg: &Arc<Message>) -> Result<bool> {
let header = msg.header()?;
let sender = header.sender()?;
if sender == self.src_unique_name.as_ref() {
return Ok(true);
}
// The src_unique_name must be maintained in lock-step with the applied filter
if let Some(signal) = NameOwnerChanged::from_message(msg.clone()) {
let args = signal.args()?;
self.src_unique_name = args.new_owner().as_ref().map(|n| n.to_owned());
}
Ok(false)
}
}
assert_impl_all!(SignalStream<'_>: Send, Sync, Unpin);
impl<'a> stream::Stream for SignalStream<'a> {
type Item = Arc<Message>;
fn poll_next(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Option<Self::Item>> {
OrderedStream::poll_next_before(self, cx, None).map(|res| res.into_data())
}
}
impl<'a> OrderedStream for SignalStream<'a> {
type Data = Arc<Message>;
type Ordering = MessageSequence;
fn poll_next_before(
self: Pin<&mut Self>,
cx: &mut Context<'_>,
before: Option<&Self::Ordering>,
) -> Poll<PollResult<Self::Ordering, Self::Data>> {
let this = self.get_mut();
loop {
match ready!(OrderedStream::poll_next_before(
Pin::new(&mut this.stream),
cx,
before
)) {
PollResult::Item { data, ordering } => {
if let Ok(msg) = data {
if let Ok(true) = this.filter(&msg) {
return Poll::Ready(PollResult::Item {
data: msg,
ordering,
});
}
}
}
PollResult::Terminated => return Poll::Ready(PollResult::Terminated),
PollResult::NoneBefore => return Poll::Ready(PollResult::NoneBefore),
}
}
}
}
impl<'a> stream::FusedStream for SignalStream<'a> {
fn is_terminated(&self) -> bool {
ordered_stream::FusedOrderedStream::is_terminated(&self.stream)
}
}
#[async_trait::async_trait]
impl AsyncDrop for SignalStream<'_> {
async fn async_drop(self) {
let (signals, names, _buffered) = self.stream.into_inner();
signals.async_drop().await;
if let Some(names) = names {
names.async_drop().await;
}
}
}
impl<'a> From<crate::blocking::Proxy<'a>> for Proxy<'a> {
fn from(proxy: crate::blocking::Proxy<'a>) -> Self {
proxy.into_inner()
}
}
#[cfg(test)]
mod tests {
use super::*;
use crate::{dbus_interface, dbus_proxy, utils::block_on, ConnectionBuilder, SignalContext};
use futures_util::StreamExt;
use ntest::timeout;
use test_log::test;
#[test]
#[timeout(15000)]
fn signal() {
block_on(test_signal()).unwrap();
}
async fn test_signal() -> Result<()> {
// Register a well-known name with the session bus and ensure we get the appropriate
// signals called for that.
let conn = Connection::session().await?;
let dest_conn = Connection::session().await?;
let unique_name = dest_conn.unique_name().unwrap().clone();
let well_known = "org.freedesktop.zbus.async.ProxySignalStreamTest";
let proxy: Proxy<'_> = ProxyBuilder::new_bare(&conn)
.destination(well_known)?
.path("/does/not/matter")?
.interface("does.not.matter")?
.build()
.await?;
let mut owner_changed_stream = proxy.receive_owner_changed().await?;
let proxy = fdo::DBusProxy::new(&dest_conn).await?;
let mut name_acquired_stream = proxy
.receive_signal_with_args("NameAcquired", &[(0, well_known)])
.await?;
let prop_stream =
proxy
.receive_property_changed("SomeProp")
.await
.filter_map(|changed| async move {
let v: Option<u32> = changed.get().await.ok();
dbg!(v)
});
drop(proxy);
drop(prop_stream);
dest_conn.request_name(well_known).await?;
let (new_owner, acquired_signal) =
futures_util::join!(owner_changed_stream.next(), name_acquired_stream.next(),);
assert_eq!(&new_owner.unwrap().unwrap(), &*unique_name);
let acquired_signal = acquired_signal.unwrap();
assert_eq!(acquired_signal.body::<&str>().unwrap(), well_known);
let proxy = Proxy::new(&conn, &unique_name, "/does/not/matter", "does.not.matter").await?;
let mut unique_name_changed_stream = proxy.receive_owner_changed().await?;
drop(dest_conn);
name_acquired_stream.async_drop().await;
// There shouldn't be an owner anymore.
let new_owner = owner_changed_stream.next().await;
assert!(new_owner.unwrap().is_none());
let new_unique_owner = unique_name_changed_stream.next().await;
assert!(new_unique_owner.unwrap().is_none());
Ok(())
}
#[test]
#[timeout(15000)]
fn signal_stream_deadlock() {
block_on(test_signal_stream_deadlock()).unwrap();
}
/// Tests deadlocking in signal reception when the message queue is full.
///
/// Creates a connection with a small message queue, and a service that
/// emits signals at a high rate. First a listener is created that listens
/// for that signal which should fill the small queue. Then another signal
/// signal listener is created against another signal. Previously, this second
/// call to add the match rule never resolved and resulted in a deadlock.
async fn test_signal_stream_deadlock() -> Result<()> {
#[dbus_proxy(
gen_blocking = false,
default_path = "/org/zbus/Test",
default_service = "org.zbus.Test.MR501",
interface = "org.zbus.Test"
)]
trait Test {
#[dbus_proxy(signal)]
fn my_signal(&self, msg: &str) -> Result<()>;
}
struct TestIface;
#[dbus_interface(name = "org.zbus.Test")]
impl TestIface {
#[dbus_interface(signal)]
async fn my_signal(context: &SignalContext<'_>, msg: &'static str) -> Result<()>;
}
let test_iface = TestIface;
let server_conn = ConnectionBuilder::session()?
.name("org.zbus.Test.MR501")?
.serve_at("/org/zbus/Test", test_iface)?
.build()
.await?;
let client_conn = ConnectionBuilder::session()?.max_queued(1).build().await?;
let test_proxy = TestProxy::new(&client_conn).await?;
let test_prop_proxy = PropertiesProxy::builder(&client_conn)
.destination("org.zbus.Test.MR501")?
.path("/org/zbus/Test")?
.build()
.await?;
let (tx, mut rx) = tokio::sync::mpsc::channel(1);
let handle = {
let tx = tx.clone();
let conn = server_conn.clone();
let server_fut = async move {
use std::time::Duration;
#[cfg(not(feature = "tokio"))]
use async_io::Timer;
#[cfg(feature = "tokio")]
use tokio::time::sleep;
let iface_ref = conn
.object_server()
.interface::<_, TestIface>("/org/zbus/Test")
.await
.unwrap();
let context = iface_ref.signal_context();
while !tx.is_closed() {
for _ in 0..10 {
TestIface::my_signal(context, "This is a test")
.await
.unwrap();
}
#[cfg(not(feature = "tokio"))]
Timer::after(Duration::from_millis(5)).await;
#[cfg(feature = "tokio")]
sleep(Duration::from_millis(5)).await;
}
};
server_conn.executor().spawn(server_fut, "server_task")
};
let signal_fut = async {
let mut signal_stream = test_proxy.receive_my_signal().await.unwrap();
tx.send(()).await.unwrap();
while let Some(_signal) = signal_stream.next().await {}
};
let prop_fut = async move {
rx.recv().await.unwrap();
let _prop_stream = test_prop_proxy.receive_properties_changed().await.unwrap();
};
futures_util::pin_mut!(signal_fut);
futures_util::pin_mut!(prop_fut);
futures_util::future::select(signal_fut, prop_fut).await;
handle.await;
Ok(())
}
}