Home Explore Help
Sign In
Godot
/
godot-docs
mirror of https://github.com/godotengine/godot-docs.git
2
0
Fork 0
Files Issues 0 Wiki
Tree: 75b51ec2f4
Branches Tags
godot-docs
/
classes
/
class_streampeertcp.rst

class_streampeertcp.rst 8.1 KB
History Raw

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151 
  1. :github_url: hide
    2. 

  2. 

  3. .. Generated automatically by doc/tools/make_rst.py in Godot's source tree.
    4. 

  4. .. DO NOT EDIT THIS FILE, but the StreamPeerTCP.xml source instead.
    5. 

  5. .. The source is found in doc/classes or modules/<name>/doc_classes.
    6. 

  6. 

  7. .. _class_StreamPeerTCP:
    8. 

  8. 

  9. StreamPeerTCP
    10. 

  10. =============
    11. 

  11. 

  12. **Inherits:** :ref:`StreamPeer<class_StreamPeer>` **<** :ref:`RefCounted<class_RefCounted>` **<** :ref:`Object<class_Object>`
    13. 

  13. 

  14. TCP stream peer.
    15. 

  15. 

  16. Description
    17. 

  17. -----------
    18. 

  18. 

  19. TCP stream peer. This object can be used to connect to TCP servers, or also is returned by a TCP server.
    20. 

  20. 

  21. \ **Note:** When exporting to Android, make sure to enable the ``INTERNET`` permission in the Android export preset before exporting the project or using one-click deploy. Otherwise, network communication of any kind will be blocked by Android.
    22. 

  22. 

  23. Methods
    24. 

  24. -------
    25. 

  25. 

  26. +------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
    27. 

  27. | :ref:`Error<enum_@GlobalScope_Error>`    | :ref:`bind<class_StreamPeerTCP_method_bind>` **(** :ref:`int<class_int>` port, :ref:`String<class_String>` host="*" **)**                   |
    28. 

  28. +------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
    29. 

  29. | :ref:`Error<enum_@GlobalScope_Error>`    | :ref:`connect_to_host<class_StreamPeerTCP_method_connect_to_host>` **(** :ref:`String<class_String>` host, :ref:`int<class_int>` port **)** |
    30. 

  30. +------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
    31. 

  31. | void                                     | :ref:`disconnect_from_host<class_StreamPeerTCP_method_disconnect_from_host>` **(** **)**                                                    |
    32. 

  32. +------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
    33. 

  33. | :ref:`String<class_String>`              | :ref:`get_connected_host<class_StreamPeerTCP_method_get_connected_host>` **(** **)** |const|                                                |
    34. 

  34. +------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
    35. 

  35. | :ref:`int<class_int>`                    | :ref:`get_connected_port<class_StreamPeerTCP_method_get_connected_port>` **(** **)** |const|                                                |
    36. 

  36. +------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
    37. 

  37. | :ref:`int<class_int>`                    | :ref:`get_local_port<class_StreamPeerTCP_method_get_local_port>` **(** **)** |const|                                                        |
    38. 

  38. +------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
    39. 

  39. | :ref:`Status<enum_StreamPeerTCP_Status>` | :ref:`get_status<class_StreamPeerTCP_method_get_status>` **(** **)**                                                                        |
    40. 

  40. +------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
    41. 

  41. | :ref:`bool<class_bool>`                  | :ref:`is_connected_to_host<class_StreamPeerTCP_method_is_connected_to_host>` **(** **)** |const|                                            |
    42. 

  42. +------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
    43. 

  43. | void                                     | :ref:`set_no_delay<class_StreamPeerTCP_method_set_no_delay>` **(** :ref:`bool<class_bool>` enabled **)**                                    |
    44. 

  44. +------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
    45. 

  45. 

  46. Enumerations
    47. 

  47. ------------
    48. 

  48. 

  49. .. _enum_StreamPeerTCP_Status:
    50. 

  50. 

  51. .. _class_StreamPeerTCP_constant_STATUS_NONE:
    52. 

  52. 

  53. .. _class_StreamPeerTCP_constant_STATUS_CONNECTING:
    54. 

  54. 

  55. .. _class_StreamPeerTCP_constant_STATUS_CONNECTED:
    56. 

  56. 

  57. .. _class_StreamPeerTCP_constant_STATUS_ERROR:
    58. 

  58. 

  59. enum **Status**:
    60. 

  60. 

  61. - **STATUS_NONE** = **0** --- The initial status of the ``StreamPeerTCP``. This is also the status after disconnecting.
    62. 

  62. 

  63. - **STATUS_CONNECTING** = **1** --- A status representing a ``StreamPeerTCP`` that is connecting to a host.
    64. 

  64. 

  65. - **STATUS_CONNECTED** = **2** --- A status representing a ``StreamPeerTCP`` that is connected to a host.
    66. 

  66. 

  67. - **STATUS_ERROR** = **3** --- A status representing a ``StreamPeerTCP`` in error state.
    68. 

  68. 

  69. Method Descriptions
    70. 

  70. -------------------
    71. 

  71. 

  72. .. _class_StreamPeerTCP_method_bind:
    73. 

  73. 

  74. - :ref:`Error<enum_@GlobalScope_Error>` **bind** **(** :ref:`int<class_int>` port, :ref:`String<class_String>` host="*" **)**
    75. 

  75. 

  76. Opens the TCP socket, and binds it to the specified local address.
    77. 

  77. 

  78. This method is generally not needed, and only used to force the subsequent call to :ref:`connect_to_host<class_StreamPeerTCP_method_connect_to_host>` to use the specified ``host`` and ``port`` as source address. This can be desired in some NAT punchthrough techniques, or when forcing the source network interface.
    79. 

  79. 

  80. ----
    81. 

  81. 

  82. .. _class_StreamPeerTCP_method_connect_to_host:
    83. 

  83. 

  84. - :ref:`Error<enum_@GlobalScope_Error>` **connect_to_host** **(** :ref:`String<class_String>` host, :ref:`int<class_int>` port **)**
    85. 

  85. 

  86. Connects to the specified ``host:port`` pair. A hostname will be resolved if valid. Returns :ref:`@GlobalScope.OK<class_@GlobalScope_constant_OK>` on success.
    87. 

  87. 

  88. ----
    89. 

  89. 

  90. .. _class_StreamPeerTCP_method_disconnect_from_host:
    91. 

  91. 

  92. - void **disconnect_from_host** **(** **)**
    93. 

  93. 

  94. Disconnects from host.
    95. 

  95. 

  96. ----
    97. 

  97. 

  98. .. _class_StreamPeerTCP_method_get_connected_host:
    99. 

  99. 

  100. - :ref:`String<class_String>` **get_connected_host** **(** **)** |const|
    101. 

  101. 

  102. Returns the IP of this peer.
    103. 

  103. 

  104. ----
    105. 

  105. 

  106. .. _class_StreamPeerTCP_method_get_connected_port:
    107. 

  107. 

  108. - :ref:`int<class_int>` **get_connected_port** **(** **)** |const|
    109. 

  109. 

  110. Returns the port of this peer.
    111. 

  111. 

  112. ----
    113. 

  113. 

  114. .. _class_StreamPeerTCP_method_get_local_port:
    115. 

  115. 

  116. - :ref:`int<class_int>` **get_local_port** **(** **)** |const|
    117. 

  117. 

  118. Returns the local port to which this peer is bound.
    119. 

  119. 

  120. ----
    121. 

  121. 

  122. .. _class_StreamPeerTCP_method_get_status:
    123. 

  123. 

  124. - :ref:`Status<enum_StreamPeerTCP_Status>` **get_status** **(** **)**
    125. 

  125. 

  126. Returns the status of the connection, see :ref:`Status<enum_StreamPeerTCP_Status>`.
    127. 

  127. 

  128. ----
    129. 

  129. 

  130. .. _class_StreamPeerTCP_method_is_connected_to_host:
    131. 

  131. 

  132. - :ref:`bool<class_bool>` **is_connected_to_host** **(** **)** |const|
    133. 

  133. 

  134. Returns ``true`` if this peer is currently connected or is connecting to a host, ``false`` otherwise.
    135. 

  135. 

  136. ----
    137. 

  137. 

  138. .. _class_StreamPeerTCP_method_set_no_delay:
    139. 

  139. 

  140. - void **set_no_delay** **(** :ref:`bool<class_bool>` enabled **)**
    141. 

  141. 

  142. If ``enabled`` is ``true``, packets will be sent immediately. If ``enabled`` is ``false`` (the default), packet transfers will be delayed and combined using `Nagle's algorithm <https://en.wikipedia.org/wiki/Nagle%27s_algorithm>`__.
    143. 

  143. 

  144. \ **Note:** 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.
    145. 

  145. 

  146. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
    147. 

  147. .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
    148. 

  148. .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
    149. 

  149. .. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)`
    150. 

  150. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
    151. 

  151. .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`
    152.