Class TcpConnection

constructor

• new TcpConnection(): TcpConnection

• Returns TcpConnection

Readonlysocket

localAddress

• get localAddress(): TcpEndpoint

• local address of the connection (if available)

  Returns TcpEndpoint

remoteAddress

• get remoteAddress(): TcpEndpoint

• remote address of the connection (if available)

  Returns TcpEndpoint

close

• close(): void

• Close the underlying source.

  Returns void

connect

• connect(endpoint: TcpEndpoint, tls?: boolean): Promise<void>

• Connect to the given endpoint (must be called as the first thing before using the connection)

  Parameters

  • endpoint: TcpEndpoint
  • tls: boolean = false

  Returns Promise<void>

getAlpnProtocol

• getAlpnProtocol(): null | string

• get the ALPN protocol that was negotiated in the handshake

  Returns null | string

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.

setKeepAlive

• setKeepAlive(_val: boolean): void

• set keep-alive flag on the connection

  Parameters

  • _val: boolean

  Returns void

setNoDelay

• setNoDelay(_val: boolean): void

• set no-delay flag on the connection

  Parameters

  • _val: boolean

  Returns void

write

• write(bytes: Uint8Array): Promise<void>

• Write bytes to the underlying stream, resolving once the write is complete

  Parameters

  • bytes: Uint8Array

  Returns Promise<void>

Staticfrom

• from(socket: Socket<any>): TcpConnection

• Create a new TcpConnection from an existing socket

  Parameters

  • socket: Socket<any>

  Returns TcpConnection