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: 2be4e9b938
Branches Tags
godot-docs
/
classes
/
class_streampeertcp.rst

class_streampeertcp.rst 8.2 KB
History Raw

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152 
  1. :github_url: hide
    2. 

  2. 

  3. .. DO NOT EDIT THIS FILE!!!
    4. 

  4. .. Generated automatically from Godot engine sources.
    5. 

  5. .. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py.
    6. 

  6. .. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/StreamPeerTCP.xml.
    7. 

  7. 

  8. .. _class_StreamPeerTCP:
    9. 

  9. 

  10. StreamPeerTCP
    11. 

  11. =============
    12. 

  12. 

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

  14. 

  15. TCP stream peer.
    16. 

  16. 

  17. Description
    18. 

  18. -----------
    19. 

  19. 

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

  21. 

  22. \ **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.
    23. 

  23. 

  24. Methods
    25. 

  25. -------
    26. 

  26. 

  27. +------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
    28. 

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

  29. +------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
    30. 

  30. | :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 **)** |
    31. 

  31. +------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
    32. 

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

  33. +------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
    34. 

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

  35. +------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
    36. 

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

  37. +------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
    38. 

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

  39. +------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
    40. 

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

  41. +------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
    42. 

  42. | :ref:`Error<enum_@GlobalScope_Error>`    | :ref:`poll<class_StreamPeerTCP_method_poll>` **(** **)**                                                                                    |
    43. 

  43. +------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
    44. 

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

  45. +------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
    46. 

  46. 

  47. Enumerations
    48. 

  48. ------------
    49. 

  49. 

  50. .. _enum_StreamPeerTCP_Status:
    51. 

  51. 

  52. .. _class_StreamPeerTCP_constant_STATUS_NONE:
    53. 

  53. 

  54. .. _class_StreamPeerTCP_constant_STATUS_CONNECTING:
    55. 

  55. 

  56. .. _class_StreamPeerTCP_constant_STATUS_CONNECTED:
    57. 

  57. 

  58. .. _class_StreamPeerTCP_constant_STATUS_ERROR:
    59. 

  59. 

  60. enum **Status**:
    61. 

  61. 

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

  63. 

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

  65. 

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

  67. 

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

  69. 

  70. Method Descriptions
    71. 

  71. -------------------
    72. 

  72. 

  73. .. _class_StreamPeerTCP_method_bind:
    74. 

  74. 

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

  76. 

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

  78. 

  79. 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.
    80. 

  80. 

  81. ----
    82. 

  82. 

  83. .. _class_StreamPeerTCP_method_connect_to_host:
    84. 

  84. 

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

  86. 

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

  88. 

  89. ----
    90. 

  90. 

  91. .. _class_StreamPeerTCP_method_disconnect_from_host:
    92. 

  92. 

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

  94. 

  95. Disconnects from host.
    96. 

  96. 

  97. ----
    98. 

  98. 

  99. .. _class_StreamPeerTCP_method_get_connected_host:
    100. 

  100. 

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

  102. 

  103. Returns the IP of this peer.
    104. 

  104. 

  105. ----
    106. 

  106. 

  107. .. _class_StreamPeerTCP_method_get_connected_port:
    108. 

  108. 

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

  110. 

  111. Returns the port of this peer.
    112. 

  112. 

  113. ----
    114. 

  114. 

  115. .. _class_StreamPeerTCP_method_get_local_port:
    116. 

  116. 

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

  118. 

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

  120. 

  121. ----
    122. 

  122. 

  123. .. _class_StreamPeerTCP_method_get_status:
    124. 

  124. 

  125. - :ref:`Status<enum_StreamPeerTCP_Status>` **get_status** **(** **)** |const|
    126. 

  126. 

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

  128. 

  129. ----
    130. 

  130. 

  131. .. _class_StreamPeerTCP_method_poll:
    132. 

  132. 

  133. - :ref:`Error<enum_@GlobalScope_Error>` **poll** **(** **)**
    134. 

  134. 

  135. Poll the socket, updating its state. See :ref:`get_status<class_StreamPeerTCP_method_get_status>`.
    136. 

  136. 

  137. ----
    138. 

  138. 

  139. .. _class_StreamPeerTCP_method_set_no_delay:
    140. 

  140. 

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

  142. 

  143. 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>`__.
    144. 

  144. 

  145. \ **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.
    146. 

  146. 

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

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

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

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

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

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