diff options
| author | Fabio Alessandrelli <fabio.alessandrelli@gmail.com> | 2016-10-29 03:53:24 +0200 |
|---|---|---|
| committer | Fabio Alessandrelli <fabio.alessandrelli@gmail.com> | 2016-10-30 17:46:05 +0100 |
| commit | 7f42da03300d515c3fb991ba311783619ac90ea2 (patch) | |
| tree | 91c77b80282ee5a937d3c226a8b0b9db0f040e00 /doc/base/classes.xml | |
| parent | 7eef15b73460062e4558857969919313e461f1e4 (diff) | |
Update docs to IPv6
Diffstat (limited to 'doc/base/classes.xml')
| -rw-r--r-- | doc/base/classes.xml | 34 |
1 files changed, 26 insertions, 8 deletions
diff --git a/doc/base/classes.xml b/doc/base/classes.xml index 977b44763e..92b208ff50 100644 --- a/doc/base/classes.xml +++ b/doc/base/classes.xml @@ -16068,8 +16068,10 @@ </return> <argument index="0" name="host" type="String"> </argument> + <argument index="1" name="ip_type" type="int" default="int.IP_TYPE_ANY"> + </argument> <description> - Resolve a given hostname, blocking. Resolved hostname is returned as an IP. + Resolve a given hostname, blocking. Resolved hostname is returned as an IPv4 or IPv6 depending on "ip_type". </description> </method> <method name="resolve_hostname_queue_item"> @@ -16077,8 +16079,10 @@ </return> <argument index="0" name="host" type="String"> </argument> + <argument index="1" name="ip_type" type="int" default="int.IP_TYPE_ANY"> + </argument> <description> - Create a queue item for resolving a given hostname. The queue ID is returned, or RESOLVER_INVALID_ID on error. + Create a queue item for resolving a given hostname to an IPv4 or IPv6 depending on "ip_type". The queue ID is returned, or RESOLVER_INVALID_ID on error. </description> </method> </methods> @@ -25357,10 +25361,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="ip_type" type="int" default="int.IP_TYPE_ANY"> + </argument> + <argument index="2" name="recv_buf_size" type="int" default="65536"> </argument> <description> - Make this [PacketPeerUDP] listen on the "port" using a buffer size "recv_buf_size". Listens on all available adresses. + Make this [PacketPeerUDP] listen on the "port" using protocol "ip_type" and a buffer size "recv_buf_size". Listens on all available adresses. + IP_TYPE_IPV4 = IPv4 only + IP_TYPE_IPV6 = IPv6 only + IP_TYPE_ANY = Dual stack (supports both IPv6 and IPv4 connections). </description> </method> <method name="set_send_address"> @@ -25370,8 +25379,10 @@ </argument> <argument index="1" name="port" type="int"> </argument> + <argument index="2" name="ip_type" type="int" default="int.IP_TYPE_ANY"> + </argument> <description> - Set the destination address and port for sending packets and variables, a hostname will be resolved if valid. + Set the destination address and port for sending packets and variables, a hostname will be resolved using "ip_type" (v4/v6/any) if valid. </description> </method> <method name="wait"> @@ -39181,8 +39192,10 @@ </argument> <argument index="1" name="port" type="int"> </argument> + <argument index="2" name="ip_type" type="int" default="int.IP_TYPE_ANY"> + </argument> <description> - Connect to the specified IP:port pair. Returns [OK] on success or [FAILED] on failure. + Connect to the specified host:port pair. A hostname will be resolved using "ip_type" (v4/v6/any) if valid. Returns [OK] on success or [FAILED] on failure. </description> </method> <method name="disconnect"> @@ -40505,10 +40518,15 @@ </return> <argument index="0" name="port" type="int"> </argument> - <argument index="1" name="accepted_hosts" type="StringArray" default="StringArray([])"> + <argument index="1" name="ip_type" type="int" default="int.IP_TYPE_ANY"> + </argument> + <argument index="2" name="accepted_hosts" type="StringArray" default="StringArray([])"> </argument> <description> - Listen on a port, alternatively give a white-list of accepted hosts. + Listen on a port using protocol "ip_type", alternatively give a white-list of accepted hosts. + IP_TYPE_IPV4 = IPv4 only + IP_TYPE_IPV6 = IPv6 only + IP_TYPE_ANY = Dual stack (supports both IPv6 and IPv4 connections). </description> </method> <method name="stop"> |