Skip to content

Latest commit

 

History

History
82 lines (49 loc) · 3.86 KB

class_tcp_server.rst

File metadata and controls

82 lines (49 loc) · 3.86 KB
github_url:hide

TCP_Server

Inherits: :ref:`Reference<class_Reference>` < :ref:`Object<class_Object>`

A TCP server.

Description

A TCP server. Listens to connections on a port and returns a :ref:`StreamPeerTCP<class_StreamPeerTCP>` when it gets an incoming connection.

Methods

:ref:`bool<class_bool>` :ref:`is_connection_available<class_TCP_Server_method_is_connection_available>` ( ) const
:ref:`bool<class_bool>` :ref:`is_listening<class_TCP_Server_method_is_listening>` ( ) const
:ref:`Error<enum_@GlobalScope_Error>` :ref:`listen<class_TCP_Server_method_listen>` ( :ref:`int<class_int>` port, :ref:`String<class_String>` bind_address="*" )
void :ref:`stop<class_TCP_Server_method_stop>` ( )
:ref:`StreamPeerTCP<class_StreamPeerTCP>` :ref:`take_connection<class_TCP_Server_method_take_connection>` ( )

Method Descriptions

Returns true if a connection is available for taking.

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 "0.0.0.0" (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. "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).

  • void stop ( )

Stops listening.

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