diff options
Diffstat (limited to 'doc/classes/TCPServer.xml')
| -rw-r--r-- | doc/classes/TCPServer.xml | 64 |
1 files changed, 64 insertions, 0 deletions
diff --git a/doc/classes/TCPServer.xml b/doc/classes/TCPServer.xml new file mode 100644 index 0000000000..28f06ad3ae --- /dev/null +++ b/doc/classes/TCPServer.xml @@ -0,0 +1,64 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="TCPServer" inherits="Reference" version="4.0"> + <brief_description> + A TCP server. + </brief_description> + <description> + A TCP server. Listens to connections on a port and returns a [StreamPeerTCP] when it gets an incoming connection. + </description> + <tutorials> + </tutorials> + <methods> + <method name="get_local_port" qualifiers="const"> + <return type="int"> + </return> + <description> + Returns the local port this server is listening to. + </description> + </method> + <method name="is_connection_available" qualifiers="const"> + <return type="bool"> + </return> + <description> + Returns [code]true[/code] if a connection is available for taking. + </description> + </method> + <method name="is_listening" qualifiers="const"> + <return type="bool"> + </return> + <description> + Returns [code]true[/code] if the server is currently listening for connections. + </description> + </method> + <method name="listen"> + <return type="int" enum="Error"> + </return> + <argument index="0" name="port" type="int"> + </argument> + <argument index="1" name="bind_address" type="String" default=""*""> + </argument> + <description> + Listen on the [code]port[/code] binding to [code]bind_address[/code]. + If [code]bind_address[/code] is set as [code]"*"[/code] (default), the server will listen on all available addresses (both IPv4 and IPv6). + If [code]bind_address[/code] is set as [code]"0.0.0.0"[/code] (for IPv4) or [code]"::"[/code] (for IPv6), the server will listen on all available addresses matching that IP type. + If [code]bind_address[/code] is set to any valid address (e.g. [code]"192.168.1.101"[/code], [code]"::1"[/code], etc), the server will only listen on the interface with that addresses (or fail if no interface with the given address exists). + </description> + </method> + <method name="stop"> + <return type="void"> + </return> + <description> + Stops listening. + </description> + </method> + <method name="take_connection"> + <return type="StreamPeerTCP"> + </return> + <description> + If a connection is available, returns a StreamPeerTCP with the connection. + </description> + </method> + </methods> + <constants> + </constants> +</class> |