Struct AddressManager 

pub struct AddressManager { /* private fields */ }

Simple single ISD-AS address registry.

Implementations

impl AddressManager

pub fn new( isd_as: IsdAsn, prefixes: Vec<IpNet>, rng: ChaCha8Rng, ) -> Result<Self, AllocatorCreationError>

Create a new address registry for the given ISD-AS and prefixes.

pub fn with_hold_duration(self, hold_duration: Duration) -> Self

Set the hold duration for address grants.

pub fn with_max_attempts(self, max_attempts: usize) -> Self

Set the maximum number of attempts to allocate an address.

pub fn match_isd_as(&self, isd_as: IsdAsn) -> bool

Checks if the given ISD-AS matches the registry’s ISD-AS.

pub fn register( &mut self, id: String, isd_asn: IsdAsn, addr: IpAddr, ) -> Result<AddressGrant, AddressRegistrationError>

Registers a new Address, will remove current grant if id is reused

Parameters

• id: Unique identifier of the allocation. One id can only have one Grant.
• isd_asn: The IsdAsn associated with this address allocation.
• addr: The requested IP address. Use std::net::Ipv4Addr::UNSPECIFIED or std::net::Ipv6Addr::UNSPECIFIED to request any available address.

pub fn put_on_hold( &mut self, id: String, duration_since_start: Duration, ) -> bool

Puts a grant on hold for the default hold period

After this period has passed, the address can be freed by the cleanup job.

pub fn free(&mut self, id: &String) -> bool

Immediately frees an address

Returns true if address existed and was freed, otherwise false

pub fn isd_asn(&self) -> IsdAsn

Get this address registries isd-asn

pub fn prefixes(&self) -> &[IpNet]

Get this address registries prefixes

pub fn min_free_addresses(&self) -> u128

Get the minimal count of free addresses of this registry

Call Self::clean_expired before this to get the actual count

pub fn clean_expired( &mut self, duration_since_start: Duration, ) -> (usize, usize)

Checks all grants and removes expired grants

Should be called periodically

Returns (grant_count_before, grant_count_after)

Trait Implementations

impl Clone for AddressManager

fn clone(&self) -> AddressManager

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for AddressManager

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

Formats the value using the given formatter.

impl From<&AddressManager> for AddressManagerDto

fn from(state: &AddressManager) -> Self

Converts to this type from the input type.

impl PartialEq for AddressManager

fn eq(&self, other: &AddressManager) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl TryFrom<AddressManagerDto> for AddressManager

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: AddressManagerDto) -> Result<Self, Self::Error>

Performs the conversion.

impl Eq for AddressManager

impl StructuralPartialEq for AddressManager