Struct GrpcHandle 

pub struct GrpcHandle { /* private fields */ }

A handle to the gRPC server of one plugin.

Get it from GrpcPlugin::handle before boot, or from AppState after boot:

let handle = state.extension::<GrpcHandle>().expect("gRPC plugin");

The plugin calls shutdown when the app stops. Call it yourself to drain earlier.

Implementations

impl GrpcHandle

pub fn local_addr(&self) -> Option<SocketAddr>

The bound address. None before start, and always None with listener = "shared". With port 0, this is the real port.

pub fn state(&self) -> Lifecycle

The current lifecycle state.

pub fn health_reporter(&self) -> Option<HealthReporter>

The health reporter, when the health service is on. Use it to mark a service NOT_SERVING at runtime.

pub fn shutdown_grace(&self) -> Duration

The drain time that shutdown allows. It is shutdown_grace_ms, capped by Autumn’s server.shutdown_timeout_secs.

pub fn metric_families(&self) -> Vec<MetricFamily>

The current grpc_server_* metric families.

pub async fn shutdown(&self)

Stop the server.

1. Set every health status to NOT_SERVING.
2. Stop accepting connections. Tell clients to go away (HTTP/2 GOAWAY).
3. Wait for in-flight calls, up to the grace period.
4. Close the connections that are still open.

With listener = "shared", Autumn owns the connections. Steps 2 and 4 change: the plugin answers new calls with UNAVAILABLE, and it ends open calls with UNAVAILABLE. The drain also starts by itself when Autumn stops its listener.

A task does the drain. If you drop this future, the drain continues. You can call this method more than once, from many tasks. Each call returns after the server stops.

Trait Implementations

impl Clone for GrpcHandle

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for GrpcHandle

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

Formats the value using the given formatter.