Struct ConfigState

pub struct ConfigState {
    pub clusters: BTreeMap<ClusterId, Cluster>,
    pub backends: BTreeMap<ClusterId, Vec<Backend>>,
    pub http_listeners: BTreeMap<SocketAddr, HttpListenerConfig>,
    pub https_listeners: BTreeMap<SocketAddr, HttpsListenerConfig>,
    pub tcp_listeners: BTreeMap<SocketAddr, TcpListenerConfig>,
    pub http_fronts: BTreeMap<String, HttpFrontend>,
    pub https_fronts: BTreeMap<String, HttpFrontend>,
    pub tcp_fronts: HashMap<ClusterId, Vec<TcpFrontend>>,
    pub certificates: HashMap<SocketAddr, HashMap<Fingerprint, CertificateAndKey>>,
    pub request_counts: BTreeMap<String, i32>,
}

The ConfigState represents the state of Sōzu’s business, which is to forward traffic from frontends to backends. Hence, it contains all details about:

• listeners (socket addresses, for TCP and HTTP connections)
• frontends (bind to a listener)
• backends (to forward connections to)
• clusters (routing rules from frontends to backends)
• TLS certificates

Fields

clusters: BTreeMap<ClusterId, Cluster>

backends: BTreeMap<ClusterId, Vec<Backend>>

http_listeners: BTreeMap<SocketAddr, HttpListenerConfig>

socket address -> HTTP listener

https_listeners: BTreeMap<SocketAddr, HttpsListenerConfig>

socket address -> HTTPS listener

tcp_listeners: BTreeMap<SocketAddr, TcpListenerConfig>

socket address -> TCP listener

http_fronts: BTreeMap<String, HttpFrontend>

HTTP frontends, indexed by a summary of each front’s address;hostname;path, for uniqueness. For example: "0.0.0.0:8080;lolcatho.st;P/api"

https_fronts: BTreeMap<String, HttpFrontend>

indexed by (address, hostname, path)

tcp_fronts: HashMap<ClusterId, Vec<TcpFrontend>>

certificates: HashMap<SocketAddr, HashMap<Fingerprint, CertificateAndKey>>

request_counts: BTreeMap<String, i32>

A census of requests that were received. Name of the request -> number of occurences

Implementations

impl ConfigState

pub fn new() -> Self

pub fn dispatch(&mut self, request: &Request) -> Result<(), StateError>

pub fn get_request_counts(&self) -> RequestCounts

pub fn generate_activate_requests(&self) -> Vec<Request>

pub fn diff(&self, other: &ConfigState) -> Vec<Request>

pub fn hash_state(&self) -> BTreeMap<ClusterId, u64>

pub fn cluster_state(&self, cluster_id: &str) -> Option<ClusterInformation>

Gives details about a given cluster. Types like HttpFrontend are converted into protobuf ones, like RequestHttpFrontend

pub fn count_backends(&self) -> usize

pub fn count_frontends(&self) -> usize

pub fn get_cluster_ids_by_domain( &self, hostname: String, path: Option<String>, ) -> HashSet<ClusterId>

pub fn get_certificates( &self, filters: QueryCertificatesFilters, ) -> BTreeMap<String, CertificateAndKey>

pub fn list_frontends(&self, filters: FrontendFilters) -> ListedFrontends

pub fn list_listeners(&self) -> ListenersList

pub fn produce_initial_state(&self) -> InitialState

pub fn write_initial_state_to_file( &self, file: &mut File, ) -> Result<usize, StateError>

generate requests necessary to recreate the state, in protobuf, to a temp file

pub fn write_requests_to_file( &self, file: &mut File, ) -> Result<usize, StateError>

generate requests necessary to recreate the state, write them in a JSON form in a file, separated by \n\0, returns the number of written requests

Trait Implementations

impl Clone for ConfigState

fn clone(&self) -> ConfigState

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ConfigState

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

Formats the value using the given formatter.

impl Default for ConfigState

fn default() -> ConfigState

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ConfigState

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for ConfigState

fn eq(&self, other: &ConfigState) -> 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 ConfigState

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 ConfigState

impl StructuralPartialEq for ConfigState