Struct CoordinateOptions

pub struct CoordinateOptions { /* private fields */ }

CoordinateOptions is used to set the parameters of the Vivaldi-based coordinate mapping algorithm.

The following references are called out at various points in the documentation here:

[1] Dabek, Frank, et al. “Vivaldi: A decentralized network coordinate system.” ACM SIGCOMM Computer Communication Review. Vol. 34. No. 4. ACM, 2004. [2] Ledlie, Jonathan, Paul Gardner, and Margo I. Seltzer. “Network Coordinates in the Wild.” NSDI. Vol. 7. 2007. [3] Lee, Sanghwan, et al. “On suitability of Euclidean embedding for host-based network coordinate systems.” Networking, IEEE/ACM Transactions on 18.1 (2010): 27-40.

Implementations

impl CoordinateOptions

pub const fn dimensionality(&self) -> usize

Returns the dimensionality of the coordinate system.

pub const fn vivaldi_error_max(&self) -> f64

Returns the default error value when a node hasn’t yet made any observations.

pub const fn vivaldi_ce(&self) -> f64

Returns the maximum impact an observation can have on a node’s confidence.

pub const fn vivaldi_cc(&self) -> f64

Returns the maximum impact an observation can have on a node’s coordinate.

pub const fn adjustment_window_size(&self) -> usize

Returns how many samples we retain to calculate the adjustment factor.

pub const fn height_min(&self) -> f64

Returns the minimum value of the height parameter.

pub const fn latency_filter_size(&self) -> usize

Returns the maximum number of samples that are retained per node.

pub const fn gravity_rho(&self) -> f64

Returns how much gravity has an effect to try to re-center coordinates.

pub const fn metric_labels(&self) -> &Arc<MetricLabels>

The metric labels used to identify the metrics for this coordinate client.

pub fn with_dimensionality(self, val: usize) -> Self

Sets the dimensionality of the coordinate system.

pub fn with_vivaldi_error_max(self, val: f64) -> Self

Sets the default error value when a node hasn’t yet made any observations.

pub fn with_vivaldi_ce(self, val: f64) -> Self

Sets the maximum impact an observation can have on a node’s confidence.

pub fn with_vivaldi_cc(self, val: f64) -> Self

Sets the maximum impact an observation can have on a node’s coordinate.

pub fn with_adjustment_window_size(self, val: usize) -> Self

Sets how many samples we retain to calculate the adjustment factor.

pub fn with_height_min(self, val: f64) -> Self

Sets the minimum value of the height parameter.

pub fn with_latency_filter_size(self, val: usize) -> Self

Sets the maximum number of samples that are retained per node.

pub fn with_gravity_rho(self, val: f64) -> Self

Sets how much gravity has an effect to try to re-center coordinates.

pub fn with_metric_labels(self, val: Arc<MetricLabels>) -> Self

Sets the metric labels used to identify the metrics for this coordinate client.

impl CoordinateOptions

pub fn new() -> Self

Returns a CoordinateOptions that has some default values suitable for basic testing of the algorithm, but not tuned to any particular type of cluster.

Trait Implementations

impl Clone for CoordinateOptions

fn clone(&self) -> CoordinateOptions

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CoordinateOptions

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

Formats the value using the given formatter.

impl Default for CoordinateOptions

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for CoordinateOptions

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for CoordinateOptions

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

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for CoordinateOptions