Inherits: Reference < Object

Category: Core

Brief Description

TCP Server.

Member Functions

bool is_connection_available ( ) const
int listen ( int port, String bind_address=”*” )
void stop ( )
Object take_connection ( )


TCP Server class. Listens to connections on a port and returns a StreamPeerTCP when got a connection.

Member Function Description

  • bool is_connection_available ( ) const

Return true if a connection is available for taking.

Listen on the “port” binding to “bind_address”.

If “bind_address” is set as “*” (default), the server will listen on all available addresses (both IPv4 and IPv6).

If “bind_address” is set as “” (for IPv4) or “::” (for IPv6), the server will listen on all available addresses matching that IP type.

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

  • void stop ( )

Stop listening.

If a connection is available, return a StreamPeerTCP with the connection/