Struct ProviderSynchronousProxy

pub struct ProviderSynchronousProxy { /* private fields */ }

Implementations

impl ProviderSynchronousProxy

pub fn new(channel: Channel) -> Self

pub fn into_channel(self) -> Channel

pub fn wait_for_event( &self, deadline: MonotonicInstant, ) -> Result<ProviderEvent, 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 register_watcher( &self, watcher: ClientEnd<WatcherMarker>, ) -> Result<(), Error>

Used to register for memory pressure level changes. watcher: memory pressure Watcher channel that the Provider will use to send level change messages to the client.

The current memory pressure level is immediately sent to the watcher when this method is called.

It is recommended that the root job in a component tree register for changes, rather than having individual jobs further down the tree register individually. A low client count will help minimize system churn due to a large number of memory pressure messages in transit at the same time. Also, the more context a job has, the better equipped it will be to react to memory pressure by controlling the behavior of children jobs in its tree.

Trait Implementations

impl Debug for ProviderSynchronousProxy

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

Formats the value using the given formatter.

impl SynchronousProxy for ProviderSynchronousProxy

type Proxy = ProviderProxy

The async proxy for the same protocol.

type Protocol = ProviderMarker

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.