From e5e4e7b6a9be36bb9bf75da996c348ae2476010c Mon Sep 17 00:00:00 2001
From: Fabio Alessandrelli
Date: Wed, 18 Jan 2017 20:14:51 +0100
Subject: Update docs reference for TCP_Server::listen and
 UDPPacketPeer::listen

---
 doc/base/classes.xml | 16 ++++++++++++----
 1 file changed, 12 insertions(+), 4 deletions(-)

(limited to 'doc/base')

diff --git a/doc/base/classes.xml b/doc/base/classes.xml
index 0b8c5cc11..f9a10b13d 100644
--- a/doc/base/classes.xml
+++ b/doc/base/classes.xml
@@ -25394,10 +25394,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_send_address">
@@ -40576,10 +40581,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="stop">
-- 
cgit v1.2.3-70-g09d2