Struct BrokerSession 

pub struct BrokerSession { /* private fields */ }

A negotiated, dialed, and framed broker backend connection.

Produced by BrokerSession::adopt. Wraps the BackendConnection stream in a FrameClient so the caller can issue correlated request/response frames immediately, while still exposing how the connection was reached (route), the cacheable endpoint, and the broker’s negotiated metadata.

Implementations

impl BrokerSession

pub fn adopt(request: ConnectBackendRequest<'_>) -> Result<Self, AdoptError>

Negotiate through the broker and return a ready-to-talk session.

Honours the canonical escape hatch first: if RUNNING_PROCESS_DISABLE=1 is set, this returns AdoptError::BrokerDisabled so the consumer falls back to its direct path instead of silently dialing the broker. An invalid disable value surfaces as AdoptError::DisableEnv.

pub fn route(&self) -> BackendConnectionRoute

How the backend connection was reached.

pub fn endpoint(&self) -> &str

Negotiated backend endpoint, suitable as a Hello-skip cache key.

pub fn negotiated(&self) -> Option<&Negotiated>

Broker negotiation metadata, present when the broker path was used.

pub fn request( &mut self, payload_protocol: u32, payload: Vec<u8>, ) -> Result<Frame, FrameClientError>

Send one correlated request and await its response frame.

pub fn client_mut(&mut self) -> &mut FrameClient

Borrow the underlying frame client for advanced use.

pub fn into_client(self) -> FrameClient

Consume the session and return the owned frame client.

pub fn into_backend_io(self) -> Result<OwnedBackendIo, IntoBackendIoError>

Consume the session and hand back the live negotiated socket as an owned OS handle (#720).

After adoption has driven the broker handshake to completion, a consumer that wants to stop speaking the FrameV1 request/response wire and run its own protocol over the same connection calls this to take ownership of the raw socket. On Unix the result wraps an OwnedFd; the Windows OwnedHandle path is deferred, so this returns IntoBackendIoError::WindowsUnsupported there for now.

Fails with IntoBackendIoError::BufferedResidual if the frame reader has buffered response bytes the bare socket would not carry — which never happens on a freshly adopted session that has issued no request.