Struct qp2p::Config

pub struct Config {
    pub hard_coded_contacts: HashSet<SocketAddr>,
    pub local_port: Option<u16>,
    pub local_ip: Option<IpAddr>,
    pub forward_port: bool,
    pub external_port: Option<u16>,
    pub external_ip: Option<IpAddr>,
    pub max_msg_size_allowed: Option<u32>,
    pub idle_timeout_msec: Option<u64>,
    pub keep_alive_interval_msec: Option<u32>,
    pub bootstrap_cache_dir: Option<String>,
    pub upnp_lease_duration: Option<u32>,
    pub fresh: bool,
    pub clean: bool,
}

QuicP2p configurations

Fields

hard_coded_contacts: HashSet<SocketAddr>

Hard Coded contacts

local_port: Option<u16>

Port we want to reserve for QUIC. If none supplied we'll use the OS given random port. If external port is provided it means that the user is carrying out manual port forwarding and this field is mandatory. This will be the internal port number mapped to the process

local_ip: Option<IpAddr>

IP address for the listener. If none is supplied and forward_port is enabled, we will use IGD to realize the local IP address of the machine. If IGD fails the application will exit.

forward_port: bool

Specify if port forwarding via UPnP should be done or not. This can be set to false if the network is run locally on the network loopback or on a local area network.

external_port: Option<u16>

External port number assigned to the socket address of the program. If this is provided, QP2p considers that the local port provided has been mapped to the provided external port number and automatic port forwarding will be skipped.

external_ip: Option<IpAddr>

External IP address of the computer on the WAN. This field is mandatory if the node is the genesis node and port forwarding is not available. In case of non-genesis nodes, the external IP address will be resolved using the Echo service.

max_msg_size_allowed: Option<u32>

This is the maximum message size we'll allow the peer to send to us. Any bigger message and we'll error out probably shutting down the connection to the peer. If none supplied we'll default to the documented constant.

idle_timeout_msec: Option<u64>

If we hear nothing from the peer in the given interval we declare it offline to us. If none supplied we'll default to the documented constant.

The interval is in milliseconds. A value of 0 disables this feature.

keep_alive_interval_msec: Option<u32>

Interval to send keep-alives if we are idling so that the peer does not disconnect from us declaring us offline. If none is supplied we'll default to the documented constant.

The interval is in milliseconds. A value of 0 disables this feature.

bootstrap_cache_dir: Option<String>

Directory in which the bootstrap cache will be stored. If none is supplied, the platform specific default cache directory is used.

upnp_lease_duration: Option<u32>

Duration of a UPnP port mapping.

fresh: bool

Use a fresh config without re-using any config available on disk

clean: bool

Clean all existing config available on disk

Implementations

impl Config

pub fn read_or_construct_default(user_override: Option<&Path>) -> Result<Config>

Try and read the config off the disk first. If such a file-path doesn't exist it'll create a default one with random certificate and write that to the disk, eventually returning that config to the caller.

pub fn clear_config_from_disk(user_override: Option<&Path>) -> Result<()>

Clear all configuration files from disk

Trait Implementations

impl Clone for Config

fn clone(&self) -> Config

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Config

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

Formats the value using the given formatter.

impl Default for Config

fn default() -> Config

Returns the "default value" for a type.

impl<'de> Deserialize<'de> for Config

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl Eq for Config

impl PartialEq<Config> for Config

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl Serialize for Config

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

Serialize this value into the given Serde serializer.

impl StructOpt for Config

fn clap<'a, 'b>() -> App<'a, 'b>

Returns clap::App corresponding to the struct.

fn from_clap(matches: &ArgMatches<'_>) -> Self

Builds the struct from clap::ArgMatches. It's guaranteed to succeed if matches originates from an App generated by StructOpt::clap called on the same type, otherwise it must panic.

pub fn from_args() -> Self

Builds the struct from the command line arguments (std::env::args_os). Calls clap::Error::exit on failure, printing the error message and aborting the program.

pub fn from_args_safe() -> Result<Self, Error>

Builds the struct from the command line arguments (std::env::args_os). Unlike StructOpt::from_args, returns clap::Error on failure instead of aborting the program, so calling .exit is up to you.

pub fn from_iter<I>(iter: I) -> Self where
    I: IntoIterator,
    <I as IntoIterator>::Item: Into<OsString>,
    <I as IntoIterator>::Item: Clone, 

Gets the struct from any iterator such as a Vec of your making. Print the error message and quit the program in case of failure.

pub fn from_iter_safe<I>(iter: I) -> Result<Self, Error> where
    I: IntoIterator,
    <I as IntoIterator>::Item: Into<OsString>,
    <I as IntoIterator>::Item: Clone, 

Gets the struct from any iterator such as a Vec of your making.

impl StructOptInternal for Config

fn augment_clap<'a, 'b>(app: App<'a, 'b>) -> App<'a, 'b>

fn is_subcommand() -> bool

pub fn from_subcommand(
    _sub: (&'b str, Option<&'b ArgMatches<'a>>)
) -> Option<Self>

impl StructuralEq for Config

impl StructuralPartialEq for Config