Struct fidl_fuchsia_net_dhcp::Server_Proxy

pub struct Server_Proxy { /* private fields */ }

Implementations

impl Server_Proxy

pub fn new(channel: AsyncChannel) -> Self

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

pub fn take_event_stream(&self) -> Server_EventStream

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

Panics

Panics if the event stream was already taken.

pub fn start_serving(&self) -> QueryResponseFut<ServerStartServingResult>

Starts serving DHCP leases.

Starts the DHCP server with the current set of parameters.

On error the server remains in the stopped state. If the server is already serving, StartServing is a no-op.

*error a zx.Status indicating why the server could not be started.

pub fn stop_serving(&self) -> QueryResponseFut<()>

Stops serving DHCP leases.

Stopping causes all the listening ports to be closed.

Configuring parameters on the DHCP server is only allowed when the server is stopped.

If the server is not currently serving, StopServing is a no-op.

pub fn is_serving(&self) -> QueryResponseFut<bool>

Returns whether or not the server is serving DHCP leases.

pub fn get_option( &self, code: OptionCode ) -> QueryResponseFut<ServerGetOptionResult>

Returns the requested Option if it is supported.

• request code the code of an Option whose value has been requested.

• response value the value of the requested Option.

• error a zx.Status indicating why the value could not be retrieved.

pub fn get_parameter( &self, name: ParameterName ) -> QueryResponseFut<ServerGetParameterResult>

Returns the requested Parameter if it is supported.

• request name the name of a Parameter whose value has been requested.

• response value the value of the requested Parameter.

• error a zx.Status indicating why the value could not be retrieved.

pub fn set_option( &self, value: &Option_ ) -> QueryResponseFut<ServerSetOptionResult>

Sets the Option to the argument. On success, a SetOption will take effect immediately.

• request value an Option whose value will be set to the value of this argument.

• error a zx.Status indicating the cause of failure.

pub fn set_parameter( &self, value: &Parameter ) -> QueryResponseFut<ServerSetParameterResult>

Sets the Parameter to the argument. On success, the new parameter value can be queried by GetParameter or ListParameter immediately. However, the server may require a restart in order for the new Parameter value to take effect.

Setting parameters is only allowed if the server is stopped. ZX_ERR_BAD_STATE is returned otherwise.

• request value a Parameter whose value will be set to the value of this argument.

• error a zx.Status indicating the cause of failure.

pub fn list_options(&self) -> QueryResponseFut<ServerListOptionsResult>

Lists all DHCP options for which the Server has a value. Any option which does not have a value will be omitted from the returned list. ListOptions provides administrators a means to print a server’s configuration as opposed to querying the value of a single Option.

• response options a vector containing all of the options for which the Server has a value. Bounded to 256 as options are identified by a 1 octet code and 256 is the maximum number of such codes.

• error a zx.Status indicating the cause of failure.

pub fn list_parameters(&self) -> QueryResponseFut<ServerListParametersResult>

Lists all DHCP server parameters. ListParameters provides administrators a means to print a server’s configuration as opposed to querying the value of a single Parameter.

• response parameter a vector containing the values of all of the Server’s parameters. Bounded to 256 to provide a generous upper limit on the number of server parameters while being of the same size as ListOptions.

• error a zx.Status indicating the cause of failure.

pub fn reset_options(&self) -> QueryResponseFut<ServerResetOptionsResult>

Resets all DHCP options to have no value. On success, ResetOptions will take effect immediately.

• error a zx.Status indicating the cause of failure.

pub fn reset_parameters(&self) -> QueryResponseFut<ServerResetParametersResult>

Resets all DHCP server parameters to their default value. On success, the reset parameter values can be queried immediately with GetParameter or ListParameters. However, the server must be restarted before all new parameter values take effect.

Setting parameters is only allowed if the server is stopped. ZX_ERR_BAD_STATE is returned otherwise.

• error a zx.Status indicating the cause of failure.

pub fn clear_leases(&self) -> QueryResponseFut<ServerClearLeasesResult>

Clears all leases maintained by the Server. On success, ClearLeases will take effect immediately. Server administrators should take care when calling this method as the DHCP protocol does not provide a mechanism by which a Server can notify a client that its lease has been cleared.

• error a zx.Status indicating the cause of failure.

Trait Implementations

impl Clone for Server_Proxy

fn clone(&self) -> Server_Proxy

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Server_Proxy

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

Formats the value using the given formatter.

impl Proxy for Server_Proxy

type Protocol = Server_Marker

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.

impl Server_ProxyInterface for Server_Proxy

type StartServingResponseFut = QueryResponseFut<Result<(), i32>>

fn start_serving(&self) -> Self::StartServingResponseFut

type StopServingResponseFut = QueryResponseFut<()>

fn stop_serving(&self) -> Self::StopServingResponseFut

type IsServingResponseFut = QueryResponseFut<bool>

fn is_serving(&self) -> Self::IsServingResponseFut

type GetOptionResponseFut = QueryResponseFut<Result<Option_, i32>>

fn get_option(&self, code: OptionCode) -> Self::GetOptionResponseFut

type GetParameterResponseFut = QueryResponseFut<Result<Parameter, i32>>

fn get_parameter(&self, name: ParameterName) -> Self::GetParameterResponseFut

type SetOptionResponseFut = QueryResponseFut<Result<(), i32>>

fn set_option(&self, value: &Option_) -> Self::SetOptionResponseFut

type SetParameterResponseFut = QueryResponseFut<Result<(), i32>>

fn set_parameter(&self, value: &Parameter) -> Self::SetParameterResponseFut

type ListOptionsResponseFut = QueryResponseFut<Result<Vec<Option_>, i32>>

fn list_options(&self) -> Self::ListOptionsResponseFut

type ListParametersResponseFut = QueryResponseFut<Result<Vec<Parameter>, i32>>

fn list_parameters(&self) -> Self::ListParametersResponseFut

type ResetOptionsResponseFut = QueryResponseFut<Result<(), i32>>

fn reset_options(&self) -> Self::ResetOptionsResponseFut

type ResetParametersResponseFut = QueryResponseFut<Result<(), i32>>

fn reset_parameters(&self) -> Self::ResetParametersResponseFut

type ClearLeasesResponseFut = QueryResponseFut<Result<(), i32>>

fn clear_leases(&self) -> Self::ClearLeasesResponseFut