Interface ConnectRouterOptions

connectToRouter options.

interface ConnectRouterOptions {
    H3Transport?: typeof H3Transport;
    addRoutes?: NameLike[];
    connectTimeout?: number;
    fw?: Forwarder;
    mtu?: number;
    preferTcp?: boolean;
    testConnection?: false | TestConnectionPacket | TestConnectionPacket[] | ((face) => Promise<unknown>);
    testConnectionTimeout?: number;
}

Hierarchy (view full)

Properties

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.

addRoutes?: NameLike[]

Routes to be added on the created face.

Default Value

["/"]

connectTimeout?: number

Connect timeout (in milliseconds).

Logical forwarder to attach faces to.

Default Value

Forwarder.getDefault()

mtu?: number

Override MTU of datagram faces.

preferTcp?: boolean

Use TCP instead of UDP.

Remarks

This is only relevant in Node.js environment.

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

Test face connection.

Type declaration

    • (face): Promise<unknown>
    • Parameters

      Returns Promise<unknown>

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.
testConnectionTimeout?: number

InterestLifetime of connection test Interest packets.

Default Value

2000

Remarks

Used only if testConnection is a string or Name.

Generated using TypeDoc