Add doc comments for unstable fields in ServerConf

This commit is contained in:
ewang 2024-03-29 12:45:11 -07:00 committed by Andrew Hauck
parent b02729272a
commit 9156ea7d5b
2 changed files with 13 additions and 1 deletions

2
.bleep
View file

@ -1 +1 @@
2d5a04345bc22194bc8a39d7cd8879adbb80a31d
562591ff1f7c4f21bea5f6659c850af47cc8ab7f

View file

@ -66,10 +66,22 @@ pub struct ServerConf {
/// Timeout in seconds of the final step for the graceful shutdown.
pub graceful_shutdown_timeout_seconds: Option<u64>,
// These options don't belong here as they are specific to certain services
/// IPv4 addresses for a client connector to bind to. See [`ConnectorOptions`].
/// Note: this is an _unstable_ field that may be renamed or removed in the future.
pub client_bind_to_ipv4: Vec<String>,
/// IPv6 addresses for a client connector to bind to. See [`ConnectorOptions`].
/// Note: this is an _unstable_ field that may be renamed or removed in the future.
pub client_bind_to_ipv6: Vec<String>,
/// Keepalive pool size for client connections to upstream. See [`ConnectorOptions`].
/// Note: this is an _unstable_ field that may be renamed or removed in the future.
pub upstream_keepalive_pool_size: usize,
/// Number of dedicated thread pools to use for upstream connection establishment.
/// See [`ConnectorOptions`].
/// Note: this is an _unstable_ field that may be renamed or removed in the future.
pub upstream_connect_offload_threadpools: Option<usize>,
/// Number of threads per dedicated upstream connection establishment pool.
/// See [`ConnectorOptions`].
/// Note: this is an _unstable_ field that may be renamed or removed in the future.
pub upstream_connect_offload_thread_per_pool: Option<usize>,
}