Class ReadvertiseDestination<State>`Abstract`

A destination of prefix advertisement.

Remarks

Generally, a prefix advertised to a destination would cause Interests matching the prefix to come to the local logical forwarder, aka prefix registration.

Type Parameters

State extends {} = {}

Hierarchy

ReadvertiseDestination

Index

Constructors

Properties

closed queue table

Methods

advertise disable doAdvertise doWithdraw enable makeState restart withdraw

Constructors

constructor

new ReadvertiseDestination<State>(retryOptions?): ReadvertiseDestination<State>
Type Parameters
- State extends {} = {}
Parameters
- retryOptions: OperationOptions = ...
Returns ReadvertiseDestination<State>
- Defined in readvertise.ts:68

Properties

`Protected`closed

closed: boolean = false

`Protected` `Readonly`queue

queue: Pushable<Name> = ...

`Protected` `Readonly`table

table: NameMap<Record<State>> = ...

Methods

advertise

advertise(name): void
Set a prefix to be advertised.
Parameters
- name: Name
Returns void
- Defined in readvertise.ts:103

disable

disable(): void
Disable and detach from forwarder.

Returns void
Remarks
Once detached, this instance is no longer usable.
- Defined in readvertise.ts:91

`Protected` `Abstract`doAdvertise

doAdvertise(name, state): Promise<void>
Advertise a prefix once.
Parameters
- name: Name
- state: State
Returns Promise<void>
- Defined in readvertise.ts:180

`Protected` `Abstract`doWithdraw

doWithdraw(name, state): Promise<void>
Withdraw a prefix once.
Parameters
- name: Name
- state: State
Returns Promise<void>
- Defined in readvertise.ts:183

enable

enable(fw): void
Enable and attach to a forwarder.
Parameters
- fw: Forwarder
Returns void
- Defined in readvertise.ts:76

`Protected`makeState

makeState(name): State
Create per-prefix state.
Parameters
- name: Name
Returns State
- Defined in readvertise.ts:174

`Protected`restart

restart(name, record): void
Parameters
- name: Name
- record: Record<State>
Returns void
- Defined in readvertise.ts:126

withdraw

withdraw(name): void
Set a prefix to be withdrawn.
Parameters
- name: Name
Returns void
- Defined in readvertise.ts:117