Struct ServerConf

pub struct ServerConf {

    pub version: usize,
    pub daemon: bool,
    pub error_log: Option<String>,
    pub pid_file: String,
    pub upgrade_sock: String,
    pub user: Option<String>,
    pub group: Option<String>,
    pub threads: usize,
    pub work_stealing: bool,
    pub ca_file: Option<String>,
    pub grace_period_seconds: Option<u64>,
    pub graceful_shutdown_timeout_seconds: Option<u64>,
    pub client_bind_to_ipv4: Vec<String>,
    pub client_bind_to_ipv6: Vec<String>,
    pub upstream_keepalive_pool_size: usize,
    pub upstream_connect_offload_threadpools: Option<usize>,
    pub upstream_connect_offload_thread_per_pool: Option<usize>,
    pub upstream_debug_ssl_keylog: bool,
}

The configuration file

Pingora configuration files are by default YAML files, but any key value format can potentially be used.

Extension

New keys can be added to the configuration files which this configuration object will ignore. Then, users can parse these key-values to pass to their code to use.

Fields

version: usize

Version

daemon: bool

Whether to run this process in the background.

error_log: Option<String>

When configured and daemon setting is true, error log will be written to the given file. Otherwise StdErr will be used.

pid_file: String

The pid (process ID) file of this server to be created when running in background

upgrade_sock: String

the path to the upgrade socket

In order to perform zero downtime restart, both the new and old process need to agree on the path to this sock in order to coordinate the upgrade.

user: Option<String>

If configured, after daemonization, this process will switch to the given user before starting to serve traffic.

group: Option<String>

Similar to user, the group this process should switch to.

threads: usize

How many threads each service should get. The threads are not shared across services.

work_stealing: bool

Allow work stealing between threads of the same service. Default true.

ca_file: Option<String>

The path to CA file the SSL library should use. If empty, the default trust store location defined by the SSL library will be used.

grace_period_seconds: Option<u64>

Grace period in seconds before starting the final step of the graceful shutdown after signaling shutdown.

graceful_shutdown_timeout_seconds: Option<u64>

Timeout in seconds of the final step for the graceful shutdown.

client_bind_to_ipv4: Vec<String>

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.

client_bind_to_ipv6: 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.

upstream_keepalive_pool_size: usize

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.

upstream_connect_offload_threadpools: Option<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.

upstream_connect_offload_thread_per_pool: 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.

upstream_debug_ssl_keylog: bool

When enabled allows TLS keys to be written to a file specified by the SSLKEYLOG env variable. This can be used by tools like Wireshark to decrypt upstream traffic for debugging purposes. Note: this is an unstable field that may be renamed or removed in the future.

Implementations

impl ServerConf

pub fn load_from_yaml<P>(path: P) -> Result<Self>

where P: AsRef<Path> + Display,

pub fn load_yaml_with_opt_override(opt: &Opt) -> Result<Self>

pub fn new() -> Option<Self>

pub fn new_with_opt_override(opt: &Opt) -> Option<Self>

pub fn from_yaml(conf_str: &str) -> Result<Self>

pub fn to_yaml(&self) -> String

pub fn validate(self) -> Result<Self>

pub fn merge_with_opt(&mut self, opt: &Opt)

Trait Implementations

impl Debug for ServerConf

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

Formats the value using the given formatter.

impl Default for ServerConf

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ServerConf

where ServerConf: Default,

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for ServerConf

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for ServerConf

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for ServerConf

impl StructuralPartialEq for ServerConf