NDNts

    Interface ConnectNetworkOptions

    connectToNetwork options.

    interface ConnectNetworkOptions {
        addRoutes?: NameLike[];
        connectTimeout?: number;
        fallback?: readonly string[];
        fastest?: number;
        fch?: false | FchRequest;
        fw?: Forwarder;
        H3Transport?: typeof H3Transport;
        mtu?: number;
        preferH3?: boolean;
        preferTcp?: boolean;
        testConnection?:
            | false
            | TestConnectionPacket
            | TestConnectionPacket[]
            | ((face: FwFace) => Promise<unknown>);
        testConnectionTimeout?: number;
        tryDefaultGateway?: boolean;
    }

    Hierarchy (View Summary)

    Index

    Properties

    addRoutes? connectTimeout? fallback? fastest? fch? fw? H3Transport? mtu? preferH3? preferTcp? testConnection? testConnectionTimeout? tryDefaultGateway?

    Properties

    addRoutes?: NameLike[]

    Routes to be added on the created face.

    ["/"]

    connectTimeout?: number

    Connect timeout (in milliseconds).

    fallback?: readonly string[]

    Fallback routers, used if FCH and default gateway are both unavailable.

    fastest?: number

    Number of faces to keep; others are closed. Faces are ranked by shortest testConnection duration.

    1

    fch?: false | FchRequest

    FCH request, or false to disable FCH query.

    { count: 4 }

    fw?: Forwarder

    Logical forwarder to attach faces to.

    Forwarder.getDefault()

    H3Transport?: typeof H3Transport

    Enable HTTP/3 transport.

    This is only relevant in browser environment.

    This should be set to H3Transport class instance. Having this option avoids always pulling in H3Transport code, to reduce browser bundle size in applications that do not use it.

    mtu?: number

    Override MTU of datagram faces.

    preferH3?: boolean

    Whether to try HTTP/3 before all other options.

    false

    Ignored if H3Transport is not enabled or supported.

    preferTcp?: boolean

    Use TCP instead of UDP.

    This is only relevant in Node.js environment.

    testConnection?:
        | false
        | TestConnectionPacket
        | TestConnectionPacket[]
        | ((face: FwFace) => Promise<unknown>)

    Test face connection.

    "/localhop/nfd/rib/list"

    • false: skip test.
    • string or Name or Interest or array: express Interest(s) and wait for first Data reply. If string ends with "/*", it's replaced with a random component.
    • function: execute the custom tester function.
    testConnectionTimeout?: number

    InterestLifetime of connection test Interest packets.

    2000

    Used only if testConnection is a string or Name.

    tryDefaultGateway?: boolean

    Whether to consider default IPv4 gateway as a candidate.

    true

    This option has no effect if IPv4 gateway cannot be determined, e.g. in browser.

    Settings

    Member Visibility

    On This Page

    Properties
    MMNEPVFCICPMFPCPTTAAATR