Struct HealthCheckConfig 

pub struct HealthCheckConfig {
    pub uri: String,
    pub interval: u32,
    pub timeout: u32,
    pub healthy_threshold: u32,
    pub unhealthy_threshold: u32,
    pub expected_status: u32,
    pub mode: i32,
    pub accepted_statuses: Vec<HttpStatusRange>,
    pub port: Option<u32>,
    pub headers: Vec<HealthCheckHeader>,
}

Fields

uri: String

Request target of the HTTP probe; must start with /. Ignored in TCP mode. Kept required on the wire for compatibility with peers that predate mode.

interval: u32

timeout: u32

healthy_threshold: u32

unhealthy_threshold: u32

expected_status: u32

0 accepts any 2xx, any other value exactly that status. Applies only while accepted_statuses is empty; setting both is rejected.

mode: i32

Probe mode. Absent decodes as HTTP, the behaviour of peers that predate this field.

accepted_statuses: Vec<HttpStatusRange>

HTTP mode: the response statuses that count as healthy. When non-empty it replaces expected_status, which must then be 0.

port: Option<u32>

Port the probe dials, in 1..=65535; unset = the backend’s data port. When set, both HTTP and TCP probes connect to the backend’s IP address with this port, and the HTTP probe’s Host names that address. A peer that predates this field ignores it and probes the data port.

headers: Vec<HealthCheckHeader>

Extra request header fields of the HTTP probe (typically Authorization), in the order they are sent. Refused in TCP mode, with more than 32 entries, with a duplicate name (compared case-insensitively), with a name that is not an RFC 9110 token or that begins with : or is one of host, connection, keep-alive, proxy-connection, transfer-encoding, content-length, te, trailer, upgrade, expect, with a value holding a control byte other than HTAB or beginning or ending with SP or HTAB (RFC 9113 section 8.2.1; protobuf and TOML keep exact bytes and are refused), or when the sum of name + value + 4 bytes exceeds 8192 or the HTTP/2 probe’s HPACK block (four pseudo-headers included) may exceed 16384 bytes. Only names and fingerprints live here; the values travel in SetProtectedHealthCheck. A configuration that names headers whose values the process does not hold (restored from a saved state, or set through SetHealthCheck) sends no probe until they are provided again. A peer that predates this field ignores it, probes without the headers, and drops them when it re-emits the state.

The probe wire format is derived from Cluster.http2 (the same backend-capability hint the mux router reads). When the cluster sets http2 = true, the probe sends the HTTP/2 connection preface + empty SETTINGS + HEADERS frame on stream 1; otherwise HTTP/1.1. There is no per-HealthCheckConfig h2c flag — the probe wire follows the data-plane wire so an h2c-only backend is never probed with HTTP/1.1 (and vice versa).

Implementations

impl HealthCheckConfig

pub fn mode(&self) -> HealthCheckMode

Returns the enum value of mode, or the default if the field is set to an invalid enum value.

pub fn set_mode(&mut self, value: HealthCheckMode)

Sets mode to the provided enum value.

pub fn port(&self) -> u32

Returns the value of port, or the default value if port is unset.

Trait Implementations

impl Clone for HealthCheckConfig

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 HealthCheckConfig

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

Formats the value using the given formatter.

impl Default for HealthCheckConfig

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for HealthCheckConfig

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for HealthCheckConfig

impl Hash for HealthCheckConfig

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Message for HealthCheckConfig

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode(&self, buf: &mut impl BufMut) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message to a newly allocated buffer.

fn encode_length_delimited( &self, buf: &mut impl BufMut, ) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message with a length-delimiter to a buffer.

fn encode_length_delimited_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message with a length-delimiter to a newly allocated buffer.

fn decode(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes a length-delimited instance of the message from the buffer.

fn merge(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl Ord for HealthCheckConfig

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

fn clamp_to<R>(self, range: R) -> Self

where Self: Sized, R: ClampBounds<Self>,

🔬This is a nightly-only experimental API. (clamp_to)

Restrict a value to a certain range.

impl PartialEq for HealthCheckConfig

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl PartialOrd for HealthCheckConfig

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for HealthCheckConfig

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for HealthCheckConfig