Class NfdPrefixReg

Readvertise prefix announcements via NFD prefix registration protocol.

Hierarchy (View Summary)

ReadvertiseDestination<State>
- NfdPrefixReg

Index

Constructors

Methods

advertise disable doAdvertise doWithdraw enable listAnnouncementObjs makeState restart withdraw

Constructors

constructor

new NfdPrefixReg(face: FwFace, opts: NfdPrefixReg.Options): NfdPrefixReg
Constructor.
Parameters
- face: FwFace
- opts: NfdPrefixReg.Options
Returns NfdPrefixReg
Remarks
enableNfdPrefixReg is recommended.
Overrides ReadvertiseDestination.constructor
- Defined in pkg/nfdmgmt/src/prefix-reg.ts:41

Properties

`Protected`closed

closed: boolean

`Protected` `Readonly`queue

queue: Pushable<Name>

`Protected` `Readonly`table

table: NameMap<Record<State>>

Methods

advertise

advertise(name: Name): void
Set a prefix to be advertised.
Parameters
- name: Name
Returns void
Inherited from ReadvertiseDestination.advertise
- Defined in pkg/fw/lib/readvertise.d.ts:78

disable

disable(): void
Disable and detach from forwarder.

Returns void
Remarks
Once detached, this instance is no longer usable.
Overrides ReadvertiseDestination.disable
- Defined in pkg/nfdmgmt/src/prefix-reg.ts:82

`Protected`doAdvertise

doAdvertise(name: Name, state: State): Promise<void>
Advertise a prefix once.
Parameters
- name: Name
- state: State
Returns Promise<void>
Overrides ReadvertiseDestination.doAdvertise
- Defined in pkg/nfdmgmt/src/prefix-reg.ts:143

`Protected`doWithdraw

doWithdraw(name: Name, state: State): Promise<void>
Withdraw a prefix once.
Parameters
- name: Name
- state: State
Returns Promise<void>
Overrides ReadvertiseDestination.doWithdraw
- Defined in pkg/nfdmgmt/src/prefix-reg.ts:176

enable

enable(fw: Forwarder): void
Enable and attach to a forwarder.
Parameters
- fw: Forwarder
Returns void
Inherited from ReadvertiseDestination.enable
- Defined in pkg/fw/lib/readvertise.d.ts:69

`Protected`listAnnouncementObjs

listAnnouncementObjs(name: Name): Iterable<PrefixAnnouncementObj>
Retrieve application supplied prefix announcement objects.
Parameters
- name: Name
Returns Iterable<PrefixAnnouncementObj>
Remarks
This is only available during makeState and doAdvertise.
Inherited from ReadvertiseDestination.listAnnouncementObjs
- Defined in pkg/fw/lib/readvertise.d.ts:96

`Protected`makeState

makeState(name: Name): State
Create per-prefix state.
Parameters
- name: Name
Returns State
Remarks
Must override if State type parameter is changed from the default.
Inherited from ReadvertiseDestination.makeState
- Defined in pkg/fw/lib/readvertise.d.ts:89

`Protected`restart

restart(name: Name, record: Record<State>): void
Parameters
- name: Name
- record: Record<State>
Returns void
Inherited from ReadvertiseDestination.restart
- Defined in pkg/fw/lib/readvertise.d.ts:81

withdraw

withdraw(name: Name): void
Set a prefix to be withdrawn.
Parameters
- name: Name
Returns void
Inherited from ReadvertiseDestination.withdraw
- Defined in pkg/fw/lib/readvertise.d.ts:80