Class TapFace

Readonlyface

Readonlyrx

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

tx

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

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

  Parameters

  • iterable: AsyncIterable<FwPacket<L3Pkt>>

  Returns Promise<void>

Staticcreate

• create(face: FwFace): FwFace

  Create a new secondary Forwarder and add a TapFace.

  Parameters

  • face: FwFace

    FwFace on the existing primary forwarder.

  Returns FwFace

  FwFace on a new forwarder. The forwarder may be retrieved in .fw property.