#include <server/viewer_server.hpp>

Public Attributes
std::string	host = default_host()
	"0.0.0.0" or a LAN address makes the viewer reachable from the network: it then needs a token
std::uint16_t	port = 8766
	0 = pick a free port (tests)
std::string	token
	at least 16 characters of [A-Za-z0-9._~-]; empty = generated when the host is not a loopback address
bool	allow_open = false
	a non-loopback host without any token (–view-insecure)
std::string	embed
	pages that may frame the viewer, as CSP sources separated by spaces (–view-embed); empty = nobody (X-Frame-Options: DENY)
std::size_t	max_clients = 16
	WebSocket viewers, counted from the upgrade on (a burst cannot overshoot); the next gets 503.
std::size_t	max_connections = 128
	concurrent HTTP connections (a page load is one); beyond it a connection is closed at once
std::size_t	max_connections_per_address = 16
	of those, from one address: one host cannot use them all up before it has authenticated
std::string	web_root
	directory with index.html; empty = <source dir>/viewer/dist
std::size_t	max_queue_msgs = 2000
	per client: beyond this, transient messages are dropped
std::size_t	max_queue_bytes = 8u << 20
	per client: same, by bytes
std::size_t	disconnect_bytes = 256u << 20
	per client: state backlog that drops the connection

Detailed Description

Definition at line 26 of file viewer_server.hpp.

Member Data Documentation

◆ allow_open

bool tmk::server::ServerOptions::allow_open = false

a non-loopback host without any token (–view-insecure)

Definition at line 30 of file viewer_server.hpp.

◆ disconnect_bytes

std::size_t tmk::server::ServerOptions::disconnect_bytes = 256u << 20

per client: state backlog that drops the connection

Definition at line 38 of file viewer_server.hpp.

◆ embed

std::string tmk::server::ServerOptions::embed

pages that may frame the viewer, as CSP sources separated by spaces (–view-embed); empty = nobody (X-Frame-Options: DENY)

Definition at line 31 of file viewer_server.hpp.

◆ host

std::string tmk::server::ServerOptions::host = default_host()

"0.0.0.0" or a LAN address makes the viewer reachable from the network: it then needs a token

Definition at line 27 of file viewer_server.hpp.

◆ max_clients

std::size_t tmk::server::ServerOptions::max_clients = 16

WebSocket viewers, counted from the upgrade on (a burst cannot overshoot); the next gets 503.

Definition at line 32 of file viewer_server.hpp.

◆ max_connections

std::size_t tmk::server::ServerOptions::max_connections = 128

concurrent HTTP connections (a page load is one); beyond it a connection is closed at once

Definition at line 33 of file viewer_server.hpp.

◆ max_connections_per_address

std::size_t tmk::server::ServerOptions::max_connections_per_address = 16

of those, from one address: one host cannot use them all up before it has authenticated

Definition at line 34 of file viewer_server.hpp.

◆ max_queue_bytes

std::size_t tmk::server::ServerOptions::max_queue_bytes = 8u << 20

per client: same, by bytes

Definition at line 37 of file viewer_server.hpp.

◆ max_queue_msgs

std::size_t tmk::server::ServerOptions::max_queue_msgs = 2000

per client: beyond this, transient messages are dropped

Definition at line 36 of file viewer_server.hpp.

◆ port

std::uint16_t tmk::server::ServerOptions::port = 8766

0 = pick a free port (tests)

Definition at line 28 of file viewer_server.hpp.

◆ token

std::string tmk::server::ServerOptions::token

at least 16 characters of [A-Za-z0-9._~-]; empty = generated when the host is not a loopback address

Definition at line 29 of file viewer_server.hpp.

◆ web_root

std::string tmk::server::ServerOptions::web_root

directory with index.html; empty = <source dir>/viewer/dist

Definition at line 35 of file viewer_server.hpp.

The documentation for this struct was generated from the following file:

server/viewer_server.hpp

Public Attributes