port_id_pb2

Generated protocol buffer code.

Classes:

• PortId –

  A unique identifier for a PTP port on a given clock.

PortId

PortId(
    *,
    clock_id: ClockId | None = ...,
    port_number: int = ...,
    ptp_domain: int = ...
)

Bases: Message

A unique identifier for a PTP port on a given clock.

A port is uniquely identified by its clock, port number and the PTP domain it operates in. The clock ID is subject to aliasing and alias resolution via ClockAliasUpdates.

Returned by:

• API Reference
  • sync_graph  sync_graph  SyncGraph
    •  get_links
    •  get_or_create_port
    •  get_ports
  • sync_tooling_msgs
    •  port_state_update_pb2  PortStateUpdate  port_id
    •  ptp4l_port_status_message_pb2  Ptp4lPortStatusMessage  port_id
    •  ptp_parent_update_pb2  PtpParentUpdate  parent

Used by:

• API Reference
  • sync_graph  sync_graph  SyncGraph
  • sync_tooling_msgs
    •  port_id  readable_port_id
    •  port_state_update_pb2  PortStateUpdate
    •  ptp4l_port_status_message_pb2  Ptp4lPortStatusMessage
    •  ptp_parent_update_pb2  PtpParentUpdate

Methods:

• clock_id –

  The clock ID of the clock the port belongs to

Attributes:

• port_number (int) –

  The number of the port on the clock

• ptp_domain (int) –

  The PTP domain the port belongs to

port_number instance-attribute

port_number: int

The number of the port on the clock

ptp_domain instance-attribute

ptp_domain: int

The PTP domain the port belongs to

clock_id

clock_id() -> ClockId

The clock ID of the clock the port belongs to