summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorFabio Alessandrelli <fabio.alessandrelli@gmail.com>2022-03-27 15:30:17 +0200
committerFabio Alessandrelli <fabio.alessandrelli@gmail.com>2022-03-27 16:36:44 +0200
commit0e528676683a0df96751fd0daa018e0818baa0e2 (patch)
treea8e9e3707ea37a6431a6aac90b7c91a31ee8b567 /doc
parenta5eed70fa2edcf755d6abea2077232e38381449b (diff)
[Net] Make StreamPeerTCP::_poll_connection explicit.
No longer hacked into `get_status` and renamed to `poll`. The old `poll` (for *nix `poll`, win `select`) is now called `wait`.
Diffstat (limited to 'doc')
-rw-r--r--doc/classes/StreamPeerTCP.xml8
1 files changed, 7 insertions, 1 deletions
diff --git a/doc/classes/StreamPeerTCP.xml b/doc/classes/StreamPeerTCP.xml
index a1f1f1be79..033982ea40 100644
--- a/doc/classes/StreamPeerTCP.xml
+++ b/doc/classes/StreamPeerTCP.xml
@@ -51,7 +51,7 @@
Returns the local port to which this peer is bound.
</description>
</method>
- <method name="get_status">
+ <method name="get_status" qualifiers="const">
<return type="int" enum="StreamPeerTCP.Status" />
<description>
Returns the status of the connection, see [enum Status].
@@ -63,6 +63,12 @@
Returns [code]true[/code] if this peer is currently connected or is connecting to a host, [code]false[/code] otherwise.
</description>
</method>
+ <method name="poll">
+ <return type="int" enum="Error" />
+ <description>
+ Poll the socket, updating its state. See [method get_status].
+ </description>
+ </method>
<method name="set_no_delay">
<return type="void" />
<argument index="0" name="enabled" type="bool" />