Struct Server

pub struct Server {
    pub socket: Socket,
    pub ip: Ipv4Addr,
    pub config: Config,
    pub ip_pool: IpPool,
}

Ties together a Config, Socket, and IpPool in order to handle incoming Client Messages, and construct server-specific response Messages.

Used by the server binary and integration tests.

Requires the v4_server feature, which is enabled by default.

Fields

socket: Socket

A UdpSocket that understands Deliverables to communicate with the Client

ip: Ipv4Addr

Direct access to the ipv4 address passed to the UdpSocket.

A server with multiple network addresses may use any of its addresses.

config: Config

Configuration read from toe-beans.toml

ip_pool: IpPool

Manages the leasing logic of a range of ip addresses

Implementations

impl Server

pub fn new(config: Config) -> Self

Setup everything necessary for a Server to listen for incoming Messages.

This fn is relatively “slow” and may panic, but that is okay because it is called before the listen or listen_once fns.

pub fn listen_once(&mut self)

Will wait for one Message on the UdpSocket and send a response based on it.

To handle more than one Message, use listen.

pub fn listen(&mut self) -> !

Calls listen_once in a loop forever.

pub fn offer(&mut self, message: Message) -> Result<Message>

Sent from the server to client following a Discover message

pub fn ack(&mut self, message: Message, yiaddr: Ipv4Addr) -> Message

Sent from the server to client following a Request message

Acks behave differently depending on if they are sent in response to a DHCP Request or DHCP Inform. For example, a DHCP Request must send lease time and a DHCP Inform must not.

Any configuration parameters in the DHCPACK message SHOULD NOT conflict with those in the earlier DHCPOFFER message to which the client is responding.

pub fn ack_inform(&self, message: Message) -> Message

Sent from server to client in response to an Inform message

Acks behave differently depending on if they are sent in response to a DHCP Request or DHCP Inform. For example, a DHCP Request must send lease time and a DHCP Inform must not.

pub fn nak(&self, message: Message, error: String) -> Message

Sent from the server to client following a Request message