neograph::async::WsClientOptions Struct Reference

Resource ceilings and deadlines for a WebSocket connection. More...

#include <ws_client.h>

Public Attributes
std::chrono::milliseconds	handshake_timeout {30000}
	Deadline for the whole opening handshake of ws_connect: name resolution, TCP connect, TLS handshake and the HTTP Upgrade exchange.
std::size_t	max_frame_payload_bytes = 16u * 1024u * 1024u
	Maximum payload size of any individual data or control frame.
std::size_t	max_handshake_bytes = 64u * 1024u
	Maximum HTTP Upgrade response header size, including the final CRLF CRLF.
std::size_t	max_message_payload_bytes = 16u * 1024u * 1024u
	Maximum assembled Text/Binary message size across fragments.
std::chrono::milliseconds	read_timeout {0}
	Longest one recv() call waits for the next application message (pings answered meanwhile do not extend it).

Detailed Description

Resource ceilings and deadlines for a WebSocket connection.

Limits are checked before payload reads or outbound frame construction.

Definition at line 64 of file ws_client.h.

Member Data Documentation

handshake_timeout

std::chrono::milliseconds neograph::async::WsClientOptions::handshake_timeout {30000}

Deadline for the whole opening handshake of ws_connect: name resolution, TCP connect, TLS handshake and the HTTP Upgrade exchange.

Expiry throws asio::system_error(asio::error::timed_out). Zero = no deadline.

Definition at line 79 of file ws_client.h.

max_handshake_bytes

std::size_t neograph::async::WsClientOptions::max_handshake_bytes = 64u * 1024u

Maximum HTTP Upgrade response header size, including the final CRLF CRLF.

Also bounds the serialized client Upgrade request.

Definition at line 67 of file ws_client.h.

read_timeout

std::chrono::milliseconds neograph::async::WsClientOptions::read_timeout {0}

Longest one recv() call waits for the next application message (pings answered meanwhile do not extend it).

Expiry closes the connection and throws asio::system_error(asio::error::timed_out). Zero (the default) = no deadline, since an idle connection that waits for server pushes is normal.

Definition at line 86 of file ws_client.h.

---

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

• include/neograph/async/ws_client.h