mirror of
https://github.com/Relintai/pandemonium_engine.git
synced 2024-12-24 12:47:12 +01:00
74 lines
2.8 KiB
XML
74 lines
2.8 KiB
XML
|
<?xml version="1.0" encoding="UTF-8" ?>
|
||
|
|
<class name="StreamPeerTCP" inherits="StreamPeer" version="3.5">
|
||
|
|
<brief_description>
|
||
|
|
TCP stream peer.
|
||
|
|
</brief_description>
|
||
|
|
<description>
|
||
|
|
TCP stream peer. This object can be used to connect to TCP servers, or also is returned by a TCP server.
|
||
|
|
</description>
|
||
|
|
<tutorials>
|
||
|
|
</tutorials>
|
||
|
|
<methods>
|
||
|
|
<method name="connect_to_host">
|
||
|
|
<return type="int" enum="Error" />
|
||
|
|
<argument index="0" name="host" type="String" />
|
||
|
|
<argument index="1" name="port" type="int" />
|
||
|
|
<description>
|
||
|
|
Connects to the specified [code]host:port[/code] pair. A hostname will be resolved if valid. Returns [constant OK] on success or [constant FAILED] on failure.
|
||
|
|
</description>
|
||
|
|
</method>
|
||
|
|
<method name="disconnect_from_host">
|
||
|
|
<return type="void" />
|
||
|
|
<description>
|
||
|
|
Disconnects from host.
|
||
|
|
</description>
|
||
|
|
</method>
|
||
|
|
<method name="get_connected_host" qualifiers="const">
|
||
|
|
<return type="String" />
|
||
|
|
<description>
|
||
|
|
Returns the IP of this peer.
|
||
|
|
</description>
|
||
|
|
</method>
|
||
|
|
<method name="get_connected_port" qualifiers="const">
|
||
|
|
<return type="int" />
|
||
|
|
<description>
|
||
|
|
Returns the port of this peer.
|
||
|
|
</description>
|
||
|
|
</method>
|
||
|
|
<method name="get_status">
|
||
|
|
<return type="int" enum="StreamPeerTCP.Status" />
|
||
|
|
<description>
|
||
|
|
Returns the status of the connection, see [enum Status].
|
||
|
|
</description>
|
||
|
|
</method>
|
||
|
|
<method name="is_connected_to_host" qualifiers="const">
|
||
|
|
<return type="bool" />
|
||
|
|
<description>
|
||
|
|
Returns [code]true[/code] if this peer is currently connected or is connecting to a host, [code]false[/code] otherwise.
|
||
|
|
</description>
|
||
|
|
</method>
|
||
|
|
<method name="set_no_delay">
|
||
|
|
<return type="void" />
|
||
|
|
<argument index="0" name="enabled" type="bool" />
|
||
|
|
<description>
|
||
|
|
If [code]enabled[/code] is [code]true[/code], packets will be sent immediately. If [code]enabled[/code] is [code]false[/code] (the default), packet transfers will be delayed and combined using [url=https://en.wikipedia.org/wiki/Nagle%27s_algorithm]Nagle's algorithm[/url].
|
||
|
|
[b]Note:[/b] It's recommended to leave this disabled for applications that send large packets or need to transfer a lot of data, as enabling this can decrease the total available bandwidth.
|
||
|
|
</description>
|
||
|
|
</method>
|
||
|
|
</methods>
|
||
|
|
<constants>
|
||
|
|
<constant name="STATUS_NONE" value="0" enum="Status">
|
||
|
|
The initial status of the [StreamPeerTCP]. This is also the status after disconnecting.
|
||
|
|
</constant>
|
||
|
|
<constant name="STATUS_CONNECTING" value="1" enum="Status">
|
||
|
|
A status representing a [StreamPeerTCP] that is connecting to a host.
|
||
|
|
</constant>
|
||
|
|
<constant name="STATUS_CONNECTED" value="2" enum="Status">
|
||
|
|
A status representing a [StreamPeerTCP] that is connected to a host.
|
||
|
|
</constant>
|
||
|
|
<constant name="STATUS_ERROR" value="3" enum="Status">
|
||
|
|
A status representing a [StreamPeerTCP] in error state.
|
||
|
|
</constant>
|
||
|
|
</constants>
|
||
|
|
</class>
|