Symple module

Client::Options

Connection and authentication options for the Symple client.

Options

#include <icy/symple/client.h>

struct Options

Defined in src/symple/include/icy/symple/client.h:93

Public Attributes

Return	Name	Description
`std::string`	`host`
`uint16_t`	`port`
`bool`	`secure`	Use wss:// instead of ws://.
`bool`	`reconnection`	Auto-reconnect on disconnect.
`int`	`reconnectAttempts`	0 = unlimited
`int`	`reconnectDelay`	Milliseconds between retries.
`std::string`	`user`	User identifier (required)
`std::string`	`name`	Display name.
`std::string`	`type`	Peer type.
`std::string`	`token`	Auth token (optional)
`size_t`	`maxMessageSize`	Maximum inbound message size.

host

std::string host = "127.0.0.1"

Defined in src/symple/include/icy/symple/client.h:95

port

uint16_t port = 4500

Defined in src/symple/include/icy/symple/client.h:96

secure

bool secure = false

Defined in src/symple/include/icy/symple/client.h:97

Use wss:// instead of ws://.

reconnection

bool reconnection = true

Defined in src/symple/include/icy/symple/client.h:98

Auto-reconnect on disconnect.

reconnectAttempts

int reconnectAttempts = 0

Defined in src/symple/include/icy/symple/client.h:99

0 = unlimited

reconnectDelay

int reconnectDelay = 3000

Defined in src/symple/include/icy/symple/client.h:100

Milliseconds between retries.

user

std::string user

Defined in src/symple/include/icy/symple/client.h:102

User identifier (required)

name

std::string name

Defined in src/symple/include/icy/symple/client.h:103

Display name.

type

std::string type

Defined in src/symple/include/icy/symple/client.h:104

Peer type.

token

std::string token

Defined in src/symple/include/icy/symple/client.h:105

Auth token (optional)

maxMessageSize

size_t maxMessageSize = 256 * 1024

Defined in src/symple/include/icy/symple/client.h:106

Maximum inbound message size.

Public Methods

Return	Name	Description
	`Options`	Defaulted constructor.

Options

Options() = default

Defined in src/symple/include/icy/symple/client.h:108

Defaulted constructor.

Docs by Sourcey