virtualx-engine/doc/classes/StreamPeerTCP.xml

<?xml version="1.0" encoding="UTF-8" ?>
<class name="StreamPeerTCP" inherits="StreamPeer" version="4.0">
	<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="bind">
			<return type="int" enum="Error">
			</return>
			<argument index="0" name="port" type="int">
			</argument>
			<argument index="1" name="host" type="String" default="&quot;*&quot;">
			</argument>
			<description>
				Opens the TCP socket, and binds it to the specified local address.
				This method is generally not needed, and only used to force the subsequent call to [method connect_to_host] to use the specified [code]host[/code] and [code]port[/code] as source address. This can be desired in some NAT punchthrough techniques, or when forcing the source network interface.
			</description>
		</method>
		<method name="connect_to_host">
			<return type="int" enum="Error">
			</return>
			<argument index="0" name="host" type="String">
			</argument>
			<argument index="1" name="port" type="int">
			</argument>
			<description>
				Connects to the specified [code]host:port[/code] pair. A hostname will be resolved if valid. Returns [constant OK] on success.
			</description>
		</method>
		<method name="disconnect_from_host">
			<return type="void">
			</return>
			<description>
				Disconnects from host.
			</description>
		</method>
		<method name="get_connected_host" qualifiers="const">
			<return type="String">
			</return>
			<description>
				Returns the IP of this peer.
			</description>
		</method>
		<method name="get_connected_port" qualifiers="const">
			<return type="int">
			</return>
			<description>
				Returns the port of this peer.
			</description>
		</method>
		<method name="get_local_port" qualifiers="const">
			<return type="int">
			</return>
			<description>
				Returns the local port to which this peer is bound.
			</description>
		</method>
		<method name="get_status">
			<return type="int" enum="StreamPeerTCP.Status">
			</return>
			<description>
				Returns the status of the connection, see [enum Status].
			</description>
		</method>
		<method name="is_connected_to_host" qualifiers="const">
			<return type="bool">
			</return>
			<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">
			</return>
			<argument index="0" name="enabled" type="bool">
			</argument>
			<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>