Struct ControllerSynchronousProxy

pub struct ControllerSynchronousProxy { /* private fields */ }

Implementations

impl ControllerSynchronousProxy

pub fn new(channel: Channel) -> Self

pub fn into_channel(self) -> Channel

pub fn wait_for_event( &self, deadline: MonotonicInstant, ) -> Result<ControllerEvent, Error>

Waits until an event arrives and returns it. It is safe for other threads to make concurrent requests while waiting for an event.

pub fn request_send_soon( &self, ___deadline: MonotonicInstant, ) -> Result<bool, Error>

Requests that the collection of Observations that are currently cached locally be sent to the Cobalt server soon. Cobalt will send the Observations in one or more batches and will retry several times upon failure. The response occurs only after that procedure is completed. A return value of true indicates that all Observations were successfully sent. A return value of false indicates otherwise.

pub fn generate_aggregated_observations( &self, day_index: u32, report_specs: &[ReportSpec], ___deadline: MonotonicInstant, ) -> Result<Vec<u64>, Error>

Triggers Cobalt to generate Observations based on locally aggregated event data and write them to the local ObservationStore. In a non-test environment this would normally be done periodically by a background thread. In a test environment this method should be invoked against an instance of the Cobalt FIDL service that was passed the flag –start_event_aggregator_worker=false.

day_index The index of the day for which locally aggregated Observations should be generated.

report_specs A vector of specifications identifying the reports to return the number of observations for.

Returns a vector whose k-th element is the number of observations generated for the k-th element of report_specs. If report_specs is the empty vector, then an empty vector is returned.

pub fn listen_for_initialized( &self, ___deadline: MonotonicInstant, ) -> Result<(), Error>

Requests that the caller be notified after the Cobalt FIDL service is in the fully-initialized state.

Cobalt starts serving requests before it is fully initialized. In this pre-initialized state it will buffer incoming log events in memory but not complete their processing. After Cobalt becomes fully initialized the events in the bufer are fully processed.

A partial list of things that must happen before Cobalt enters the fully-initialized state are:

• Cobalt must by notified by the timekeeper service that the system clock has become accurate–usually because the time has been fetched from a trusted network resource.

The callback to this method will be invoked after Cobalt transistions

Trait Implementations

impl Debug for ControllerSynchronousProxy

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

Formats the value using the given formatter.

impl SynchronousProxy for ControllerSynchronousProxy

type Proxy = ControllerProxy

The async proxy for the same protocol.

type Protocol = ControllerMarker

The protocol which this Proxy controls.

fn from_channel(inner: Channel) -> Self

Create a proxy over the given channel.

fn into_channel(self) -> Channel

Convert the proxy back into a channel.

fn as_channel(&self) -> &Channel

Get a reference to the proxy’s underlying channel.

fn is_closed(&self) -> Result<bool, Status>

Returns true if the proxy has received the PEER_CLOSED signal.