Class TlsConnection

An implementation of ITlsConnection using Deno's connectTls function

Hierarchy

BaseConnection<Deno.TlsConn>
- TlsConnection

Implements

ITlsConnection

Index

Constructors

Properties

Accessors

localAddress remoteAddress

Methods

close getAlpnProtocol read setKeepAlive setNoDelay write

Constructors

constructor

new TlsConnection(
conn: TlsConn,
handshake?: null | TlsHandshakeInfo,
): TlsConnection
Parameters
- conn: TlsConn
  Underlying connection
- handshake: null | TlsHandshakeInfo = null
  TLS handshake info (if available)
Returns TlsConnection
Overrides BaseConnection<Deno.TlsConn>.constructor
- Defined in deno/src/connection.ts:102

Properties

`Readonly`conn

conn: TlsConn

Underlying connection

`Readonly`handshake

handshake: null | TlsHandshakeInfo = null

TLS handshake info (if available)

Accessors

localAddress

get localAddress(): TcpEndpoint
local address of the connection (if available)

Returns TcpEndpoint
Implementation of ITlsConnection.localAddress
- Defined in deno/src/connection.ts:111

remoteAddress

get remoteAddress(): TcpEndpoint
remote address of the connection (if available)

Returns TcpEndpoint
Implementation of ITlsConnection.remoteAddress
- Defined in deno/src/connection.ts:115

Methods

close

close(): void
Close the underlying source.

Returns void
Implementation of ITlsConnection.close
Inherited from BaseConnection.close
- Defined in deno/src/connection.ts:68

getAlpnProtocol

getAlpnProtocol(): null | string
get the ALPN protocol that was negotiated in the handshake

Returns null | string
Implementation of ITlsConnection.getAlpnProtocol
- Defined in deno/src/connection.ts:127

read

read(into: Uint8Array): Promise<number>
Read data from the underlying source into the provided Uint8Array, up to the length of the array, and return the number of bytes read.

If there are no bytes available currently, the implementation is supposed to wait until at least one byte is available, and only then resolve the promise. Resolving the promise with a zero-length Uint8Array is marking the end of the source.
Parameters
- into: Uint8Array
Returns Promise<number>
Uint8Array containing the bytes that were read.
Implementation of ITlsConnection.read
Inherited from BaseConnection.read
- Defined in deno/src/connection.ts:14

setKeepAlive

setKeepAlive(): void
set keep-alive flag on the connection

Returns void
Implementation of ITlsConnection.setKeepAlive
- Defined in deno/src/connection.ts:119

setNoDelay

setNoDelay(): void
set no-delay flag on the connection

Returns void
Implementation of ITlsConnection.setNoDelay
- Defined in deno/src/connection.ts:123

write

write(bytes: Uint8Array): Promise<void>
Write bytes to the underlying stream, resolving once the write is complete
Parameters
- bytes: Uint8Array
Returns Promise<void>
Implementation of ITlsConnection.write
Inherited from BaseConnection.write
- Defined in deno/src/connection.ts:43