diff options
| author | dam <daniel.almeida.martins@outlook.com> | 2021-03-21 10:15:30 +0000 |
|---|---|---|
| committer | Fabio Alessandrelli <fabio.alessandrelli@gmail.com> | 2021-04-12 21:05:33 +0200 |
| commit | da8c2310b5b2eae941fa1465495409086397127f (patch) | |
| tree | e010f94062e83bb88ce739a75c01a86dcce9c7b5 /doc/classes | |
| parent | cee5414698b14be3ce837b4c9de3a3d500d28611 (diff) | |
Allow local port control on net_socket connections
Diffstat (limited to 'doc/classes')
| -rw-r--r-- | doc/classes/PacketPeerUDP.xml | 7 | ||||
| -rw-r--r-- | doc/classes/StreamPeerTCP.xml | 21 | ||||
| -rw-r--r-- | doc/classes/TCP_Server.xml | 7 | ||||
| -rw-r--r-- | doc/classes/UDPServer.xml | 7 |
4 files changed, 41 insertions, 1 deletions
diff --git a/doc/classes/PacketPeerUDP.xml b/doc/classes/PacketPeerUDP.xml index d7cf6cc8c6..2ea5c8a0a4 100644 --- a/doc/classes/PacketPeerUDP.xml +++ b/doc/classes/PacketPeerUDP.xml @@ -28,6 +28,13 @@ [b]Note:[/b] Connecting to the remote peer does not help to protect from malicious attacks like IP spoofing, etc. Think about using an encryption technique like SSL or DTLS if you feel like your application is transferring sensitive information. </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_packet_ip" qualifiers="const"> <return type="String"> </return> diff --git a/doc/classes/StreamPeerTCP.xml b/doc/classes/StreamPeerTCP.xml index b6d91715ee..7b7c1d7426 100644 --- a/doc/classes/StreamPeerTCP.xml +++ b/doc/classes/StreamPeerTCP.xml @@ -9,6 +9,18 @@ <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=""*""> + </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> @@ -17,7 +29,7 @@ <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 or [constant FAILED] on failure. + 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"> @@ -41,6 +53,13 @@ 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> diff --git a/doc/classes/TCP_Server.xml b/doc/classes/TCP_Server.xml index 72e9ca923d..ec91d75d47 100644 --- a/doc/classes/TCP_Server.xml +++ b/doc/classes/TCP_Server.xml @@ -9,6 +9,13 @@ <tutorials> </tutorials> <methods> + <method name="get_local_port" qualifiers="const"> + <return type="int"> + </return> + <description> + Returns the local port this server is listening to. + </description> + </method> <method name="is_connection_available" qualifiers="const"> <return type="bool"> </return> diff --git a/doc/classes/UDPServer.xml b/doc/classes/UDPServer.xml index 0fc00f67f8..931aa71332 100644 --- a/doc/classes/UDPServer.xml +++ b/doc/classes/UDPServer.xml @@ -123,6 +123,13 @@ <tutorials> </tutorials> <methods> + <method name="get_local_port" qualifiers="const"> + <return type="int"> + </return> + <description> + Returns the local port this server is listening to. + </description> + </method> <method name="is_connection_available" qualifiers="const"> <return type="bool"> </return> |