graph_update_pb2

Generated protocol buffer code.

Classes:

GraphUpdate –

An update to the synchronization graph.

GraphUpdate

GraphUpdate(
    *,
    source: str = ...,
    clock_alias_update: ClockAliasUpdate | None = ...,
    clock_diff_measurement: (
        ClockDiffMeasurement | None
    ) = ...,
    clock_master_update: ClockMasterUpdate | None = ...,
    phc2sys_update: Phc2SysUpdate | None = ...,
    ptp_parent_update: PtpParentUpdate | None = ...,
    port_state_update: PortStateUpdate | None = ...,
    ptp4l_port_status_msg: (
        Ptp4lPortStatusMessage | None
    ) = ...,
    ptp4l_status_msg: Ptp4lStatusMessage | None = ...,
    phc2sys_status_msg: Phc2SysStatusMessage | None = ...,
    self_reported_clock_state_update: (
        SelfReportedClockStateUpdate | None
    ) = ...
)

Bases: Message

An update to the synchronization graph.

This is a message sent from diag workers or other components to the diag master. A synchronization graph can be constructed from 0 or more GraphUpdate messages.

Returned by:

API Reference sync_graph
- timed_graph_update_queue TimedGraphUpdateQueue updates
- update_aggregator aggregate_clock_diff_measurements

Used by:

API Reference

Methods:

clock_alias_update –

An update relating multiple different ClockIds that are aliases of the same clock.
clock_diff_measurement –

A non-PTP, non-PHC2SYS time offset measurement between two clocks.
clock_master_update –

An update relating a clock to its PTP master, along with a master offset measurement.
phc2sys_status_msg –

A PHC2SYS status message.
phc2sys_update –

An update relating a clock to its PHC2SYS source, along with an offset measurement.
port_state_update –

An update reporting the state of a PTP port.
ptp4l_port_status_msg –

A PTP4L port status message.
ptp4l_status_msg –

A PTP4L status message.
ptp_parent_update –

An update relating a clock to its parent PTP port.
self_reported_clock_state_update –

An update containing the self-reported state of a clock.

Attributes:

source (str) –

The source of the update, e.g. the name of the specific component of a worker that produced

source `instance-attribute`

source: str

The source of the update, e.g. the name of the specific component of a worker that produced the update.

clock_alias_update

clock_alias_update() -> ClockAliasUpdate

An update relating multiple different ClockIds that are aliases of the same clock.

clock_diff_measurement

clock_diff_measurement() -> ClockDiffMeasurement

A non-PTP, non-PHC2SYS time offset measurement between two clocks.

clock_master_update

clock_master_update() -> ClockMasterUpdate

An update relating a clock to its PTP master, along with a master offset measurement.

phc2sys_status_msg

phc2sys_status_msg() -> Phc2SysStatusMessage

A PHC2SYS status message.

phc2sys_update

phc2sys_update() -> Phc2SysUpdate

An update relating a clock to its PHC2SYS source, along with an offset measurement.

port_state_update

port_state_update() -> PortStateUpdate

An update reporting the state of a PTP port.

ptp4l_port_status_msg

ptp4l_port_status_msg() -> Ptp4lPortStatusMessage

A PTP4L port status message.

ptp4l_status_msg

ptp4l_status_msg() -> Ptp4lStatusMessage

A PTP4L status message.

ptp_parent_update

ptp_parent_update() -> PtpParentUpdate

An update relating a clock to its parent PTP port.

self_reported_clock_state_update

self_reported_clock_state_update() -> (
    SelfReportedClockStateUpdate
)

An update containing the self-reported state of a clock.