Interface Options

interface Options {
    announcement?: FwFace.RouteAnnouncement;
    autoBuffer?: boolean;
    concurrency?: number;
    dataBuffer?: DataBuffer;
    dataSigner?: Signer;
    describe?: string;
    fw?: Forwarder;
    modifyInterest?: Modify;
    retx?: RetxPolicy;
    routeCapture?: boolean;
    signal?: AbortSignal;
    verifier?: Verifier;
}

Hierarchy

Properties

announcement? autoBuffer? concurrency? dataBuffer? dataSigner? describe? fw? modifyInterest? retx? routeCapture? signal? verifier?

Properties

Optional announcement

announcement?: FwFace.RouteAnnouncement

What name to be readvertised. Ignored if prefix is undefined.

Optional autoBuffer

autoBuffer?: boolean

Whether to add handler return value to buffer. Default is true. Ignored when dataBuffer is not specified.

Optional concurrency

concurrency?: number

How many Interests to process in parallel. Default is 1.

Optional dataBuffer

dataBuffer?: DataBuffer

Outgoing Data buffer.

Optional dataSigner

dataSigner?: Signer

If specified, automatically sign Data packets unless already signed. This does not apply to Data packets manually inserted to the dataBuffer.

Optional describe

describe?: string

Description for debugging purpose.

Optional fw

fw?: Forwarder

Optional modifyInterest

modifyInterest?: Modify

Modify Interest according to specified options. Default is no modification.

Optional retx

retx?: RetxPolicy

Retransmission policy. Default is disabling retransmission.

Optional routeCapture

routeCapture?: boolean

Whether routes registered by producer would cause @ndn/fw internal FIB to stop matching toward shorter prefixes. Default is true.

If all nexthops of a FIB entry are set to non-capture, FIB lookup may continue onto nexthops on FIB entries with shorter prefixes. One use case is in @ndn/sync package, where both local and remote sync participants want to receive each other's Interests.

Optional signal

signal?: AbortSignal

AbortSignal that allows canceling the Interest via AbortController.

Optional verifier

verifier?: Verifier

Data verifier. Default is no verification.

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc