Struct fidl_fuchsia_net_dhcp::ClientProxy

pub struct ClientProxy { /* private fields */ }

Implementations

impl ClientProxy

pub fn new(channel: AsyncChannel) -> Self

Create a new Proxy for fuchsia.net.dhcp/Client.

pub fn take_event_stream(&self) -> ClientEventStream

Get a Stream of events from the remote end of the protocol.

Panics

Panics if the event stream was already taken.

pub fn watch_configuration( &self ) -> QueryResponseFut<ClientWatchConfigurationResponse>

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 ClientProxyInterface for ClientProxy

type WatchConfigurationResponseFut = QueryResponseFut<ClientWatchConfigurationResponse>

fn watch_configuration(&self) -> Self::WatchConfigurationResponseFut

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

impl Clone for ClientProxy

fn clone(&self) -> ClientProxy

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ClientProxy

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

Formats the value using the given formatter.

impl Proxy for ClientProxy

type Protocol = ClientMarker

The protocol which this Proxy controls.

fn from_channel(inner: AsyncChannel) -> Self

Create a proxy over the given channel.

fn into_channel(self) -> Result<AsyncChannel, Self>

Attempt to convert the proxy back into a channel.

fn as_channel(&self) -> &AsyncChannel

Get a reference to the proxy’s underlying channel.

fn into_client_end(self) -> Result<ClientEnd<Self::Protocol>, Self>

Attempt to convert the proxy back into a client end.

fn is_closed(&self) -> bool

Returns true if the proxy has received the PEER_CLOSED signal.

fn on_closed(&self) -> OnSignals<'_, Unowned<'_, Handle>>

Returns a future that completes when the proxy receives the PEER_CLOSED signal.