Trait Health

pub trait Health:
    Send
    + Sync
    + 'static {
    type WatchStream: Stream<Item = Result<HealthCheckResponse, Status>> + Send + 'static;

    // Required methods
    fn check<'life0, 'async_trait>(
        &'life0 self,
        request: Request<HealthCheckRequest>,
    ) -> Pin<Box<dyn Future<Output = Result<Response<HealthCheckResponse>, Status>> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait;
    fn watch<'life0, 'async_trait>(
        &'life0 self,
        request: Request<HealthCheckRequest>,
    ) -> Pin<Box<dyn Future<Output = Result<Response<Self::WatchStream>, Status>> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait;
}

Generated trait containing gRPC methods that should be implemented for use with HealthServer.

Required Associated Types

type WatchStream: Stream<Item = Result<HealthCheckResponse, Status>> + Send + 'static

Server streaming response type for the Watch method.

Required Methods

fn check<'life0, 'async_trait>( &'life0 self, request: Request<HealthCheckRequest>, ) -> Pin<Box<dyn Future<Output = Result<Response<HealthCheckResponse>, Status>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

If the requested service is unknown, the call will fail with status NOT_FOUND.

fn watch<'life0, 'async_trait>( &'life0 self, request: Request<HealthCheckRequest>, ) -> Pin<Box<dyn Future<Output = Result<Response<Self::WatchStream>, Status>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Performs a watch for the serving status of the requested service. The server will immediately send back a message indicating the current serving status. It will then subsequently send a new message whenever the service’s serving status changes.

If the requested service is unknown when the call is received, the server will send a message setting the serving status to SERVICE_UNKNOWN but will not terminate the call. If at some future point, the serving status of the service becomes known, the server will send a new message with the service’s serving status.

If the call terminates with status UNIMPLEMENTED, then clients should assume this method is not supported and should not retry the call. If the call terminates with any other status (including OK), clients should retry the call with appropriate exponential backoff.

Implementors

impl Health for HealthService

type WatchStream = Pin<Box<dyn Stream<Item = Result<HealthCheckResponse, Status>> + Send>>