diff options
| author | Fabio Alessandrelli | 2017-01-18 20:14:51 +0100 |
|---|---|---|
| committer | Fabio Alessandrelli | 2017-03-22 21:05:02 +0100 |
| commit | cab9ad76570760f170ae15026b57b2dcfe6431ff (patch) | |
| tree | 05c8e3e1255cb1a30239588bee7b61ecef7015e5 /doc/base/classes.xml | |
| parent | 9f41c0a356c016a86418a44c35ad1fb3f5978fd2 (diff) | |
| download | godot-cab9ad76570760f170ae15026b57b2dcfe6431ff.tar.gz godot-cab9ad76570760f170ae15026b57b2dcfe6431ff.tar.zst godot-cab9ad76570760f170ae15026b57b2dcfe6431ff.zip | |
Update docs reference for TCP_Server::listen and UDPPacketPeer::listen
(cherry picked from commit e5e4e7b6a9be36bb9bf75da996c348ae2476010c)
Diffstat (limited to '')
| -rw-r--r-- | doc/base/classes.xml | 16 |
1 files changed, 12 insertions, 4 deletions
diff --git a/doc/base/classes.xml b/doc/base/classes.xml index b2724811a..aad217b8e 100644 --- a/doc/base/classes.xml +++ b/doc/base/classes.xml @@ -24710,10 +24710,15 @@ </return> <argument index="0" name="port" type="int"> </argument> - <argument index="1" name="recv_buf_size" type="int" default="65536"> + <argument index="1" name="bind_address" type="String" default="*"> + </argument> + <argument index="2" name="recv_buf_size" type="int" default="65536"> </argument> <description> - Make this [PacketPeerUDP] listen on the "port" with a buffer size "recv_buf_size". Listens on all available addresses. + Make this [PacketPeerUDP] listen on the "port" binding to "bind_address" with a buffer size "recv_buf_size". + If "bind_address" is set as "*" (default), the peer 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 peer 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 peer will only listen on the interface with that addresses (or fail if no interface with the given address exists). </description> </method> <method name="set_ip_type"> @@ -39827,10 +39832,13 @@ </return> <argument index="0" name="port" type="int"> </argument> - <argument index="1" name="accepted_hosts" type="StringArray" default="StringArray([])"> + <argument index="1" name="bind_address" type="String" default="*"> </argument> <description> - Listen on a port using protocol, alternatively give a white-list of accepted hosts. + 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). </description> </method> <method name="set_ip_type"> |