TcpServer

A TCP server.

1.0.0

class TcpServerReckfellSharpInherits SocketServer

A TCP server.

A TCP server. Listens to connections on a port and returns a StreamPeerTcp when it gets an incoming connection. 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

TcpServerConstructor

# TcpServer

C#
public TcpServer();

Methods3

GetLocalPortint

# GetLocalPort

C#
public int GetLocalPort();

Returns the local port this server is listening to.

Returns int

ListenError

# Listen

C#
public Error Listen(ushort port, string bindAddress = "*");

Listen on the port binding to bind_address. If bind_address is set as "*" (default), the server will listen on all available addresses (both IPv4 and IPv6). 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. 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 address (or fail if no interface with the given address exists).

Parameters
Name	Type	Default
`port`	`ushort`	—
`bindAddress`	`string`	`"*"`

Returns Error

TakeConnectionStreamPeerTcp

# TakeConnection

C#
public StreamPeerTcp TakeConnection();

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

Returns StreamPeerTcp

Reckfell Engine documentationBack to top ↑