Struct ClientSynchronousProxy

pub struct ClientSynchronousProxy { /* private fields */ }

Implementations

impl ClientSynchronousProxy

pub fn new(channel: Channel) -> Self

pub fn into_channel(self) -> Channel

pub fn wait_for_event( &self, deadline: MonotonicInstant, ) -> Result<ClientEvent, 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_servers( &self, ___deadline: MonotonicInstant, ) -> Result<Vec<DnsServer_>, Error>

Returns a list of DNS servers.

First call always returns a snapshot of the current list of servers or blocks if an empty list would be returned. Subsequent calls will block until the list of servers changes.

The list of servers changes over time by configuration or network topology changes, expiration, etc. Callers must repeatedly call WatchServers and replace any previously returned servers with new ones to avoid using stale or expired entries.

It is invalid to call this method while a previous call is pending. Doing so will cause the server end of the protocol to be closed.

• response servers The list of servers to use for DNS resolution, in priority order.

pub fn watch_address( &self, ___deadline: MonotonicInstant, ) -> Result<(Subnet, AddressParameters, ServerEnd<AddressStateProviderMarker>), Error>

Returns an address and its parameters.

Yields a value for every address acquired by the client.

It is invalid to call this method while a previous call is pending. Doing so will cause the server end of the protocol to be closed.

• response address the assigned address.
• response address_parameters the parameters of the address.
• response address_state_provider provides address assignment state and enables updating address properties; client end is closed if the address becomes invalid (its valid lifetime expires and Renew and Rebind fail).

pub fn watch_prefixes( &self, ___deadline: MonotonicInstant, ) -> Result<Vec<Prefix>, Error>

Hanging get for prefix leases.

The first call to this method will return when there is at least one lease to report (the first call is guaranteed to return with a non-empty vector). Subsequent calls will return immediately if there is a change to report, or block until a change occurs.

It is invalid to call this method while a previous call is pending. Doing so will cause the server end of the protocol to be closed.

• response prefixes the assigned prefixes and their lifetimes.

pub fn shutdown( &self, ___deadline: MonotonicInstant, ) -> Result<ClientShutdownResult, Error>

Gracefully tears down the underlying object.

Blocks until any held addresses are gracefully released, as described in RFC 8415, Section 18.2.7.

The server end of the protocol is closed after this method returns.

• error a zx.Status if any of the addresses were not gracefully released, e.g. the client times out waiting for Reply to Release, or the interface is down and sending Release fails.

Trait Implementations

impl Debug for ClientSynchronousProxy

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

Formats the value using the given formatter.

impl SynchronousProxy for ClientSynchronousProxy

type Proxy = ClientProxy

The async proxy for the same protocol.

type Protocol = ClientMarker

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.