Inherits: Reference < Object

A TCP server.


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


boolis_connection_available ( ) const
boolis_listening ( ) const
Errorlisten ( int port, String bind_address=”*” )
voidstop ( )
StreamPeerTCPtake_connection ( )

Method Descriptions

  • bool is_connection_available ( ) const

Returns true if a connection is available for taking.

  • bool is_listening ( ) const

Returns true if the server is currently listening for connections.

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 ( )

Stops listening.

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

Doc ID missing

Disclaimer: This page has been automaticaly and directly extracted from the official Godot Docs website, the 1970-01-01 at 00:00:00. It’s the English Stable version because it’s what most Godot users should use. The Copyright owners are Juan Linietsky, Ariel Manzur and the Godot community. CC-BY 3.0. Thanks for your patience and generosity.