Interface CreateOptions

create options.

interface CreateOptions {
    bridgeName?: string;
    fwA?: Forwarder;
    fwB?: Forwarder;
    fwOpts?: Forwarder.Options;
    relayAB?: Relay;
    relayBA?: Relay;
    routesAB?: readonly NameLike[];
    routesBA?: readonly NameLike[];
}

Properties

bridgeName? fwA? fwB? fwOpts? relayAB? relayBA? routesAB? routesBA?

Properties

OptionalbridgeName

bridgeName?: string

Description for debugging purpose.

OptionalfwA

fwA?: Forwarder

Forwarder A.

Default Value

Forwarder.create(.fwOpts)

Remarks

Disposing the bridge closes auto-created Forwarder but not passed-in Forwarder.

OptionalfwB

fwB?: Forwarder

Forwarder B.

Default Value

Forwarder.create(.fwOpts)

Remarks

Disposing the bridge closes auto-created Forwarder but not passed-in Forwarder.

OptionalfwOpts

fwOpts?: Forwarder.Options

Options for creating Forwarder instances via Forwarder.create.

Remarks

Ignored if both .fwA and .fwB are specified.

OptionalrelayAB

relayAB?: Relay

Relay options for packets from forwarder A to forwarder B.

Default Value

instant delivery

OptionalrelayBA

relayBA?: Relay

Relay options for packets from forwarder B to forwarder A.

Default Value

instant delivery

OptionalroutesAB

routesAB?: readonly NameLike[]

Routes from forwarder A to forwarder B.

Default Value

["/"]

OptionalroutesBA

routesBA?: readonly NameLike[]

Routes from forwarder B to forwarder A.

Default Value

["/"]

Settings

Member Visibility

On This Page

Properties