Struct cdn_broker::Args

pub(crate) struct Args {
    pub(crate) discovery_endpoint: String,
    pub(crate) public_bind_endpoint: String,
    pub(crate) public_advertise_endpoint: String,
    pub(crate) private_bind_endpoint: String,
    pub(crate) private_advertise_endpoint: String,
    pub(crate) metrics_bind_endpoint: Option<String>,
    pub(crate) ca_cert_path: Option<String>,
    pub(crate) ca_key_path: Option<String>,
    pub(crate) key_seed: u64,
    pub(crate) global_memory_pool_size: usize,
}

The main component of the push CDN.

Fields

discovery_endpoint: String

The discovery client endpoint (including scheme) to connect to. With the local discovery feature, this is a file path. With the remote (redis) discovery feature, this is a redis URL (e.g. redis://127.0.0.1:6789).

public_bind_endpoint: String

The user-facing endpoint in IP:port form to bind to for connections from users

public_advertise_endpoint: String

The user-facing endpoint in IP:port form to advertise

private_bind_endpoint: String

The broker-facing endpoint in IP:port form to bind to for connections from other brokers

private_advertise_endpoint: String

The broker-facing endpoint in IP:port form to advertise

metrics_bind_endpoint: Option<String>

The endpoint to bind to for externalizing metrics (in IP:port form). If not provided, metrics are not exposed.

ca_cert_path: Option<String>

The path to the CA certificate If not provided, a local, pinned CA is used

ca_key_path: Option<String>

The path to the CA key If not provided, a local, pinned CA is used

key_seed: u64

The seed for broker key generation

global_memory_pool_size: usize

The size of the global memory pool (in bytes). This is the maximum number of bytes that can be allocated at once for all connections. A connection will block if it tries to allocate more than this amount until some memory is freed. Default is 1GB.

Trait Implementations

impl Args for Args

fn group_id() -> Option<Id>

Report the [ArgGroup::id][crate::ArgGroup::id] for this set of arguments

fn augment_args<'b>(__clap_app: Command) -> Command

Append to [Command] so it can instantiate Self via [FromArgMatches::from_arg_matches_mut]

fn augment_args_for_update<'b>(__clap_app: Command) -> Command

Append to [Command] so it can instantiate self via [FromArgMatches::update_from_arg_matches_mut]

impl CommandFactory for Args

fn command<'b>() -> Command

Build a [Command] that can instantiate Self.

fn command_for_update<'b>() -> Command

Build a [Command] that can update self.

impl Debug for Args

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

Formats the value using the given formatter.

impl FromArgMatches for Args

fn from_arg_matches(__clap_arg_matches: &ArgMatches) -> Result<Self, Error>

Instantiate Self from [ArgMatches], parsing the arguments as needed.

fn from_arg_matches_mut( __clap_arg_matches: &mut ArgMatches, ) -> Result<Self, Error>

Instantiate Self from [ArgMatches], parsing the arguments as needed.

fn update_from_arg_matches( &mut self, __clap_arg_matches: &ArgMatches, ) -> Result<(), Error>

Assign values from ArgMatches to self.

fn update_from_arg_matches_mut( &mut self, __clap_arg_matches: &mut ArgMatches, ) -> Result<(), Error>

Assign values from ArgMatches to self.

impl Parser for Args

fn parse() -> Self

Parse from std::env::args_os(), [exit][Error::exit] on error.

fn try_parse() -> Result<Self, Error>

Parse from std::env::args_os(), return Err on error.

fn parse_from<I, T>(itr: I) -> Self

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Parse from iterator, [exit][Error::exit] on error.

fn try_parse_from<I, T>(itr: I) -> Result<Self, Error>

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Parse from iterator, return Err on error.

fn update_from<I, T>(&mut self, itr: I)

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Update from iterator, [exit][Error::exit] on error.

fn try_update_from<I, T>(&mut self, itr: I) -> Result<(), Error>

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Update from iterator, return Err on error.