Struct HelloProtocol 

pub struct HelloProtocol<T: LinkMedium> {
    pub core: HelloCore,
    pub medium: T,
}

Generic neighbor discovery protocol over any LinkMedium.

Contains the shared SWIM/hello/probe state machine and delegates to T for link-specific operations. Concrete types are typically exposed via type aliases:

pub type UdpNeighborDiscovery = HelloProtocol<UdpMedium>;
pub type EtherNeighborDiscovery = HelloProtocol<EtherMedium>;

Fields

core: HelloCore

medium: T

Implementations

impl<T: LinkMedium> HelloProtocol<T>

pub fn create(medium: T, node_name: Name, config: DiscoveryConfig) -> Self

Create a new HelloProtocol with the given medium, node name, and config.

pub fn core(&self) -> &HelloCore

Access the shared core state.

pub fn medium(&self) -> &T

Access the link medium.

pub fn set_served_prefixes(&self, prefixes: Vec<Name>)

Set the prefixes this node serves (announced in Hello Data when InHello mode).

pub fn build_hello_interest(&self, nonce: u32) -> Bytes

pub fn build_hello_payload(&self) -> HelloPayload

Build a HelloPayload from the current shared state.

Called by LinkMedium::build_hello_data to get the payload content before applying link-specific signing.

impl HelloProtocol<UdpMedium>

pub fn new(multicast_face_id: FaceId, node_name: Name) -> Self

Create a new UdpNeighborDiscovery with the default LAN profile.

pub fn new_with_config( multicast_face_id: FaceId, node_name: Name, config: DiscoveryConfig, ) -> Self

pub fn new_multi( face_ids: Vec<FaceId>, node_name: Name, config: DiscoveryConfig, ) -> Self

Create a UdpNeighborDiscovery listening on multiple multicast faces (one per network interface).

A transient Ed25519 key is derived deterministically from the node name via SHA-256. Callers that need a persistent key should use new_multi_with_signer.

pub fn new_multi_with_signer( face_ids: Vec<FaceId>, node_name: Name, config: DiscoveryConfig, signer: Arc<dyn Signer>, ) -> Self

Create with an explicit signer (e.g. from the router’s PIB).

pub fn with_unicast_port(self, port: u16) -> Self

Set the UDP unicast port this node listens on for forwarding traffic.

pub fn from_profile( multicast_face_id: FaceId, node_name: Name, profile: &DiscoveryProfile, ) -> Self

Trait Implementations

impl<T: LinkMedium> DiscoveryProtocol for HelloProtocol<T>

fn protocol_id(&self) -> ProtocolId

Unique protocol identifier.

fn claimed_prefixes(&self) -> &[Name]

NDN name prefixes this protocol reserves.

fn tick_interval(&self) -> Duration

How often the engine should call on_tick.

fn on_face_up(&self, face_id: FaceId, ctx: &dyn DiscoveryContext)

Called when a new face comes up (after FaceTable::insert).

fn on_face_down(&self, face_id: FaceId, ctx: &dyn DiscoveryContext)

Called when a face goes down (before FaceTable::remove).

fn on_inbound( &self, raw: &Bytes, incoming_face: FaceId, meta: &InboundMeta, ctx: &dyn DiscoveryContext, ) -> bool

Called for every inbound raw packet before it enters the pipeline.

fn on_tick(&self, now: Instant, ctx: &dyn DiscoveryContext)

Periodic tick, called by the engine’s tick task at tick_interval.