Class TapFace

Create a secondary face by tapping on a primary face.

Remarks

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.

Implements

Constructors

constructor

Properties

face rx

Accessors

attributes

Methods

tx

Constructors

constructor

Properties

Readonlyface

face: FwFace

Readonlyrx

rx: Pushable<FwPacket<L3Pkt>> = ...

RX packet stream received by the logical forwarder.

Accessors

attributes

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

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

    • OptionaladvertiseFrom?: boolean

      Whether to allow prefix announcements.

      Default Value

      true

      Remarks

      If false, FwFace.addAnnouncement has no effect.

    • describe: string
    • Optionallocal?: boolean

      Whether face is local.

      Default Value

      false

    • OptionalrouteCapture?: boolean

      Whether routes registered on this face would cause FIB to stop matching onto shorter prefixes.

      Default Value

      true

      See

      @ndn/endpoint!ProducerOptions.routeCapture

Methods

tx

  • tx(iterable: AsyncIterable<FwPacket<L3Pkt>, any, any>): Promise<void>

  • Function to accept TX packet stream sent by the logical forwarder.

    Parameters

    • iterable: AsyncIterable<FwPacket<L3Pkt>, any, any>

    Returns Promise<void>

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods