Creates, and then attempts to connect to a remote server given an address. If no connection can be made, an Error is thrown.
The host of the address to connect this TCP client to.
The host of the address to connect this TCP client to.
An optional specific IP version to use. Defaults to IPv4.
The target host of the socket.
Gets/sets the blocking nature of the Socket. True if to block, false otherwise.
When a socket is blocking, calls such as receive() and accept() will synchronously wait until there is data to return from those calls. When a socket is not set to block, they will check and immediately return undefined when there is no data from those calls.
Flag if this socket has been manually disconnected and thus destroyed. Destroyed sockets cannot be re-used. True if this socket has been destroyed and disconnected. False otherwise.
NOTE: On unexpected socket errors this may not be set correctly. This check can only ensure this socket disconnected in an expected fashion.
Flag if the socket is Internet Protocol Version 4 (IPv4).
Flag if the socket is Internet Protocol Version 6 (IPv6).
The local port the socket is bound to.
The port this socket is connected/sends to.
Disconnects this so. Once this is called the socket is considered "destroyed" and no no longer be used for any form of communication.
Attempts to Receive data from the server and return it as a Buffer.
A Buffer instance with the data read from the connected server. If set to blocking this call will synchronously block until some data is received. Otherwise if there is no data to receive, this will return undefined immediately and not block.
Sends the data to the connected server.
The data you want to send, as a string, Buffer, or Uint8Array.
Generated using TypeDoc
Represents a TCP Client connection.