Symple module

Server::Options

[Configuration]({#ref classicy_1_1Configuration #}) options for the Symple server.

Options

#include <icy/symple/server.h>

Configuration options for the Symple server.

Public Attributes

ReturnNameDescription
std::stringhost
uint16_tport
net::TCPSocket::PtrsocketOptional pre-created listen socket (e.g. SSLSocket for HTTPS/WSS).
boolauthenticationRequire token in auth message.
booldynamicRoomsAllow clients to join/leave rooms.
size_tmaxConnectionsMax WebSocket connections (0 = unlimited)
size_tmaxMessageSizeMax message payload in bytes (64KB default)
doublerateLimitMessages per rate window.
doublerateSecondsRate window in seconds.

host

std::string host = "0.0.0.0"

port

uint16_t port = 4500

socket

net::TCPSocket::Ptr socket

Optional pre-created listen socket (e.g. SSLSocket for HTTPS/WSS).


authentication

bool authentication = false

Require token in auth message.


dynamicRooms

bool dynamicRooms = true

Allow clients to join/leave rooms.


maxConnections

size_t maxConnections = 0

Max WebSocket connections (0 = unlimited)


maxMessageSize

size_t maxMessageSize = 64 * 1024

Max message payload in bytes (64KB default)


rateLimit

double rateLimit = 100.0

Messages per rate window.


rateSeconds

double rateSeconds = 10.0

Rate window in seconds.