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)

Properties

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

Properties

OptionaladdRoutes

addRoutes?: NameLike[]

Routes to be added on the created face.

Default Value

["/"]

OptionalconnectTimeout

connectTimeout?: number

Connect timeout (in milliseconds).

Optionalfallback

fallback?: readonly string[]

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

Optionalfastest

fastest?: number

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

Default Value

1

Optionalfch

fch?: false | FchRequest

FCH request, or false to disable FCH query.

Default Value

{ count: 4 }

Optionalfw

fw?: Forwarder

Logical forwarder to attach faces to.

Default Value

Forwarder.getDefault()

OptionalH3Transport

H3Transport?: typeof H3Transport

Enable HTTP/3 transport.

Remarks

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.

Optionalmtu

mtu?: number

Override MTU of datagram faces.

OptionalpreferH3

preferH3?: boolean

Whether to try HTTP/3 before all other options.

Default Value

false

Remarks

Ignored if H3Transport is not enabled or supported.

OptionalpreferTcp

preferTcp?: boolean

Use TCP instead of UDP.

Remarks

This is only relevant in Node.js environment.

OptionaltestConnection

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

Test face connection.

Default Value

"/localhop/nfd/rib/list"

Remarks

  • 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.

OptionaltestConnectionTimeout

testConnectionTimeout?: number

InterestLifetime of connection test Interest packets.

Default Value

2000

Remarks

Used only if testConnection is a string or Name.

OptionaltryDefaultGateway

tryDefaultGateway?: boolean

Whether to consider default IPv4 gateway as a candidate.

Default Value

true

Remarks

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

Settings

Member Visibility

On This Page

Properties