fidl_fuchsia_time_common/fidl_fuchsia_time_common.rs
1// WARNING: This file is machine generated by fidlgen.
2
3#![warn(clippy::all)]
4#![allow(unused_parens, unused_mut, unused_imports, nonstandard_style)]
5
6use bitflags::bitflags;
7use fidl::encoding::{MessageBufFor, ProxyChannelBox, ResourceDialect};
8use futures::future::{self, MaybeDone, TryFutureExt};
9use zx_status;
10
11/// Signaled on the UTC clock handle when the UTC clock is determined to have
12/// reached logging quality.
13///
14/// Logging quality timestamps are low-confidence, but presumed good enough for
15/// debug logging.
16///
17/// The value is an alias for `ZX_USER_SIGNAL_1`
18pub const SIGNAL_UTC_CLOCK_LOGGING_QUALITY: u32 = 33554432;
19
20/// A user signal that indicates that the UTC clock has been synchronized with
21/// an external time source.
22///
23/// We assume that the external time source has a better estimate
24/// of the actual "wall clock" UTC time than our device.
25///
26/// You may wait on this signal if you want your code to sleep until the UTC
27/// clock gets synchronized with an external time source.
28///
29/// When this signal is active, the clock was synchronized with an
30/// external source reasonably recently. The error bounds represent the system's
31/// best estimate of wall clock UTC time.
32///
33/// When this signal is inactive, the clock was last updated from a source
34/// that is not external or was never updated at all. This can occur after a
35/// reboot, or a resume. The UTC clock may have been set from the
36/// real time clock (RTC), but we may not know if RTC matches wall clock.
37///
38/// If you need finer-grained info on the UTC clock error, you must
39/// check the error bounds via [`zx_clock_get_details`][det].
40///
41/// This signal being active does *not* establish clock trust, and should not
42/// be used as such. Also, we can not guarantee that the signal
43/// will stay active after a notification. Clients should not
44/// assume that the clock remains in a certain state after a signal.
45///
46/// The value is an alias for `ZX_USER_SIGNAL_0`.
47///
48/// [det]: https://fuchsia.dev/fuchsia-src/reference/kernel_objects/clock#error-bound
49pub const SIGNAL_UTC_CLOCK_SYNCHRONIZED: u32 = 16777216;
50
51mod internal {
52 use super::*;
53}