Skip to main content
Version: v0.0.3

Class: NetTransport

Wraps a net.Socket as a Transport, mapping socket EventEmitter events to registered single-handler callbacks.

Each onXxx(fn) call replaces the prior handler and re-registers on the socket (uses socket.removeAllListeners(event) + socket.on(event, fn)).

Example​

const t = new NetTransport(socket);
t.onData((chunk) => process(chunk));
t.onError((err) => handleError(err));

Implements​

Constructors​

Constructor​

new NetTransport(socket): NetTransport

Wrap an existing net.Socket (or tls.TLSSocket) as a Transport.

Parameters​

socket​

Socket

The connected (or connecting) socket to adapt.

Returns​

NetTransport

Methods​

close()​

close(): void

See Transport.close.

Returns​

void

Implementation of​

Transport.close

destroy()​

destroy(reason?): void

See Transport.destroy.

Parameters​

reason?​

Error

Returns​

void

Implementation of​

Transport.destroy

onClose()​

onClose(fn): void

See Transport.onClose.

Parameters​

fn​

() => void

Returns​

void

Implementation of​

Transport.onClose

onConnect()​

onConnect(fn): void

See Transport.onConnect.

Parameters​

fn​

() => void

Returns​

void

Implementation of​

Transport.onConnect

onData()​

onData(fn): void

See Transport.onData.

Parameters​

fn​

(chunk) => void

Returns​

void

Implementation of​

Transport.onData

onError()​

onError(fn): void

See Transport.onError.

Parameters​

fn​

(err) => void

Returns​

void

Implementation of​

Transport.onError

write()​

write(buf): boolean

See Transport.write.

Parameters​

buf​

Buffer

Returns​

boolean

Implementation of​

Transport.write