Struct GrpcConfig 

#[non_exhaustive]
pub struct GrpcConfig {

    pub enabled: bool,
    pub listener: Listener,
    pub bind: String,
    pub health: bool,
    pub reflection: Toggle,
    pub metrics: bool,
    pub max_metric_series: usize,
    pub shutdown_grace_ms: u64,
    pub timeout_ms: u64,
    pub max_connections: usize,
    pub concurrency_limit_per_connection: usize,
    pub max_concurrent_streams: u32,
    pub http2_max_local_error_reset_streams: usize,
    pub tcp_nodelay: bool,
    pub tcp_keepalive_ms: u64,
    pub http2_keepalive_interval_ms: u64,
    pub http2_keepalive_timeout_ms: u64,
    pub max_connection_age_ms: u64,
    pub tls: TlsConfig,
    pub clients: BTreeMap<String, ClientConfig>,
}

Settings for one gRPC server.

The defaults limit resource use. For a setting that says “0: off”, the value 0 removes that limit or feature.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

enabled: bool

Start the server. Default: true.

listener: Listener

dedicated: a listener of its own, on bind. shared: Autumn’s HTTP port (needs the multiplex feature). Default: dedicated.

bind: String

Listen address, IP:port. Port 0 picks a free port. Empty: the profile decides. dev and test use 127.0.0.1:50051. Other profiles use 0.0.0.0:50051. Default: empty.

health: bool

Serve grpc.health.v1.Health. Default: true.

reflection: Toggle

Serve server reflection. auto is on in dev and test only.

metrics: bool

Record grpc_server_* metrics. Default: true.

max_metric_series: usize

Maximum label sets per metric. The plugin counts new label sets over this limit as other. Default: 1000.

shutdown_grace_ms: u64

Time for in-flight calls to finish at shutdown. Must be more than 0. Default: 10000.

timeout_ms: u64

Per-call timeout for unary calls. 0: off. Default: 0.

max_connections: usize

Open connections. The listener waits when it reaches the limit. 0: off. Default: 1000.

concurrency_limit_per_connection: usize

Concurrent calls per connection. A streaming call counts until its response starts. 0: off. Default: 0.

max_concurrent_streams: u32

HTTP/2 SETTINGS_MAX_CONCURRENT_STREAMS. Must be more than 0. Default: 200.

http2_max_local_error_reset_streams: usize

Server-side stream resets per connection before the server closes it (a protection against reset floods). Must be more than 0. Default: 1024.

tcp_nodelay: bool

Set TCP_NODELAY. Default: true.

tcp_keepalive_ms: u64

TCP keepalive idle time. 0: off. Default: 0.

http2_keepalive_interval_ms: u64

HTTP/2 PING interval. 0: off. Default: 60000.

http2_keepalive_timeout_ms: u64

Time to wait for a PING reply. 0: tonic default (20 s). Default: 20000.

max_connection_age_ms: u64

Close connections after this age. 0: off. Default: 0.

tls: TlsConfig

TLS settings. Empty paths mean plain text.

clients: BTreeMap<String, ClientConfig>

Downstream services to call, by name ([grpc.clients.<name>]). Needs the client feature. The server does not use them.

Implementations

impl GrpcConfig

pub fn bind_addr(&self, development: bool) -> Result<SocketAddr, ConfigError>

The listen address. An empty bind gives 127.0.0.1:50051 in development and 0.0.0.0:50051 in other profiles.

Errors

Returns ConfigError when bind is not IP:port.

pub const fn timeout(&self) -> Option<Duration>

Per-call timeout.

pub const fn shutdown_grace(&self) -> Duration

Shutdown grace period.

pub const fn tcp_keepalive(&self) -> Option<Duration>

TCP keepalive idle time.

pub const fn http2_keepalive_interval(&self) -> Option<Duration>

HTTP/2 PING interval.

pub const fn http2_keepalive_timeout(&self) -> Option<Duration>

HTTP/2 PING ack timeout.

pub const fn max_connection_age(&self) -> Option<Duration>

Maximum connection age.

pub fn from_toml_str(text: &str, section: &str) -> Result<Self, ConfigError>

Parse [section] from a whole autumn.toml text. No profiles and no environment.

Errors

Returns ConfigError for bad TOML, unknown keys, wrong types or values that validate rejects.

pub fn resolve(section: &str) -> Result<Resolved, ConfigError>

Resolve [section] from the app’s files and the process environment.

Errors

Returns ConfigError when a file cannot be read or parsed, or when the merged section is not valid.

pub fn resolve_with_env( section: &str, env: &dyn Env, ) -> Result<Resolved, ConfigError>

Like resolve, but reads only env.

Errors

See resolve.

pub fn resolve_with_env_and_clients( section: &str, env: &dyn Env, clients: &[&str], ) -> Result<Resolved, ConfigError>

Like resolve_with_env. Env overrides apply to each client in the files and to each name in clients (the plugin passes the names from client).

Errors

See resolve.

pub fn validate(&self) -> Result<(), ConfigError>

Reject values that fail at runtime.

Errors

Returns ConfigError that names the bad key.

Trait Implementations

impl Clone for GrpcConfig

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 GrpcConfig

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

Formats the value using the given formatter.

impl Default for GrpcConfig

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for GrpcConfig

where GrpcConfig: Default,

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for GrpcConfig

impl PartialEq for GrpcConfig

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for GrpcConfig

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 GrpcConfig