Class StreamTransport<T>

Node.js stream-based transport.

Type Parameters

T extends NodeJS.ReadWriteStream = NodeJS.ReadWriteStream

Hierarchy (View Summary)

Transport
- StreamTransport
  - TcpTransport
  - UnixTransport

Index

Constructors

Properties

attributes conn rx

Accessors

Methods

reopen toString tx

Constructors

constructor

new StreamTransport<T extends ReadWriteStream = ReadWriteStream>(
conn: T,
attrs?: Record<string, unknown>,
): StreamTransport<T>
Type Parameters
- T extends ReadWriteStream = ReadWriteStream
Parameters
- conn: T
- attrs: Record<string, unknown> = {}
Returns StreamTransport<T>
Overrides Transport.constructor
- Defined in pkg/l3face/src/stream-transport.ts:6

Properties

`Readonly`attributes

attributes: Transport.Attributes

Attributes of the transport.

`Protected` `Readonly`conn

conn: T

`Readonly`rx

Iterable of incoming packets received through the transport.

Accessors

mtu

get mtu(): number
Report MTU as Infinity.

Returns number
Overrides Transport.mtu
- Defined in pkg/l3face/src/stream-transport.ts:12

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.
Inherited from Transport.reopen
- Defined in pkg/l3face/src/transport.ts:51

toString

toString(): string
Returns string
Inherited from Transport.toString
- Defined in pkg/l3face/src/transport.ts:55

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.
Overrides Transport.tx
- Defined in pkg/l3face/src/stream-transport.ts:16