Skip to main content

Module protocol_mod

Module protocol_mod 

Source
Expand description

Protocol-level utilities for Braid-HTTP.

Modules§

braid_state
Braid protocol state extracted from HTTP request headers.
constants
Protocol constants for Braid-HTTP.
formatter
Protocol message formatter.
headers
Shared header parsing and formatting for Braid-HTTP.
multiplex
Multiplexing protocol constants and framing for Braid-HTTP.
parser
Protocol parsing utilities.

Structs§

BraidState
Braid protocol state extracted from HTTP request headers.
HeaderParser
Header parser for protocol messages.

Constants§

STATUS_GONE
HTTP status code for history dropped (Section 4.5).
STATUS_MERGE_CONFLICT
HTTP status code for merge conflicts (Section 2.2).
STATUS_RANGE_NOT_SATISFIABLE
HTTP status code for range not satisfiable.
STATUS_SUBSCRIPTION
HTTP status code for subscription updates (Section 4).

Functions§

format_content_range
format_update
Format an Update into Braid protocol message bytes.
format_version_header
Format version header value.
format_version_header_json
parse_content_range
parse_current_version_header
parse_heartbeat
parse_merge_type
parse_tunneled_response
parse_version_header
Parse version header value.