Struct dhcpv4::server::Server

pub struct Server<DS: DataStore, TS: SystemTimeSource = StdSystemTime> { /* private fields */ }

A minimal DHCP server.

This comment will be expanded upon in future CLs as the server design is iterated upon.

Implementations

impl<DS: DataStore, TS: SystemTimeSource> Server<DS, TS>

pub fn new_from_state( store: DS, params: ServerParameters, options_repo: HashMap<OptionCode, DhcpOption>, records: ClientRecords ) -> Result<Self, Error>

Attempts to instantiate a new Server value from the persisted state contained in the provided parts. If the client leases and address pool contained in the provided parts are inconsistent with one another, then instantiation will fail.

pub fn new_with_time_source( store: DS, params: ServerParameters, options_repo: HashMap<OptionCode, DhcpOption>, records: ClientRecords, time_source: TS ) -> Result<Self, Error>

pub fn new(store: Option<DS>, params: ServerParameters) -> Self

Instantiates a new Server, without persisted state, from the supplied parameters.

pub fn dispatch(&mut self, msg: Message) -> Result<ServerAction, ServerError>

Dispatches an incoming DHCP message to the appropriate handler for processing.

If the incoming message is a valid client DHCP message, then the server will attempt to take appropriate action to serve the client’s request, update the internal server state, and return the suitable response. If the incoming message is invalid, or the server is unable to serve the request, or the processing of the client’s request resulted in an error, then dispatch() will return the fitting Err indicating what went wrong.

Trait Implementations

impl<DS: DataStore, TS: SystemTimeSource> ServerDispatcher for Server<DS, TS>

fn try_validate_parameters(&self) -> Result<&ServerParameters, Status>

Validates the current set of server parameters returning a reference to the parameters if the configuration is valid or an error otherwise.

fn dispatch_get_option(&self, code: OptionCode) -> Result<Option_, Status>

Retrieves the stored DHCP option value that corresponds to the OptionCode argument.

fn dispatch_get_parameter( &self, name: ParameterName ) -> Result<Parameter, Status>

Retrieves the stored DHCP server parameter value that corresponds to the ParameterName argument.

fn dispatch_set_option(&mut self, value: Option_) -> Result<(), Status>

Updates the stored DHCP option value to the argument.

fn dispatch_set_parameter(&mut self, value: Parameter) -> Result<(), Status>

Updates the stored DHCP server parameter to the argument.

fn dispatch_list_options(&self) -> Result<Vec<Option_>, Status>

Retrieves all of the stored DHCP option values.

fn dispatch_list_parameters(&self) -> Result<Vec<Parameter>, Status>

Retrieves all of the stored DHCP parameter values.

fn dispatch_reset_options(&mut self) -> Result<(), Status>

Resets all DHCP options to have no value.

fn dispatch_reset_parameters( &mut self, defaults: &ServerParameters ) -> Result<(), Status>

Resets all DHCP server parameters to their default values in defaults.

fn dispatch_clear_leases(&mut self) -> Result<(), Status>

Clears all leases from the store maintained by the ServerDispatcher.