Struct netstack3_ip::nud::NeighborApi

pub struct NeighborApi<I: Ip, D, C>(/* private fields */);

The neighbor API.

Implementations

impl<I: Ip, D, C> NeighborApi<I, D, C>

pub fn new(ctx: C) -> Self

Creates a new API instance.

impl<I, D, C> NeighborApi<I, D, C>

where I: Ip, D: LinkDevice, C: ContextPair, C::CoreContext: NudContext<I, D, C::BindingsContext>, C::BindingsContext: NudBindingsContext<I, D, <C::CoreContext as DeviceIdContext<D>>::DeviceId>,

pub fn resolve_link_addr( &mut self, device_id: &<C::CoreContext as DeviceIdContext<D>>::DeviceId, dst: &SpecifiedAddr<I::Addr>, ) -> LinkResolutionResult<D::Address, <<C::BindingsContext as LinkResolutionContext<D>>::Notifier as LinkResolutionNotifier<D>>::Observer>

Resolve the link-address for a given device’s neighbor.

Lookup the given destination IP address in the neighbor table for given device, returning either the associated link-address if it is available, or an observer that can be used to wait for link address resolution to complete.

pub fn flush_table( &mut self, device: &<C::CoreContext as DeviceIdContext<D>>::DeviceId, )

Flush neighbor table entries.

pub fn insert_static_entry( &mut self, device_id: &<C::CoreContext as DeviceIdContext<D>>::DeviceId, neighbor: I::Addr, link_address: D::Address, ) -> Result<(), StaticNeighborInsertionError>

Sets a static neighbor entry for the neighbor.

If no entry exists, a new one may be created. If an entry already exists, it will be updated with the provided link address and set to be a static entry.

Dynamic updates for the neighbor will be ignored for static entries.

pub fn remove_entry( &mut self, device_id: &<C::CoreContext as DeviceIdContext<D>>::DeviceId, neighbor: I::Addr, ) -> Result<(), NeighborRemovalError>

Remove a static or dynamic neighbor table entry.

pub fn inspect_neighbors<N: Inspector>( &mut self, device: &<C::CoreContext as DeviceIdContext<D>>::DeviceId, inspector: &mut N, )

where D::Address: Display,

Writes device’s neighbor state information into inspector.