Struct GatewayServeHandle 

pub struct GatewayServeHandle { /* private fields */ }

A running gateway server. Returned by Gateway::serve, Gateway::serve_duplex, Gateway::serve_with_listener, and Gateway::serve_via.

The same type covers all three flavors; the internal [HandleKind] carries flavor-specific teardown state. Shutdown is two steps: stop signals the server and runs the flavor-specific cleanup, and join awaits teardown. They are independent — join does not stop, so a caller that wants both must call stop first.

Implementations

impl GatewayServeHandle

pub fn from_mailbox_handle( gateway: Gateway, addr: ChannelAddr, handle: MailboxServerHandle, ) -> Self

Wrap an externally-produced MailboxServerHandle — e.g. a host’s muxed frontend accept loop driven outside the gateway — as a gateway serve handle. Registers addr as an active serve location (via add_server) so the gateway delivers traffic addressed to the frontend in-process instead of dialing it, and advertises it as the default location — mirroring Gateway::serve_with_listener. The active-serve entry is removed when the handle is stopped.

pub fn stop(&mut self, reason: &str)

Signal the underlying server to stop and run the flavor-specific cleanup: remove the active-serve entry for Serve, ServeDuplex, or ServeVia. Idempotent: later calls are no-ops. Call join afterward to await teardown.

pub async fn join(self) -> Result<(), MailboxServerError>

Await teardown of the underlying server (and any owned duplex session), returning its join result. This does not signal the server to stop; call stop first if it is still running, or join will block until it terminates on its own.

Trait Implementations

impl Debug for GatewayServeHandle

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Drop for GatewayServeHandle

fn drop(&mut self)

Executes the destructor for this type.