Symple module

Server::Options

Configuration options for the Symple server.

Options

#include <icy/symple/server.h>

struct Options

Defined in src/symple/include/icy/symple/server.h:140

Configuration options for the Symple server.

List of all members

Name	Kind	Owner
`host`	`variable`	Declared here
`port`	`variable`	Declared here
`socket`	`variable`	Declared here
`authentication`	`variable`	Declared here
`dynamicRooms`	`variable`	Declared here
`maxConnections`	`variable`	Declared here
`maxMessageSize`	`variable`	Declared here
`rateLimit`	`variable`	Declared here
`rateSeconds`	`variable`	Declared here

Public Attributes

Return	Name	Description
`std::string`	`host`
`uint16_t`	`port`
`net::TCPSocket::Ptr`	`socket`	Optional pre-created listen socket (e.g. SSLSocket for HTTPS/WSS).
`bool`	`authentication`	Require token in auth message.
`bool`	`dynamicRooms`	Allow clients to join/leave rooms.
`size_t`	`maxConnections`	Max WebSocket connections (0 = unlimited)
`size_t`	`maxMessageSize`	Max message payload in bytes (64KB default)
`double`	`rateLimit`	Messages per rate window.
`double`	`rateSeconds`	Rate window in seconds.

host

std::string host = "0.0.0.0"

Defined in src/symple/include/icy/symple/server.h:142

port

uint16_t port = 4500

Defined in src/symple/include/icy/symple/server.h:143

socket

net::TCPSocket::Ptr socket

Defined in src/symple/include/icy/symple/server.h:144

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

authentication

bool authentication = false

Defined in src/symple/include/icy/symple/server.h:145

Require token in auth message.

dynamicRooms

bool dynamicRooms = true

Defined in src/symple/include/icy/symple/server.h:146

Allow clients to join/leave rooms.

maxConnections

size_t maxConnections = 0

Defined in src/symple/include/icy/symple/server.h:149

Max WebSocket connections (0 = unlimited)

maxMessageSize

size_t maxMessageSize = 64 * 1024

Defined in src/symple/include/icy/symple/server.h:150

Max message payload in bytes (64KB default)

rateLimit

double rateLimit = 100.0

Defined in src/symple/include/icy/symple/server.h:151

Messages per rate window.

rateSeconds

double rateSeconds = 10.0

Defined in src/symple/include/icy/symple/server.h:152

Rate window in seconds.