Struct IpPool

pub struct IpPool { /* private fields */ }

Used to manage the dynamic collection of IP addresses that the server leases.

Implementations

impl IpPool

pub const FILE_NAME: &'static str = "toe-beans-leases.toml"

The file name that the IpPool is read from and written to.

pub fn new(config: &Config) -> Self

Create a pool with the capacity of the configured network’s size.

pub fn restore(config: &Config) -> Result<Self>

Restores the state of an IpPool from a toe-beans-leases.toml as long as the IpPool’s network (range/capacity) has not changed. Static leases are verified to be within network range.

This does not restore dhcp offers.

pub fn restore_or_new(config: &Config) -> Self

Use the toe-beans-leases.toml to restore past leases or return a new IpPool if that was not successful.

pub fn offer( &mut self, owner: MacAddress, requested_ip: Option<Ipv4Addr>, ) -> Result<Ipv4Addr>

Takes an available IP address, marks it as offered, and returns it.

Returns one of:

• The previously offered address, if one has been offered.
• The requested address:
  • If one was requested,
  • and it is in the pool’s range,
  • and it is available
• Otherwise any available address (unless none are available).

pub fn ack(&mut self, owner: MacAddress) -> Result<Ipv4Addr>

Takes a chaddr’s offered ip address and marks it as reserved then commits it to persistent storage and returns the address.

Currently only one IP is allowed per chaddr.

pub fn extend(&mut self, owner: MacAddress, ip: Ipv4Addr) -> Result<()>

Resets the time of an acked lease. Used in the lease renew/rebind process.

pub fn unoffer(&mut self, owner: MacAddress) -> Result<()>

Makes an ip address that was reserved during an offer available again.

pub fn release(&mut self, owner: MacAddress) -> Result<()>

Makes an ip address that was acked available again.

pub fn is_available(&self, ip: &Ipv4Addr) -> bool

Checks whether the passed IP address is available in the pool.

pub fn verify_lease(&self, owner: MacAddress, ip: &Ipv4Addr) -> Result<()>

Checks if the passed IP address matches the committed, leased IP address, and that the lease is not expired.

pub fn is_expired(&self, owner: &MacAddress) -> Result<bool>

Looks up a lease, if one is found, and checks if it has expired.

Trait Implementations

impl<'de> Deserialize<'de> for IpPool

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for IpPool

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.