Interface Options

interface Options {
    addRoutes?: readonly NameLike[];
    attributes?: L3Face.Attributes;
    fw?: Forwarder;
    gqlServer?: string;
    localHost?: string;
    memif?: MemifOptions;
    mtu?: number;
    scheme?: "udp" | "memif";
    udp?: OpenSocketOptions;
}

Index

Properties

addRoutes? attributes? fw? gqlServer? localHost? memif? mtu? scheme? udp?

Properties

`Optional`addRoutes

addRoutes?: readonly NameLike[]

Routes to be added on the created face.

Default Value

["/"]

`Optional`attributes

attributes?: L3Face.Attributes

NDNts face attributes.

`Optional`fw

NDNts logical forwarder.

Default Value

Forwarder.getDefault()

`Optional`gqlServer

gqlServer?: string

NDN-DPDK GraphQL server.

Default Value

http://127.0.0.1:3030

`Optional`localHost

localHost?: string

IP address to reach local host from NDN-DPDK.

Default Value

Auto-detected from GraphQL HTTP client.

`Optional`memif

memif?: MemifOptions

memif options.

`Optional`mtu

mtu?: number

Face MTU.

Default Value

For UDP, 1400.
For memif, .memif.dataroom or 2048.

`Optional`scheme

scheme?: "udp" | "memif"

Transport scheme.

Default Value

"udp"

`Optional`udp

udp?: OpenSocketOptions

UDP socket options.