A11 (C++ runtime)
Native C++ implementation of the A11 action and streaming runtime
Loading...
Searching...
No Matches
a11::net::HttpSseOptions Struct Reference

Endpoint paths and transport tuning for an HTTP SSE wire stream. More...

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

Public Member Functions

absl::Status Validate () const
 

Public Attributes

WireStreamOptions stream_options
 Per-stream buffering and deadline.
 
Http2Options http2_options
 Shared HTTP/2 transport and TLS policy.
 
std::string connect_endpoint
 SSE connect POST path.
 
std::string message_endpoint
 Outbound POST template.
 
std::string cors_allow_origin
 Access-Control-Allow-Origin value.
 
std::string cors_allow_methods
 Access-Control-Allow-Methods value.
 
std::string cors_allow_headers
 Access-Control-Allow-Headers value.
 
std::string cors_expose_headers
 Access-Control-Expose-Headers value.
 

Detailed Description

Endpoint paths and transport tuning for an HTTP SSE wire stream.

A POST to connect_endpoint opens the SSE event stream; message_endpoint (a path template containing the stream id) receives posted outbound messages. http2_options and stream_options tune the underlying transport.

Member Function Documentation

◆ Validate()

absl::Status a11::net::HttpSseOptions::Validate ( ) const
Returns
OK if the options are internally consistent.

Member Data Documentation

◆ connect_endpoint

std::string a11::net::HttpSseOptions::connect_endpoint
Initial value:
=
constexpr std::string_view kDefaultSseConnectEndpoint
Default path on which a client opens the SSE event stream.
Definition http_sse_wire_stream.h:45

SSE connect POST path.

◆ cors_allow_headers

std::string a11::net::HttpSseOptions::cors_allow_headers

Access-Control-Allow-Headers value.

◆ cors_allow_methods

std::string a11::net::HttpSseOptions::cors_allow_methods

Access-Control-Allow-Methods value.

◆ cors_allow_origin

std::string a11::net::HttpSseOptions::cors_allow_origin

Access-Control-Allow-Origin value.

◆ cors_expose_headers

std::string a11::net::HttpSseOptions::cors_expose_headers

Access-Control-Expose-Headers value.

◆ http2_options

Http2Options a11::net::HttpSseOptions::http2_options

Shared HTTP/2 transport and TLS policy.

◆ message_endpoint

std::string a11::net::HttpSseOptions::message_endpoint
Initial value:
=
constexpr std::string_view kDefaultSseMessageEndpoint
Default message-post path template ({id} is the stream id).
Definition http_sse_wire_stream.h:47

Outbound POST template.

◆ stream_options

WireStreamOptions a11::net::HttpSseOptions::stream_options

Per-stream buffering and deadline.


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