diff options
Diffstat (limited to 'doc/classes/TCP_Server.xml')
| -rw-r--r-- | doc/classes/TCP_Server.xml | 18 |
1 files changed, 9 insertions, 9 deletions
diff --git a/doc/classes/TCP_Server.xml b/doc/classes/TCP_Server.xml index ac9b33bc34..432d83f25b 100644 --- a/doc/classes/TCP_Server.xml +++ b/doc/classes/TCP_Server.xml @@ -1,10 +1,10 @@ <?xml version="1.0" encoding="UTF-8" ?> <class name="TCP_Server" inherits="Reference" category="Core" version="3.2"> <brief_description> - TCP Server. + A TCP server. </brief_description> <description> - TCP Server class. Listens to connections on a port and returns a [StreamPeerTCP] when got a connection. + A TCP server. Listens to connections on a port and returns a [StreamPeerTCP] when it gets an incoming connection. </description> <tutorials> </tutorials> @@ -13,7 +13,7 @@ <return type="bool"> </return> <description> - Return [code]true[/code] if a connection is available for taking. + Returns [code]true[/code] if a connection is available for taking. </description> </method> <method name="listen"> @@ -24,24 +24,24 @@ <argument index="1" name="bind_address" type="String" default=""*""> </argument> <description> - 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). + 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> - Stop listening. + Stops listening. </description> </method> <method name="take_connection"> <return type="StreamPeerTCP"> </return> <description> - If a connection is available, return a StreamPeerTCP with the connection/ + If a connection is available, returns a StreamPeerTCP with the connection. </description> </method> </methods> |