Struct statime::config::InstanceConfig

pub struct InstanceConfig {
    pub clock_identity: ClockIdentity,
    pub priority_1: u8,
    pub priority_2: u8,
    pub domain_number: u8,
    pub sdo_id: SdoId,
    pub slave_only: bool,
    pub path_trace: bool,
}

Configuration for a PtpInstance

Example

A configuration with common default values:

let config = InstanceConfig {
    clock_identity: ClockIdentity::from_mac_address([1,2,3,4,5,6]),
    priority_1: 128,
    priority_2: 128,
    domain_number: 0,
    sdo_id: SdoId::default(),
    slave_only: false,
    path_trace: false,
};

Fields

clock_identity: ClockIdentity

The unique identifier for this device within the PTP network.

priority_1: u8

Priority of this clock while selecting a master clock.

Lower values assign a higher priority.

priority_2: u8

Tie-breaker priority during master clock selection on otherwise identical instances.

Lower values assign a higher priority.

domain_number: u8

This and InstanceConfig::sdo_id together identify which domain a PtpInstance belongs to.

In general nodes will only communicate within their domain. See IEEE 1588-2019 table 2 for permitted combinations.

sdo_id: SdoId

See InstanceConfig::domain_number.

slave_only: bool

Whether this node may never become a master in the network

path_trace: bool

Whether the path trace option is enabled

Trait Implementations

impl Clone for InstanceConfig

fn clone(&self) -> InstanceConfig

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for InstanceConfig

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

Formats the value using the given formatter.

impl Hash for InstanceConfig

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for InstanceConfig

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Copy for InstanceConfig

impl Eq for InstanceConfig

impl StructuralPartialEq for InstanceConfig