Class MemifTransport

Shared Memory Packet Interface (memif) transport.

Hierarchy (View Summary, Expand)

Transport
- MemifTransport

Index

Properties

attributes memif rx

Accessors

Methods

reopen toString tx connect

Properties

`Readonly`attributes

attributes: Transport.Attributes

Attributes of the transport.

`Readonly`memif

memif: Memif

Access the underlying Memif instance.

Remarks

You may read counters and monitor "memif:up" "memif:down" events, but not send/receive packets.

`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.
Overrides Transport.mtu
- Defined in dpdkmgmt/src/memif-transport.ts:44

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 l3face/lib/transport.d.ts:41

toString

toString(): string
Returns string
Inherited from Transport.toString
- Defined in l3face/lib/transport.d.ts:42

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 dpdkmgmt/src/memif-transport.ts:48

`Static`connect

connect(opts: MemifTransport.Options): Promise<MemifTransport>
Create a transport and establish connection.
Parameters
- opts: MemifTransport.Options
Returns Promise<MemifTransport>
- Defined in dpdkmgmt/src/memif-transport.ts:9