a11::net::WebSocketSignallingClientOptions Struct Reference

Connection tuning for a WebSocketSignallingClient. More...

#include <cpp/a11/net/websocket_signalling.h>

Public Member Functions
absl::Status	Validate () const

Public Attributes
Http2Options	http2_options
	HTTP/2 connection and TLS policy.
absl::Time	deadline = absl::InfiniteFuture()
	How long registering may take.
size_t	max_message_size = 1024 * 1024
	Inbound JSON message limit.
HttpHeaders	headers
	Extra headers sent on the WebSocket handshake.

Detailed Description

Connection tuning for a WebSocketSignallingClient.

Covers the underlying HTTP/2 transport (including TLS), a connect deadline, and the maximum accepted inbound signalling message size.

Member Function Documentation

Validate()

absl::Status a11::net::WebSocketSignallingClientOptions::Validate

(

)

const

Returns

OK if the options are internally consistent.

Member Data Documentation

deadline

absl::Time a11::net::WebSocketSignallingClientOptions::deadline = absl::InfiniteFuture()

How long registering may take.

Bounds the handshake only. Once registered, the socket stays open for as long as the client keeps it; set http2_options.deadline if you want the connection itself to expire.

headers

HttpHeaders a11::net::WebSocketSignallingClientOptions::headers

Extra headers sent on the WebSocket handshake.

How a client presents credentials to a signalling server that authenticates – an Authorization bearer, a deployment's own header. Without this the only place to put one is the URL's query string, where it ends up in logs.

http2_options

Http2Options a11::net::WebSocketSignallingClientOptions::http2_options

HTTP/2 connection and TLS policy.

max_message_size

size_t a11::net::WebSocketSignallingClientOptions::max_message_size = 1024 * 1024

Inbound JSON message limit.

---

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

• cpp/a11/net/websocket_signalling.h
• cpp/a11/net/websocket_signalling.cc