Class Transport`Abstract`

Low-level transport.

Remarks

The transport understands NDN TLV structures, but does not otherwise concern with packet format.

Hierarchy (View Summary, Expand)

Transport

Index

Properties

Accessors

Methods

reopen toString tx

Constructors

`Protected`constructor

new Transport(attributes: Transport.Attributes): Transport
Constructor.
Parameters
- attributes: Transport.Attributes
  Attributes of the transport.
Returns Transport
- Defined in transport.ts:16

Properties

`Readonly`attributes

attributes: Transport.Attributes

Attributes of the transport.

`Abstract` `Readonly`rx

Iterable of incoming packets received through the transport.

Accessors

mtu

get mtu(): number
Return the transport MTU.

Returns number
Remarks
The transport should be able to send TLV structure of up to this size. If not overridden, return a conservative number.

Note that this does not restrict incoming packet size.
- Defined in transport.ts:27

Methods

reopen

reopen(): Promise<Transport>
Reopen the transport after it has failed.

Returns Promise<Transport>
The same transport or a new transport after it has been reconnected.

Throws
@ndn/l3face!Transport.ReopenNotSupportedError Thrown to indicate the transport does not support reopening.
- Defined in transport.ts:51

toString

toString(): string
Returns string
- Defined in transport.ts:55

`Abstract`tx

tx(iterable: TxIterable): Promise<void>
Function to accept outgoing packet stream.
Parameters
- iterable: TxIterable
  Iterable of outgoing packets sent through the transport. Size of each packet cannot exceed .mtu.
Returns Promise<void>
Promise that resolves when iterable is exhausted or rejects upon error.
- Defined in transport.ts:38