Expand description
Client-side helpers for the v1 broker Hello path.
Structs§
- Backend
Connection - Open backend connection returned by
connect_to_backend. - Broker
Disable EnvError - Invalid value for the canonical broker disable variable.
- Connect
Backend Request - Inputs for
connect_to_backend.
Enums§
- Backend
Connection Route - How
connect_to_backendreached the returned backend endpoint. - Broker
Client Error - Errors produced by broker client helpers.
- Refusal
Kind - Stable, matchable classification of a broker
HelloReply::Refusedcode.
Constants§
- DEFAULT_
HANDOFF_ READY_ TIMEOUT - Default wall-clock bound on waiting for the broker’s handoff-ready relay
before silently downgrading to the
backend_pipereconnect path. - RUNNING_
PROCESS_ DISABLE_ ENV - Canonical emergency escape hatch for participating broker consumers.
- RUNNING_
PROCESS_ DISABLE_ VALUE - Value that disables broker usage and keeps the consumer on its direct path.
- RUNNING_
PROCESS_ FAKE_ BACKEND_ ENV - TEST-ONLY seam that points the client at a fake backend endpoint (#354).
Functions§
- broker_
disabled_ by_ env - Return whether the canonical broker escape hatch is enabled.
- connect_
local_ socket - Open a platform local socket by broker endpoint string.
- connect_
to_ backend - Connect to a backend with the v1 Hello-skip fast path.
- send_
admin_ request - Send one typed admin request to a broker endpoint and return its reply.