Skip to main content

Module client

Module client 

Source
Expand description

Client-side helpers for the v1 broker Hello path.

Structs§

BackendConnection
Open backend connection returned by connect_to_backend.
BrokerDisableEnvError
Invalid value for the canonical broker disable variable.
ConnectBackendRequest
Inputs for connect_to_backend.

Enums§

BackendConnectionRoute
How connect_to_backend reached the returned backend endpoint.
BrokerClientError
Errors produced by broker client helpers.
RefusalKind
Stable, matchable classification of a broker HelloReply::Refused code.

Constants§

DEFAULT_HANDOFF_READY_TIMEOUT
Default wall-clock bound on waiting for the broker’s handoff-ready relay before silently downgrading to the backend_pipe reconnect 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.