Struct smoltcp::socket::Dhcpv4Socket

pub struct Dhcpv4Socket { /* private fields */ }

Implementations

impl Dhcpv4Socket

DHCP client socket.

The socket acquires an IP address configuration through DHCP autonomously. You must query the configuration with .poll() after every call to Interface::poll(), and apply the configuration to the Interface.

pub fn new() -> Self

Create a DHCPv4 socket

pub fn max_lease_duration(&self) -> Option<Duration>

Get the configured max lease duration.

See also Self::set_max_lease_duration()

pub fn set_max_lease_duration(&mut self, max_lease_duration: Option<Duration>)

Set the max lease duration.

When set, the lease duration will be capped at the configured duration if the DHCP server gives us a longer lease. This is generally not recommended, but can be useful for debugging or reacting faster to network configuration changes.

If None, no max is applied (the lease duration from the DHCP server is used.)

pub fn ignore_naks(&self) -> bool

Get whether to ignore NAKs.

See also Self::set_ignore_naks()

pub fn set_ignore_naks(&mut self, ignore_naks: bool)

Set whether to ignore NAKs.

This is not compliant with the DHCP RFCs, since theoretically we must stop using the assigned IP when receiving a NAK. This can increase reliability on broken networks with buggy routers or rogue DHCP servers, however.

pub fn reset(&mut self)

Reset state and restart discovery phase.

Use this to speed up acquisition of an address in a new network if a link was down and it is now back up.

pub fn poll(&mut self) -> Option<Event>

Query the socket for configuration changes.

The socket has an internal “configuration changed” flag. If set, this function returns the configuration and resets the flag.

Trait Implementations

impl<'a> AnySocket<'a> for Dhcpv4Socket

fn upcast(self) -> Socket<'a>

fn downcast<'c>(socket: &'c mut Socket<'a>) -> Option<&'c mut Self>

impl Debug for Dhcpv4Socket

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

Formats the value using the given formatter.