StreamPeerTCP

TCP Stream peer.

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

@GodotBaseClass

struct StreamPeerTCP {

enum string _GODOT_internal_name;

union __anonymous;

alias BaseClasses = AliasSeq!(typeof(_GODOT_base), typeof(_GODOT_base).BaseClasses);

bool opEquals(StreamPeerTCP other);

StreamPeerTCP opAssign(T n);

bool opEquals(typeof(null) n);

mixin baseCasts ;

static StreamPeerTCP _new();

enum Constants;

GodotError connectToHost(StringArg0 host, long port);

bool isConnectedToHost();

StreamPeerTCP.Status getStatus();

String getConnectedHost();

long getConnectedPort();

void disconnectFromHost();

void setNoDelay(bool enabled);

}

Members

Aliases

BaseClasses alias BaseClasses = AliasSeq!(typeof(_GODOT_base), typeof(_GODOT_base).BaseClasses): Undocumented in source.

Enums

Constants enum Constants
Status enum Status

Functions

connectToHost GodotError connectToHost(StringArg0 host, long port): Connect to the specified host:port pair. A hostname will be resolved if valid. Returns OK on success or FAILED on failure.
disconnectFromHost void disconnectFromHost(): Disconnect from host.
getConnectedHost String getConnectedHost(): Return the IP of this peer.
getConnectedPort long getConnectedPort(): Return the port of this peer.
getStatus StreamPeerTCP.Status getStatus(): Return the status of the connection, one of STATUS_* enum.
isConnectedToHost bool isConnectedToHost(): Returns true if this peer is currently connected to a host, codefalsecode otherwise.
opAssign StreamPeerTCP opAssign(T n): Undocumented in source. Be warned that the author may not have intended to support it.
opEquals bool opEquals(StreamPeerTCP other): Undocumented in source. Be warned that the author may not have intended to support it.
opEquals bool opEquals(typeof(null) n): Undocumented in source. Be warned that the author may not have intended to support it.
setNoDelay void setNoDelay(bool enabled): Disable Nagle algorithm to improve latency for small packets. Note that for applications that send large packets, or need to transfer a lot of data, this can reduce total bandwidth.

Mixins

__anonymous mixin baseCasts: Undocumented in source.

Static functions

_new StreamPeerTCP _new(): Undocumented in source. Be warned that the author may not have intended to support it.

Static variables

_classBindingInitialized bool _classBindingInitialized;: Undocumented in source.

Structs

_classBinding struct _classBinding: Undocumented in source.

Unions

__anonymous union __anonymous: Undocumented in source.

Variables

_GODOT_internal_name enum string _GODOT_internal_name;: Undocumented in source.

Mixed In Members

From `mixin baseCasts`

as To as(): Undocumented in source. Be warned that the author may not have intended to support it.
as To as(): Undocumented in source. Be warned that the author may not have intended to support it.
as ToRef as(): Undocumented in source. Be warned that the author may not have intended to support it.
opCast template opCast(To): Undocumented in source.
opCast template opCast(To): Undocumented in source.
opCast template opCast(ToRef): Undocumented in source.
opCast void* opCast(): Undocumented in source. Be warned that the author may not have intended to support it.
opCast godot_object opCast(): Undocumented in source. Be warned that the author may not have intended to support it.
opCast bool opCast(): Undocumented in source. Be warned that the author may not have intended to support it.

Meta

Source

See Implementation

godot streampeertcp structs

StreamPeerTCP