Class TapFace

Create a secondary face by tapping on a primary face.

TapFace is useful for sending in-band management commands to a specific neighbor, after being added to a temporary secondary Forwarder. The TapFace shares the same transport as the primary face, but allows independent FIB and PIT settings. The primary Forwarder will see RX packets, but does not see TX packets.

Hierarchy

  • TapFace

Implements

Constructors

constructor

Properties

face rx

Accessors

attributes

Methods

tx

Constructors

constructor

Properties

Readonly face

face: FwFace

Readonly rx

rx: Pushable<FwPacket<L3Pkt>, void, unknown> = ...

Accessors

attributes

  • get attributes(): {
        advertiseFrom?: boolean;
        describe: string;
        local?: boolean;
        routeCapture?: boolean;
    }

  • Returns {
        advertiseFrom?: boolean;
        describe: string;
        local?: boolean;
        routeCapture?: boolean;
    }

    • Optional advertiseFrom?: boolean

      Whether to readvertise registered routes. Default is true.

    • describe: string

      Short string to identify the face.

    • Optional local?: boolean

      Whether face is local. Default is false.

    • Optional routeCapture?: boolean

      Whether routes registered on this face would cause FIB to stop matching onto shorter prefixes. Default is true. More explanation in @ndn/endpoint package ProducerOptions type.

Methods

tx

  • Parameters

    • iterable: AsyncIterable<FwPacket<L3Pkt>>

    Returns Promise<void>

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc