Class UnixTransport

Unix socket transport.

Hierarchy (View Summary)

StreamTransport<Socket>
- UnixTransport

Index

Properties

attributes conn rx

Accessors

Methods

reopen toString tx connect

Properties

`Readonly`attributes

attributes: Transport.Attributes

Attributes of the transport.

`Protected` `Readonly`conn

conn: Socket

`Readonly`rx

Iterable of incoming packets received through the transport.

Accessors

mtu

get mtu(): number
Report MTU as Infinity.

Returns number
Inherited from StreamTransport.mtu
- Defined in pkg/l3face/lib/stream-transport.d.ts:7

Methods

reopen

reopen(): Promise<UnixTransport>
Reopen the transport by making a new connection with the same options.

Returns Promise<UnixTransport>
Overrides StreamTransport.reopen
- Defined in pkg/node-transport/src/unix-transport.ts:30

toString

toString(): string
Returns string
Inherited from StreamTransport.toString
- Defined in pkg/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.
Inherited from StreamTransport.tx
- Defined in pkg/l3face/lib/stream-transport.d.ts:9

`Static`connect

connect(path: string | IpcSocketConnectOpts): Promise<UnixTransport>
Create a transport and connect to remote endpoint.
Parameters
- path: string | IpcSocketConnectOpts
  Unix socket path or IPC options.
Returns Promise<UnixTransport>
See
UnixTransport.createFace
- Defined in pkg/node-transport/src/unix-transport.ts:14