Skip to main content

TCP

The default transport protocol. The client establishes a control channel through the server listen address. For TLS, see TLS.

Example

Server:

# orbien-server.toml
listen = "0.0.0.0:9527"

[transport]
tcpMux = true

Client:

# orbien.toml
server = "YOUR_SERVER_IP:9527"

[transport]
protocol = "tcp"
tcpMux = true
heartbeatInterval = -1

Client parameters

ParameterRequiredDefaultDescription
transport.protocolNotcpAlways tcp
transport.tcpMuxNotrueTCP multiplexing; must match the server
transport.heartbeatIntervalNo-1Application heartbeat interval (seconds); -1 disables it. Becomes 30 when tcpMux is off
transport.heartbeatTimeoutNo-1Heartbeat timeout (seconds); disconnect if no Pong. Becomes 90 when tcpMux is off; see TCP Multiplexing

Server parameters

ParameterRequiredDefaultDescription
listenYes0.0.0.0:9527TCP listen address
transport.tcpMuxNotrueTCP multiplexing; must match the client