Skip to main content
Version: v0.0.3

Class: TlsTransport

Wraps a tls.TLSSocket as a Transport. onConnect(fn) is armed on the 'secureConnect' event (handshake complete, including certificate verification when rejectUnauthorized is on) rather than the raw TCP 'connect' event that NetTransport uses.

Each onXxx(fn) call replaces the prior handler and re-registers on the socket (socket.removeAllListeners(event) + socket.on(event, fn)), the same set-once semantics as NetTransport.

Example​

const t = new TlsTransport(tlsSocket);
t.onConnect(() => logger.info('secure'));
t.onError((err) => handleTlsError(err));

Implements​

Constructors​

Constructor​

new TlsTransport(socket): TlsTransport

Wrap an existing tls.TLSSocket (connecting or already secure) as a Transport.

Parameters​

socket​

TLSSocket

The TLS socket to adapt.

Returns​

TlsTransport

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. Armed on 'secureConnect', the TLS handshake-complete event, not the raw TCP 'connect' event.

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