Interface CreateFaceOptions

Options to createFace as first parameter.

interface CreateFaceOptions {
    addRoutes?: readonly NameLike[];
    callback?: (transport: Transport, l3face: L3Face, fwFace: FwFace) => void;
    fw?: Forwarder;
    l3?: L3Face.Attributes;
    lp?: LpService.Options;
}

Properties

addRoutes? callback? fw? l3? lp?

Properties

OptionaladdRoutes

addRoutes?: readonly NameLike[]

Routes to be added on the created face.

Default Value

["/"]

Optionalcallback

callback?: (transport: Transport, l3face: L3Face, fwFace: FwFace) => void

A callback to receive Transport, L3Face, and FwFace objects.

Remarks

This can be useful for reading counters or listening to events on these objects.

Optionalfw

fw?: Forwarder

Forwarder instance to add the face to.

Default Value

Forwarder.getDefault()

Optionall3

l3?: L3Face.Attributes

L3Face attributes.

Remarks

.l3.advertiseFrom defaults to false in createFace function.

Optionallp

lp?: LpService.Options

NDNLP service options.

Settings

Member Visibility

On This Page

Properties