Struct SessionSynchronousProxy

pub struct SessionSynchronousProxy { /* private fields */ }

Implementations

impl SessionSynchronousProxy

pub fn new(channel: Channel) -> Self

pub fn into_channel(self) -> Channel

pub fn wait_for_event( &self, deadline: MonotonicInstant, ) -> Result<SessionEvent, 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 start_tracing( &self, payload: &StartOptions, ___deadline: MonotonicInstant, ) -> Result<SessionStartTracingResult, Error>

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 Session 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, payload: &StopOptions, ___deadline: MonotonicInstant, ) -> Result<SessionStopTracingResult, Error>

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 watch_alert( &self, ___deadline: MonotonicInstant, ) -> Result<String, Error>

Returns the next alert when it arrives.

Alerts received by the Session are queued until a WatchAlert request is received. Alerts are sent to the caller in the order they were received.

WatchAlert requests are also queued until an alert is received and the requests are serviced in the order they were received.

Trait Implementations

impl Debug for SessionSynchronousProxy

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

Formats the value using the given formatter.

impl SynchronousProxy for SessionSynchronousProxy

type Proxy = SessionProxy

The async proxy for the same protocol.

type Protocol = SessionMarker

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.