Up to date

This page is up to date for Godot 4.2. If you still find outdated information, please open an issue.

TCPServer

Inherits: RefCounted < Object

A TCP server.

Description

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

Note: When exporting to Android, make sure to enable the INTERNET permission in the Android export preset before exporting the project or using one-click deploy. Otherwise, network communication of any kind will be blocked by Android.

Methods

int

get_local_port ( ) const

bool

is_connection_available ( ) const

bool

is_listening ( ) const

Error

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

void

stop ( )

StreamPeerTCP

take_connection ( )


Method Descriptions

int get_local_port ( ) const

Returns the local port this server is listening to.


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.


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

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 "0.0.0.0" (for IPv4) or &q