Interface Attributes

interface Attributes {
    advertiseFrom?: boolean;
    describe?: string;
    local?: boolean;
    multicast?: boolean;
    [k: string]: unknown;
}

Hierarchy (View Summary)

Indexable

  • [k: string]: unknown

Properties

advertiseFrom? describe? local? multicast?

Properties

OptionaladvertiseFrom

advertiseFrom?: boolean

Whether to readvertise registered routes.

Default Value

false. This default is set in CreateFaceFunc but could be different elsewhere.

Remarks

This attribute passed to @ndn/fw!FwFace.Attributes.advertiseFrom. With the default false value, routes "announced" by an L3Face would not be readvertised to @ndn/fw!ReadvertiseDestinations, so that remote forwarders would not depend on the local logical forwarder to forward Interests between L3Faces.

Optionaldescribe

describe?: string

Textual description.

Default Value

Automatically generated from constructor name.

Optionallocal

local?: boolean

Whether the transport connects to a destination on the local machine.

Default Value

false

Optionalmulticast

multicast?: boolean

Whether the transport can possibly talk to multiple peers.

Default Value

false

Settings

Member Visibility

On This Page

Properties