Struct ServerConfig

pub struct ServerConfig {
    pub pid: NodeId,
    pub election_tick_timeout: u64,
    pub resend_message_tick_timeout: u64,
    pub buffer_size: usize,
    pub batch_size: usize,
    pub leader_priority: u32,
    pub logger_file_path: Option<String>,
    pub custom_logger: Option<Logger>,
}

Configuration for a singular OmniPaxos instance in a cluster.

Fields

• pid: The unique identifier of this node. Must not be 0.
• election_tick_timeout: The number of calls to tick() before leader election is updated. If this is set to 5 and tick() is called every 10ms, then the election timeout will be 50ms. Must not be 0.
• resend_message_tick_timeout: The number of calls to tick() before a message is considered dropped and thus resent. Must not be 0.
• buffer_size: The buffer size for outgoing messages.
• batch_size: The size of the buffer for log batching. The default is 1, which means no batching.
• logger_file_path: The path where the default logger logs events.
• leader_priority : Custom priority for this node to be elected as the leader.

Fields

pid: NodeId

The unique identifier of this node. Must not be 0.

election_tick_timeout: u64

The number of calls to tick() before leader election is updated. If this is set to 5 and tick() is called every 10ms, then the election timeout will be 50ms.

resend_message_tick_timeout: u64

The number of calls to tick() before a message is considered dropped and thus resent. Must not be 0.

buffer_size: usize

The buffer size for outgoing messages.

batch_size: usize

The size of the buffer for log batching. The default is 1, which means no batching.

leader_priority: u32

Custom priority for this node to be elected as the leader.

logger_file_path: Option<String>

Available on crate feature logging only.

The path where the default logger logs events.

custom_logger: Option<Logger>

Available on crate feature logging only.

Custom logger, if provided, will be used instead of the default logger.

Implementations

impl ServerConfig

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

Checks that all the fields of the server config are valid.

Trait Implementations

impl Clone for ServerConfig

fn clone(&self) -> ServerConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ServerConfig

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

Formats the value using the given formatter.

impl Default for ServerConfig

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ServerConfig

where ServerConfig: Default,

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.