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

Returns acquired DHCP configuration.

Yields a value whenever the client acquires new configuration. Notably, does not yield a value upon DHCP lease expiry; instead, expiry of the IP address is communicated via the AddressStateProvider (refer to documentation of fuchsia.net.interfaces.admin/AddressStateProvider for details). Non-address configuration does not expire, but is replaced by new configuration once a new DHCP lease is obtained.

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

• response address the assigned address. If set, the client has acquired a new lease on an IP address. If not set, then either the client has not requested an IP address (in which case this Client instance has never yielded an address), or the client continues to hold a lease on a previously-acquired IP address (whose lifetime is updated via AddressStateProvider).
• response dns_servers addresses of discovered DNS servers. If absent, must be interpreted as empty (the client’s configuration indicates no DNS servers, even if previously-yielded configuration included DNS servers).
• response routers addresses of discovered routers on the client’s subnet, in descending order of preference according to the DHCP server. If absent, must be interpreted as empty (the client’s configuration indicates no routers, even if previously-yielded configuration included routers).

pub fn shutdown(&self) -> Result<(), Error>

Instructs the client to shut down gracefully (releasing any DHCP lease currently held). When the client is finished shutting down, it yields the ClientExitReason::GRACEFUL_SHUTDOWN OnExit event.

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.