Struct fidl_fuchsia_metricslogger_test::MetricsLoggerProxy

pub struct MetricsLoggerProxy { /* private fields */ }

Implementations

impl MetricsLoggerProxy

pub fn new(channel: AsyncChannel) -> Self

Create a new Proxy for MetricsLogger

pub fn take_event_stream(&self) -> MetricsLoggerEventStream

Get a Stream of events from the remote end of the MetricsLogger protocol

Panics

Panics if the event stream was already taken.

pub fn start_logging( &self, client_id: &str, metrics: &mut dyn ExactSizeIterator<Item = &mut Metric>, duration_ms: u32, output_samples_to_syslog: bool, output_stats_to_syslog: bool ) -> QueryResponseFut<MetricsLoggerStartLoggingResult>

Initiates logging of specified metrics for the provided duration. Supports concurrent logging of different metrics. Logging may be terminated early with a call to StopLogging.

This call will fail if logging of the specified metric is already active. For this reason, a client may wish to precede a StartLogging call with a StopLogging call, after which the only reason for The logger to be active would be a conflict with another client.

• request client_id String format Id of the client. Client may choose any Id with a maximum byte size of 8 (e.g., “ffxTest”).
• request metrics Type of the metrics to be polled and logged.
• request duration_ms Duration of logging in milliseconds. After this duration, polling and logging will cease.
• request output_samples_to_syslog Toggle for outputting raw data to syslog.
• request output_stats_to_syslog Toggle for outputting any available statistics to syslog.
• error a [fuchsia.metrics.test/MeticsLoggerError] value indicating why the request failed.

pub fn start_logging_forever( &self, client_id: &str, metrics: &mut dyn ExactSizeIterator<Item = &mut Metric>, output_samples_to_syslog: bool, output_stats_to_syslog: bool ) -> QueryResponseFut<MetricsLoggerStartLoggingForeverResult>

Initiates logging of specified metrics. Supports concurrent logging of different metrics. Logging will only end upon a StopLogging call.

StartLogging should be preferred for usage in automated tests to ensure that logging terminates even if the test crashes.

• request client_id String format Id of the client. Client may choose any Id with a maximum byte size of 8 (e.g., “ffxTest”).
• request metrics Type of the metrics to be polled and logged.
• request output_samples_to_syslog Toggle for outputting raw data to syslog.
• request output_stats_to_syslog Toggle for outputting any available statistics to syslog.
• error a [fuchsia.metrics.test/MetricsLoggerError] value indicating why the request failed.

pub fn stop_logging(&self, client_id: &str) -> QueryResponseFut<bool>

Terminates all active logging tasks with the given client_id. It is valid to call this method when logging is inactive.

• request client_id String format Id of the client.

• response status A bool value indicating if existing logging was stopped (true) or there’sno existing logging for the client.

Trait Implementations

impl Clone for MetricsLoggerProxy

fn clone(&self) -> MetricsLoggerProxy

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for MetricsLoggerProxy

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

Formats the value using the given formatter.

impl MetricsLoggerProxyInterface for MetricsLoggerProxy

type StartLoggingResponseFut = QueryResponseFut<Result<(), MetricsLoggerError>>

fn start_logging( &self, client_id: &str, metrics: &mut dyn ExactSizeIterator<Item = &mut Metric>, duration_ms: u32, output_samples_to_syslog: bool, output_stats_to_syslog: bool ) -> Self::StartLoggingResponseFut

type StartLoggingForeverResponseFut = QueryResponseFut<Result<(), MetricsLoggerError>>

fn start_logging_forever( &self, client_id: &str, metrics: &mut dyn ExactSizeIterator<Item = &mut Metric>, output_samples_to_syslog: bool, output_stats_to_syslog: bool ) -> Self::StartLoggingForeverResponseFut

type StopLoggingResponseFut = QueryResponseFut<bool>

fn stop_logging(&self, client_id: &str) -> Self::StopLoggingResponseFut

impl Proxy for MetricsLoggerProxy

type Protocol = MetricsLoggerMarker

The protocol which this Proxy controls.

fn from_channel(inner: AsyncChannel) -> Self

Create a proxy over the given channel.

fn into_channel(self) -> Result<AsyncChannel, Self>

Attempt to convert the proxy back into a channel.

fn as_channel(&self) -> &AsyncChannel

Get a reference to the proxy’s underlying channel.

fn is_closed(&self) -> bool

Returns true if the proxy has received the PEER_CLOSED signal.

fn on_closed<'a>(&'a self) -> OnSignals<'a>

Returns a future that completes when the proxy receives the PEER_CLOSED signal.