Class L3Face

Network layer face for sending and receiving L3 packets.

Hierarchy

TypedEventTarget<EventMap>
- L3Face

Implements

RxTx

Index

Constructors

Properties

attributes lp rx

Accessors

Methods

Constructors

constructor

new L3Face(transport, attributes?, lpOptions?): L3Face
Constructor.
Parameters
- transport: Transport
  Initial transport. It may be replaced through reopen mechanism.
- attributes: L3Face.Attributes = {}
  Additional attributes. L3Face attributes consist of transport attributes overridden by these attributes.
- lpOptions: LpService.Options = {}
  NDNLPv2 service options.
Returns L3Face
Overrides TypedEventTarget<EventMap>.constructor
- Defined in pkg/l3face/src/l3face.ts:37

Properties

`Readonly` attributes

attributes: L3Face.Attributes

Attributes of a network layer face.

Remarks

When L3Face is added to a logical forwarder, this is copied to FwFace.attributes.

`Readonly` lp

`Readonly` rx

rx: AsyncIterable<FwPacket<L3Pkt>>

RX packet stream received by the logical forwarder.

Accessors

state

get state(): L3Face.State
Obtain face UP/DOWN state.

Returns L3Face.State
Remarks
Caller can get notifications about state transitions via state/up/down/close events.
- Defined in pkg/l3face/src/l3face.ts:69
set state(newState): void
Parameters
- newState: L3Face.State
Returns void
- Defined in pkg/l3face/src/l3face.ts:70

Methods

`Readonly` tx

tx(iterable): Promise<void>
Parameters
- iterable: AsyncIterable<FwPacket<L3Pkt>>
Returns Promise<void>
Implementation of RxTx.tx
- Defined in pkg/l3face/src/l3face.ts:170

Generated using TypeDoc