Options
All
  • Public
  • Public/Protected
  • All
Menu

Class SocketServerTCP

Represents a TCP Server connection.

Hierarchy

Index

Constructors

constructor

  • new SocketServerTCP(portFrom: number, hostFrom?: undefined | string, ipVersion?: "IPv4" | "IPv6"): SocketServerTCP
  • Creates a TCP Server listening on a given port (an optional host) for new TCP Client connections.

    Parameters

    • portFrom: number

      The local port the socket will be bound to.

    • Optional hostFrom: undefined | string

      The local address to be bound to (example: "localhost" or "127.0.0.1"). Empty/undefined (by default) or "*" means all variable addresses.

    • Optional ipVersion: "IPv4" | "IPv6"

      The IP version to be used. IPv4 by default.

    Returns SocketServerTCP

Properties

Readonly hostFrom

hostFrom: string

Gets the socket local address. Empty string means any bound host.

isBlocking

isBlocking: boolean

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.

Readonly isDestroyed

isDestroyed: boolean

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.

Readonly isIPv4

isIPv4: boolean

Flag if the socket is Internet Protocol Version 4 (IPv4).

Readonly isIPv6

isIPv6: boolean

Flag if the socket is Internet Protocol Version 6 (IPv6).

Readonly portFrom

portFrom: number

The local port the socket is bound to.

Methods

accept

  • Listens for a new client connection, and accepts them, returning a new SocketClientTCP instance as an interface to send and receive data from their connection.

    Returns SocketClientTCP | undefined

    When a new connection can be accepted, a new SocketClientTCP instance. If set to blocking this call will synchronously block until a connect is made to accept and return. Otherwise when not blocking and there is no connection to accept, undefined is returned.

disconnect

  • disconnect(): void
  • Disconnects this so. Once this is called the socket is considered "destroyed" and no no longer be used for any form of communication.

    Returns void

Generated using TypeDoc