Struct HealthClient
pub struct HealthClient<T> { /* private fields */ }Expand description
Health is gRPC’s mechanism for checking whether a server is able to handle RPCs. Its semantics are documented in https://github.com/grpc/grpc/blob/master/doc/health-checking.md.
Implementations§
§impl<T> HealthClient<T>where
T: GrpcService<Body>,
<T as GrpcService<Body>>::Error: Into<Box<dyn Error + Sync + Send>>,
<T as GrpcService<Body>>::ResponseBody: Body<Data = Bytes> + Send + Sync + 'static,
<<T as GrpcService<Body>>::ResponseBody as Body>::Error: Into<Box<dyn Error + Sync + Send>> + Send,
impl<T> HealthClient<T>where
T: GrpcService<Body>,
<T as GrpcService<Body>>::Error: Into<Box<dyn Error + Sync + Send>>,
<T as GrpcService<Body>>::ResponseBody: Body<Data = Bytes> + Send + Sync + 'static,
<<T as GrpcService<Body>>::ResponseBody as Body>::Error: Into<Box<dyn Error + Sync + Send>> + Send,
pub fn new(inner: T, origin: Uri) -> HealthClient<T>
pub fn into_inner(self) -> Grpc<T>
pub fn into_transport(self) -> T
pub fn with_send_compressed(
self,
encoding: CompressionEncoding,
) -> HealthClient<T>
pub fn with_send_compressed( self, encoding: CompressionEncoding, ) -> HealthClient<T>
Compress requests with the given encoding.
This requires the server to support it otherwise it might respond with an error.
pub fn set_send_compressed(
&mut self,
encoding: CompressionEncoding,
) -> &mut HealthClient<T>
pub fn set_send_compressed( &mut self, encoding: CompressionEncoding, ) -> &mut HealthClient<T>
Compress requests with the given encoding.
This requires the server to support it otherwise it might respond with an error.
pub fn with_accept_compressed(
self,
encoding: CompressionEncoding,
) -> HealthClient<T>
pub fn with_accept_compressed( self, encoding: CompressionEncoding, ) -> HealthClient<T>
Enable decompressing responses.
pub fn set_accept_compressed(
&mut self,
encoding: CompressionEncoding,
) -> &mut HealthClient<T>
pub fn set_accept_compressed( &mut self, encoding: CompressionEncoding, ) -> &mut HealthClient<T>
Enable decompressing responses.
pub fn with_max_decoding_message_size(self, limit: usize) -> HealthClient<T>
pub fn with_max_decoding_message_size(self, limit: usize) -> HealthClient<T>
Limits the maximum size of a decoded message.
Default: 4MB
pub fn set_max_decoding_message_size(
&mut self,
limit: usize,
) -> &mut HealthClient<T>
pub fn set_max_decoding_message_size( &mut self, limit: usize, ) -> &mut HealthClient<T>
Limits the maximum size of a decoded message.
Default: 4MB
pub fn with_max_encoding_message_size(self, limit: usize) -> HealthClient<T>
pub fn with_max_encoding_message_size(self, limit: usize) -> HealthClient<T>
Limits the maximum size of an encoded message.
Default: usize::MAX
pub fn set_max_encoding_message_size(
&mut self,
limit: usize,
) -> &mut HealthClient<T>
pub fn set_max_encoding_message_size( &mut self, limit: usize, ) -> &mut HealthClient<T>
Limits the maximum size of an encoded message.
Default: usize::MAX
pub async fn check(
&self,
request: impl IntoRequest<HealthCheckRequest>,
) -> Result<Response<HealthCheckResponse>, Status>
pub async fn check( &self, request: impl IntoRequest<HealthCheckRequest>, ) -> Result<Response<HealthCheckResponse>, Status>
Check gets the health of the specified service. If the requested service is unknown, the call will fail with status NOT_FOUND. If the caller does not specify a service name, the server should respond with its overall health status.
Clients should set a deadline when calling Check, and can declare the server unhealthy if they do not receive a timely response.
pub async fn list(
&self,
request: impl IntoRequest<HealthListRequest>,
) -> Result<Response<HealthListResponse>, Status>
pub async fn list( &self, request: impl IntoRequest<HealthListRequest>, ) -> Result<Response<HealthListResponse>, Status>
List provides a non-atomic snapshot of the health of all the available services.
The server may respond with a RESOURCE_EXHAUSTED error if too many services exist.
Clients should set a deadline when calling List, and can declare the server unhealthy if they do not receive a timely response.
Clients should keep in mind that the list of health services exposed by an application can change over the lifetime of the process.
pub async fn watch(
&self,
request: impl IntoRequest<HealthCheckRequest>,
) -> Result<Response<Streaming<HealthCheckResponse>>, Status>
pub async fn watch( &self, request: impl IntoRequest<HealthCheckRequest>, ) -> Result<Response<Streaming<HealthCheckResponse>>, Status>
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.
Trait Implementations§
§impl<T> Clone for HealthClient<T>where
T: Clone,
impl<T> Clone for HealthClient<T>where
T: Clone,
§fn clone(&self) -> HealthClient<T>
fn clone(&self) -> HealthClient<T>
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read moreAuto Trait Implementations§
impl<T> !Freeze for HealthClient<T>
impl<T> RefUnwindSafe for HealthClient<T>where
T: RefUnwindSafe,
impl<T> Send for HealthClient<T>where
T: Send,
impl<T> Sync for HealthClient<T>where
T: Sync,
impl<T> Unpin for HealthClient<T>where
T: Unpin,
impl<T> UnwindSafe for HealthClient<T>where
T: UnwindSafe,
Blanket Implementations§
§impl<'a, T, E> AsTaggedExplicit<'a, E> for Twhere
T: 'a,
impl<'a, T, E> AsTaggedExplicit<'a, E> for Twhere
T: 'a,
§impl<'a, T, E> AsTaggedImplicit<'a, E> for Twhere
T: 'a,
impl<'a, T, E> AsTaggedImplicit<'a, E> for Twhere
T: 'a,
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
§impl<T> FutureExt for T
impl<T> FutureExt for T
§fn with_context(self, otel_cx: Context) -> WithContext<Self> ⓘ
fn with_context(self, otel_cx: Context) -> WithContext<Self> ⓘ
§fn with_current_context(self) -> WithContext<Self> ⓘ
fn with_current_context(self) -> WithContext<Self> ⓘ
§impl<T> Instrument for T
impl<T> Instrument for T
§fn instrument(self, span: Span) -> Instrumented<Self> ⓘ
fn instrument(self, span: Span) -> Instrumented<Self> ⓘ
§fn in_current_span(self) -> Instrumented<Self> ⓘ
fn in_current_span(self) -> Instrumented<Self> ⓘ
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ
fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ
self into a Left variant of Either<Self, Self>
if into_left is true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
self into a Left variant of Either<Self, Self>
if into_left(&self) returns true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read more§impl<T> IntoRequest<T> for T
impl<T> IntoRequest<T> for T
§fn into_request(self) -> Request<T>
fn into_request(self) -> Request<T>
T in a rama_grpc::Request§impl<T> Pointable for T
impl<T> Pointable for T
§impl<T> PolicyExt for Twhere
T: ?Sized,
impl<T> PolicyExt for Twhere
T: ?Sized,
§fn and<P, B, E>(self, other: P) -> And<T, P>
fn and<P, B, E>(self, other: P) -> And<T, P>
Policy that returns Action::Follow only if self and other return
Action::Follow. Read more