Struct WatcherV4SynchronousProxy

pub struct WatcherV4SynchronousProxy { /* private fields */ }

Implementations

impl WatcherV4SynchronousProxy

pub fn new(channel: Channel) -> Self

pub fn into_channel(self) -> Channel

pub fn wait_for_event( &self, deadline: MonotonicInstant, ) -> Result<WatcherV4Event, 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 watch( &self, ___deadline: MonotonicInstant, ) -> Result<Vec<EventV4>, Error>

Hanging-Get style API for observing routing changes.

Clients must only have one pending Watch call at a time. Calling Watch while a request is already pending will cause the protocol to close.

The first N events will always be existing where N is the number of IPv4 routes that already existed when the server-end of the protocol was initialized. The following event will be idle signaling the end of the existing events. At this point the client has watched all existing state and will never again observe an existing event.

Events are returned in batches of up to MAX_EVENTS events. There is no correlation between the batch size/boundary and it’s contents: it is perfectly valid for the server to split the block of existing events, across several batches. Clients should view this API as providing a stream of events, where batches are used to reduce IPC load on the system.

• response events A vector of at most MAX_EVENTS events.

Trait Implementations

impl Debug for WatcherV4SynchronousProxy

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

Formats the value using the given formatter.

impl SynchronousProxy for WatcherV4SynchronousProxy

type Proxy = WatcherV4Proxy

The async proxy for the same protocol.

type Protocol = WatcherV4Marker

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.