TCP_Server

Inherits:Reference<Object

A TCP server.

Description

A TCP server. Listens to connections on a port and returns aStreamPeerTCP when it gets an incoming connection.

Methods

bool

is_connection_available()const

bool

is_listening()const

Error

listen(int port,String bind_address="*")

void

stop()

StreamPeerTCP

take_connection()

Method Descriptions

Returnstrue if a connection is available for taking.

Returnstrue if the server is currently listening for connections.

Listen on theport binding tobind_address.

Ifbind_address is set as"*" (default), the server will listen on all available addresses (both IPv4 and IPv6).

Ifbind_address is set as"0.0.0.0" (for IPv4) or"::" (for IPv6), the server will listen on all available addresses matching that IP type.

Ifbind_address is set to any valid address (e.g."192.168.1.101","::1", etc), the server will only listen on the interface with that addresses (or fail if no interface with the given address exists).

  • voidstop()

Stops listening.

If a connection is available, returns a StreamPeerTCP with the connection.