StreamPeerTcp

A stream peer that handles TCP connections.

1.0.0

class StreamPeerTcpReckfellSharpInherits StreamPeerSocket

A stream peer that handles TCP connections.

A stream peer that handles TCP connections. This object can be used to connect to TCP servers, or also is returned by a TCP server. Note: When exporting to Android, make sure to enable the INTERNET permission in the Android export preset before exporting the project or using remote deploy. Otherwise, network communication of any kind will be blocked by Android.

Declarations checked against C# SDK 1.0.0. Expand a name to see declarations and documentation.

Constructors1

StreamPeerTcpConstructor

# StreamPeerTcp

C#
public StreamPeerTcp();

Methods6

BindError

# Bind

C#
public Error Bind(int port, string host = "*");

Opens the TCP socket, and binds it to the specified local address. This method is generally not needed, and only used to force the subsequent call to StreamPeerTcp.ConnectToHost 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.

Parameters
Name	Type	Default
`port`	`int`	—
`host`	`string`	`"*"`

Returns Error

ConnectToHostError

# ConnectToHost

C#
public Error ConnectToHost(string host, int port);

Connects to the specified host:port pair. A hostname will be resolved if valid. Returns OK on success.

Parameters
Name	Type	Default
`host`	`string`	—
`port`	`int`	—

Returns Error

GetConnectedHoststring

# GetConnectedHost

C#
public string GetConnectedHost();

Returns the IP of this peer.

Returns string

GetConnectedPortint

# GetConnectedPort

C#
public int GetConnectedPort();

Returns the port of this peer.

Returns int

GetLocalPortint

# GetLocalPort

C#
public int GetLocalPort();

Returns the local port to which this peer is bound.

Returns int

SetNoDelayvoid

# SetNoDelay

C#
public void SetNoDelay(bool enabled);

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

Parameters
Name	Type	Default
`enabled`	`bool`	—

Reckfell Engine documentationBack to top ↑