Struct fidl_fuchsia_tracing_controller::ControllerProxy

pub struct ControllerProxy { /* private fields */ }

Implementations

impl ControllerProxy

pub fn new(channel: AsyncChannel) -> Self

Create a new Proxy for fuchsia.tracing.controller/Controller.

pub fn take_event_stream(&self) -> ControllerEventStream

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

Panics

Panics if the event stream was already taken.

pub fn initialize_tracing( &self, config: &TraceConfig, output: Socket ) -> Result<(), Error>

Requests to initialize tracing with the specified config.

A bad request will terminate the connection.

The trace controller emits trace data to output as a sequence of binary formatted trace records. Traces obtained from different providers are delimited by metadata records within the stream.

pub fn terminate_tracing( &self, options: &TerminateOptions ) -> QueryResponseFut<TerminateResult>

Requests to terminate tracing.

If tracing has not yet stopped it is stopped first. If options.write_results is true, then the trace controller continues to transfer any remaining data to the output socket until finished, then closes the output.

pub fn start_tracing( &self, options: &StartOptions ) -> QueryResponseFut<ControllerStartTracingResult>

Requests to start tracing with the specified options.

If tracing has already started then the request is ignored, except to send back an error code.

The trace controller acknowledges the request when all registered providers have been started or after TraceConfig.start_timeout_milliseconds milliseconds. One useful reason for the has-started acknowledgement is that the trace program can start a program to trace knowing that all the providers are started.

pub fn stop_tracing(&self, options: &StopOptions) -> QueryResponseFut<()>

Requests to stop tracing.

If tracing has already stopped then this does nothing. Returning a result lets callers know when it’s ok to, for example, start tracing again.

pub fn get_providers(&self) -> QueryResponseFut<Vec<ProviderInfo>>

Return the set of registered providers.

pub fn get_known_categories(&self) -> QueryResponseFut<Vec<KnownCategory>>

pub fn watch_alert(&self) -> QueryResponseFut<String>

Returns the next alert when it arrives.

Trait Implementations

impl Clone for ControllerProxy

fn clone(&self) -> ControllerProxy

Returns a copy of the value.

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

Performs copy-assignment from source.

impl ControllerProxyInterface for ControllerProxy

fn initialize_tracing( &self, config: &TraceConfig, output: Socket ) -> Result<(), Error>

type TerminateTracingResponseFut = QueryResponseFut<TerminateResult>

fn terminate_tracing( &self, options: &TerminateOptions ) -> Self::TerminateTracingResponseFut

type StartTracingResponseFut = QueryResponseFut<Result<(), StartErrorCode>>

fn start_tracing(&self, options: &StartOptions) -> Self::StartTracingResponseFut

type StopTracingResponseFut = QueryResponseFut<()>

fn stop_tracing(&self, options: &StopOptions) -> Self::StopTracingResponseFut

type GetProvidersResponseFut = QueryResponseFut<Vec<ProviderInfo>>

fn get_providers(&self) -> Self::GetProvidersResponseFut

type GetKnownCategoriesResponseFut = QueryResponseFut<Vec<KnownCategory>>

fn get_known_categories(&self) -> Self::GetKnownCategoriesResponseFut

type WatchAlertResponseFut = QueryResponseFut<String>

fn watch_alert(&self) -> Self::WatchAlertResponseFut

impl Debug for ControllerProxy

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

Formats the value using the given formatter.

impl Proxy for ControllerProxy

type Protocol = ControllerMarker

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 into_client_end(self) -> Result<ClientEnd<Self::Protocol>, Self>

Attempt to convert the proxy back into a client end.

fn is_closed(&self) -> bool

Returns true if the proxy has received the PEER_CLOSED signal.

fn on_closed(&self) -> OnSignals<'_, Unowned<'_, Handle>>

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