Struct HealthReporter 

pub struct HealthReporter { /* private fields */ }

A handle providing methods to update the health status of gRPC services. A HealthReporter is connected to a HealthServer which serves the statuses over the grpc.health.v1.Health service.

Implementations

impl HealthReporter

pub async fn set_serving<S>(&mut self)

where S: NamedService,

Sets the status of the service implemented by S to Serving. This notifies any watchers if there is a change in status.

Examples found in repository

examples/echo_server.rs (line 82)

async fn main() -> Result<(), Box<dyn std::error::Error>> {
    let address: SocketAddr = "[::1]:50051".parse()?;
    let server = RpcServer::new(
        RpcServerConfig::new(address)
            .with_request_timeout(Duration::from_secs(10))
            .with_concurrency_limit(1_024),
    );
    let (mut reporter, health_service) = health_reporter();
    reporter.set_serving::<EchoServer<EchoService>>().await;

    server
        .router()
        .add_service(health_service)
        .add_service(EchoServer::new(EchoService))
        .serve(server.config().address())
        .await?;
    Ok(())
}

pub async fn set_not_serving<S>(&mut self)

where S: NamedService,

Sets the status of the service implemented by S to NotServing. This notifies any watchers if there is a change in status.

pub async fn set_service_status<S>( &mut self, service_name: S, status: ServingStatus, )

where S: AsRef<str>,

Sets the status of the service with service_name to status. This notifies any watchers if there is a change in status.

pub async fn clear_service_status(&mut self, service_name: &str)

Clear the status of the given service.

Trait Implementations

impl Clone for HealthReporter

fn clone(&self) -> HealthReporter

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for HealthReporter

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

Formats the value using the given formatter.