a11::net::WebSocketClientOptions Struct Reference

Client-side tuning for a WebSocketWireStream connection. More...

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

Public Member Functions
absl::Status	Validate () const

Public Attributes
Http2Options	http2_options
	HTTP/2 connection and TLS policy.
HttpHeaders	headers
	Extra WebSocket handshake headers.
ChannelFramingOptions	framing
	Packet splitting and reassembly bounds.
absl::Time	handshake_deadline = absl::InfiniteFuture()
	How long the handshake alone may take.

Detailed Description

Client-side tuning for a WebSocketWireStream connection.

Configures the underlying HTTP/2 transport (including TLS), extra HTTP headers sent on the WebSocket handshake, and the channel framing that governs message splitting and buffering.

Member Function Documentation

Validate()

absl::Status a11::net::WebSocketClientOptions::Validate

(

)

const

Returns

OK if the options are internally consistent.

Member Data Documentation

framing

ChannelFramingOptions a11::net::WebSocketClientOptions::framing

Packet splitting and reassembly bounds.

handshake_deadline

absl::Time a11::net::WebSocketClientOptions::handshake_deadline = absl::InfiniteFuture()

How long the handshake alone may take.

What a caller almost always means by "connect timeout": bound reaching a peer that accepts the TCP connection and then says nothing, without bounding the session that follows. http2_options.deadline and WireStreamOptions::deadline both abort the stream when they pass, which for a long-lived session is a different request entirely.

headers

HttpHeaders a11::net::WebSocketClientOptions::headers

Extra WebSocket handshake headers.

http2_options

Http2Options a11::net::WebSocketClientOptions::http2_options

HTTP/2 connection and TLS policy.

---

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

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