StreamPeerTCP

    TCP stream peer.

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

    enum Status:

    • STATUS_CONNECTING = 1 —- A status representing a StreamPeerTCP that is connecting to a host.

    • STATUS_ERROR = 3 —- A status representing a in error state.

    • Error connect_to_host ( host, int port )

    Connects to the specified host:port pair. A hostname will be resolved if valid. Returns on success or @GlobalScope.FAILED on failure.


    Disconnects from host.


    • get_connected_host ( ) const

    Returns the IP of this peer.


    • int get_connected_port ( ) const

    Returns the port of this peer.


    • get_status ( )

    Returns the status of the connection, see Status.


    • is_connected_to_host ( ) const

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


    If enabled is true, packets will be sent immediately. If is false (the default), packet transfers will be delayed and combined using Nagle’s algorithm.

    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.