From 456e7ea6e6e23c5e0cd044c8c6f24eed4076fa6b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?R=C3=A9mi=20Verschelde?= Date: Sun, 8 Jan 2017 12:37:13 +0100 Subject: [PATCH] classref: Sync with current 2.1 branch --- classes/class_editorsettings.rst | 29 ++++++++------------- classes/class_httpclient.rst | 6 +++++ classes/class_httprequest.rst | 6 +++++ classes/class_ip.rst | 44 ++++++++++++++++++++------------ classes/class_packetpeerudp.rst | 18 ++++++------- classes/class_streampeertcp.rst | 8 +++++- classes/class_tcp_server.rst | 8 +++++- 7 files changed, 72 insertions(+), 47 deletions(-) diff --git a/classes/class_editorsettings.rst b/classes/class_editorsettings.rst index a793b2b47..7abf3d9b8 100644 --- a/classes/class_editorsettings.rst +++ b/classes/class_editorsettings.rst @@ -64,26 +64,19 @@ Member Function Description Add a custom property info to a property. The dictionary must contain: name::ref:`String`(the name of the property) and type::ref:`int`(see TYPE\_\* in :ref:`@Global Scope`), and optionally hint::ref:`int`(see PROPERTY_HINT\_\* in :ref:`@Global Scope`), hint_string::ref:`String`. Example: + :: - -editor_settings.set("category/property_name", 0) - - - -var property_info = { - - "name": "category/property_name", - - "type": TYPE_INT, - - "hint": PROPERTY_HINT_ENUM, - - "hint_string": "one,two,three" - -} - - editor_settings.add_property_info(property_info) + editor_settings.set("category/property_name", 0) + + var property_info = { + "name": "category/property_name", + "type": TYPE_INT, + "hint": PROPERTY_HINT_ENUM, + "hint_string": "one,two,three" + } + + editor_settings.add_property_info(property_info) .. _class_EditorSettings_erase: diff --git a/classes/class_httpclient.rst b/classes/class_httpclient.rst index 7b427557d..4b3037770 100644 --- a/classes/class_httpclient.rst +++ b/classes/class_httpclient.rst @@ -59,6 +59,8 @@ Member Functions +----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_connection` **(** :ref:`StreamPeer` connection **)** | +----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_ip_type` **(** :ref:`int` ip_type **)** | ++----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_read_chunk_size` **(** :ref:`int` bytes **)** | +----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -293,6 +295,10 @@ If set to true, execution will block until all data is read from the response. Set connection to use, for this client. +.. _class_HTTPClient_set_ip_type: + +- void **set_ip_type** **(** :ref:`int` ip_type **)** + .. _class_HTTPClient_set_read_chunk_size: - void **set_read_chunk_size** **(** :ref:`int` bytes **)** diff --git a/classes/class_httprequest.rst b/classes/class_httprequest.rst index e9a2a27c7..3f6dec539 100644 --- a/classes/class_httprequest.rst +++ b/classes/class_httprequest.rst @@ -41,6 +41,8 @@ Member Functions +------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_download_file` **(** :ref:`String` path **)** | +------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_ip_type` **(** :ref:`int` ip_type **)** | ++------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_max_redirects` **(** :ref:`int` amount **)** | +------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_use_threads` **(** :ref:`bool` enable **)** | @@ -147,6 +149,10 @@ Set the response body size limit. Set the file to download into. Outputs the response body into the file. +.. _class_HTTPRequest_set_ip_type: + +- void **set_ip_type** **(** :ref:`int` ip_type **)** + .. _class_HTTPRequest_set_max_redirects: - void **set_max_redirects** **(** :ref:`int` amount **)** diff --git a/classes/class_ip.rst b/classes/class_ip.rst index 02e73ea0b..3c3357b30 100644 --- a/classes/class_ip.rst +++ b/classes/class_ip.rst @@ -20,19 +20,21 @@ IP Protocol support functions. Member Functions ---------------- -+------------------------------+-------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`erase_resolve_item` **(** :ref:`int` id **)** | -+------------------------------+-------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`get_local_addresses` **(** **)** const | -+------------------------------+-------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_resolve_item_address` **(** :ref:`int` id **)** const | -+------------------------------+-------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_resolve_item_status` **(** :ref:`int` id **)** const | -+------------------------------+-------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`resolve_hostname` **(** :ref:`String` host **)** | -+------------------------------+-------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`resolve_hostname_queue_item` **(** :ref:`String` host **)** | -+------------------------------+-------------------------------------------------------------------------------------------------------------------------+ ++------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`clear_cache` **(** :ref:`String` arg0="" **)** | ++------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`erase_resolve_item` **(** :ref:`int` id **)** | ++------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`get_local_addresses` **(** **)** const | ++------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_resolve_item_address` **(** :ref:`int` id **)** const | ++------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_resolve_item_status` **(** :ref:`int` id **)** const | ++------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`resolve_hostname` **(** :ref:`String` host, :ref:`int` ip_type=3 **)** | ++------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`resolve_hostname_queue_item` **(** :ref:`String` host, :ref:`int` ip_type=3 **)** | ++------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ Numeric Constants ----------------- @@ -43,6 +45,10 @@ Numeric Constants - **RESOLVER_STATUS_ERROR** = **3** - **RESOLVER_MAX_QUERIES** = **32** - **RESOLVER_INVALID_ID** = **-1** +- **TYPE_NONE** = **0** +- **TYPE_IPV4** = **1** +- **TYPE_IPV6** = **2** +- **TYPE_ANY** = **3** Description ----------- @@ -52,6 +58,10 @@ IP contains some support functions for the IPv4 protocol. TCP/IP support is in d Member Function Description --------------------------- +.. _class_IP_clear_cache: + +- void **clear_cache** **(** :ref:`String` arg0="" **)** + .. _class_IP_erase_resolve_item: - void **erase_resolve_item** **(** :ref:`int` id **)** @@ -76,14 +86,14 @@ Return the status of hostname queued for resolving, given it's queue ID. Returne .. _class_IP_resolve_hostname: -- :ref:`String` **resolve_hostname** **(** :ref:`String` host **)** +- :ref:`String` **resolve_hostname** **(** :ref:`String` host, :ref:`int` ip_type=3 **)** -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". .. _class_IP_resolve_hostname_queue_item: -- :ref:`int` **resolve_hostname_queue_item** **(** :ref:`String` host **)** +- :ref:`int` **resolve_hostname_queue_item** **(** :ref:`String` host, :ref:`int` ip_type=3 **)** -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. diff --git a/classes/class_packetpeerudp.rst b/classes/class_packetpeerudp.rst index c2a52b360..f06f5ac06 100644 --- a/classes/class_packetpeerudp.rst +++ b/classes/class_packetpeerudp.rst @@ -21,8 +21,6 @@ Member Functions +------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`close` **(** **)** | +------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_packet_address` **(** **)** const | -+------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`get_packet_ip` **(** **)** const | +------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_packet_port` **(** **)** const | @@ -31,6 +29,8 @@ Member Functions +------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ | Error | :ref:`listen` **(** :ref:`int` port, :ref:`int` recv_buf_size=65536 **)** | +------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_ip_type` **(** :ref:`int` ip_type **)** | ++------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`set_send_address` **(** :ref:`String` host, :ref:`int` port **)** | +------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ | Error | :ref:`wait` **(** **)** | @@ -50,12 +50,6 @@ Member Function Description Close the UDP socket the :ref:`PacketPeerUDP` is currently listening on. -.. _class_PacketPeerUDP_get_packet_address: - -- :ref:`int` **get_packet_address** **(** **)** const - -Return the address of the remote peer(as a 32bit integer) that sent the last packet(that was received with :ref:`get_packet` or :ref:`get_var`). - .. _class_PacketPeerUDP_get_packet_ip: - :ref:`String` **get_packet_ip** **(** **)** const @@ -78,13 +72,17 @@ Return whether this :ref:`PacketPeerUDP` is listening. - Error **listen** **(** :ref:`int` port, :ref:`int` recv_buf_size=65536 **)** -Make this :ref:`PacketPeerUDP` listen on the "port" using a buffer size "recv_buf_size". Listens on all available adresses. +Make this :ref:`PacketPeerUDP` listen on the "port" with a buffer size "recv_buf_size". Listens on all available addresses. + +.. _class_PacketPeerUDP_set_ip_type: + +- void **set_ip_type** **(** :ref:`int` ip_type **)** .. _class_PacketPeerUDP_set_send_address: - :ref:`int` **set_send_address** **(** :ref:`String` host, :ref:`int` port **)** -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 if valid. .. _class_PacketPeerUDP_wait: diff --git a/classes/class_streampeertcp.rst b/classes/class_streampeertcp.rst index 17e06669c..a9c4ee036 100644 --- a/classes/class_streampeertcp.rst +++ b/classes/class_streampeertcp.rst @@ -31,6 +31,8 @@ Member Functions +------------------------------+------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_connected` **(** **)** const | +------------------------------+------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_ip_type` **(** :ref:`int` ip_type **)** | ++------------------------------+------------------------------------------------------------------------------------------------------------------------+ Numeric Constants ----------------- @@ -52,7 +54,7 @@ Member Function Description - :ref:`int` **connect** **(** :ref:`String` host, :ref:`int` port **)** -Connect to the specified IP:port pair. Returns :ref:`OK` on success or :ref:`FAILED` on failure. +Connect to the specified host:port pair. A hostname will be resolved if valid. Returns :ref:`OK` on success or :ref:`FAILED` on failure. .. _class_StreamPeerTCP_disconnect: @@ -84,4 +86,8 @@ Return the status of the connection, one of STATUS\_\* enum. Return whether this peer is connected. Returns true while connecting and connected. +.. _class_StreamPeerTCP_set_ip_type: + +- void **set_ip_type** **(** :ref:`int` ip_type **)** + diff --git a/classes/class_tcp_server.rst b/classes/class_tcp_server.rst index 8cc7ae506..5c91b0b35 100644 --- a/classes/class_tcp_server.rst +++ b/classes/class_tcp_server.rst @@ -23,6 +23,8 @@ Member Functions +------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`listen` **(** :ref:`int` port, :ref:`StringArray` accepted_hosts=StringArray([]) **)** | +------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_ip_type` **(** :ref:`int` ip_type **)** | ++------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`stop` **(** **)** | +------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Object` | :ref:`take_connection` **(** **)** | @@ -46,7 +48,11 @@ Return true if a connection is available for taking. - :ref:`int` **listen** **(** :ref:`int` port, :ref:`StringArray` accepted_hosts=StringArray([]) **)** -Listen on a port, alternatively give a white-list of accepted hosts. +Listen on a port using protocol, alternatively give a white-list of accepted hosts. + +.. _class_TCP_Server_set_ip_type: + +- void **set_ip_type** **(** :ref:`int` ip_type **)** .. _class_TCP_Server_stop: