Etusivu Tutki Apua
Kirjaudu sisään
godotengine
/
godot-docs
peilaus alkaen https://github.com/godotengine/godot-docs
Tarkkaile 1
Äänestä 1
Fork 0
Tiedostot
Puu: 7a86ac6a30
Branchit Tagit
godot-docs
/
classes
/
class_tcp_server.rst

class_tcp_server.rst 4.2 KB
Historia Raaka

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586 
  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 TCP_Server.xml source instead.
    5. 

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

  6. 

  7. .. _class_TCP_Server:
    8. 

  8. 

  9. TCP_Server
    10. 

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

  11. 

  12. **Inherits:** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`
    13. 

  13. 

  14. A TCP server.
    15. 

  15. 

  16. Description
    17. 

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

  18. 

  19. A TCP server. Listens to connections on a port and returns a :ref:`StreamPeerTCP<class_StreamPeerTCP>` when it gets an incoming connection.
    20. 

  20. 

  21. Methods
    22. 

  22. -------
    23. 

  23. 

  24. +-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+
    25. 

  25. | :ref:`bool<class_bool>`                   | :ref:`is_connection_available<class_TCP_Server_method_is_connection_available>` **(** **)** |const|                                |
    26. 

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

  27. | :ref:`bool<class_bool>`                   | :ref:`is_listening<class_TCP_Server_method_is_listening>` **(** **)** |const|                                                      |
    28. 

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

  29. | :ref:`Error<enum_@GlobalScope_Error>`     | :ref:`listen<class_TCP_Server_method_listen>` **(** :ref:`int<class_int>` port, :ref:`String<class_String>` bind_address="*" **)** |
    30. 

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

  31. | void                                      | :ref:`stop<class_TCP_Server_method_stop>` **(** **)**                                                                              |
    32. 

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

  33. | :ref:`StreamPeerTCP<class_StreamPeerTCP>` | :ref:`take_connection<class_TCP_Server_method_take_connection>` **(** **)**                                                        |
    34. 

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

  35. 

  36. Method Descriptions
    37. 

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

  38. 

  39. .. _class_TCP_Server_method_is_connection_available:
    40. 

  40. 

  41. - :ref:`bool<class_bool>` **is_connection_available** **(** **)** |const|
    42. 

  42. 

  43. Returns ``true`` if a connection is available for taking.
    44. 

  44. 

  45. ----
    46. 

  46. 

  47. .. _class_TCP_Server_method_is_listening:
    48. 

  48. 

  49. - :ref:`bool<class_bool>` **is_listening** **(** **)** |const|
    50. 

  50. 

  51. Returns ``true`` if the server is currently listening for connections.
    52. 

  52. 

  53. ----
    54. 

  54. 

  55. .. _class_TCP_Server_method_listen:
    56. 

  56. 

  57. - :ref:`Error<enum_@GlobalScope_Error>` **listen** **(** :ref:`int<class_int>` port, :ref:`String<class_String>` bind_address="*" **)**
    58. 

  58. 

  59. Listen on the ``port`` binding to ``bind_address``.
    60. 

  60. 

  61. If ``bind_address`` is set as ``"*"`` (default), the server will listen on all available addresses (both IPv4 and IPv6).
    62. 

  62. 

  63. If ``bind_address`` is set as ``"0.0.0.0"`` (for IPv4) or ``"::"`` (for IPv6), the server will listen on all available addresses matching that IP type.
    64. 

  64. 

  65. If ``bind_address`` is set to any valid address (e.g. ``"192.168.1.101"``, ``"::1"``, etc), the server will only listen on the interface with that addresses (or fail if no interface with the given address exists).
    66. 

  66. 

  67. ----
    68. 

  68. 

  69. .. _class_TCP_Server_method_stop:
    70. 

  70. 

  71. - void **stop** **(** **)**
    72. 

  72. 

  73. Stops listening.
    74. 

  74. 

  75. ----
    76. 

  76. 

  77. .. _class_TCP_Server_method_take_connection:
    78. 

  78. 

  79. - :ref:`StreamPeerTCP<class_StreamPeerTCP>` **take_connection** **(** **)**
    80. 

  80. 

  81. If a connection is available, returns a StreamPeerTCP with the connection.
    82. 

  82. 

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

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

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

  86.