RAVENNAKIT
Loading...
Searching...
No Matches
rav::ptp::Instance::Subscriber Class Reference

#include <ptp_instance.hpp>

Inheritance diagram for rav::ptp::Instance::Subscriber:
rav::RavennaSender rav::nmos::Node

Public Member Functions

virtual ~Subscriber ()=default
virtual void ptp_parent_changed (const ParentDs &parent)
 Called when the parent of the PTP instance changes.
virtual void ptp_port_changed_state (const Port &port)
 Called when the state of a port changes.
virtual void ptp_port_removed (const uint16_t port_number)
 Called when a port was removed.
virtual void ptp_configuration_updated (const Configuration &config)
 Called when the configuration was updated.
virtual void ptp_stats_updated (const Stats &ptp_stats)
 Called at a regular interval when the PTP stats are updated.
const LocalClock & get_local_clock ()

Friends

class Instance

Detailed Description

Definition at line 56 of file ptp_instance.hpp.

Constructor & Destructor Documentation

◆ ~Subscriber()

virtual rav::ptp::Instance::Subscriber::~Subscriber ( )
virtualdefault

Member Function Documentation

◆ get_local_clock()

const LocalClock & rav::ptp::Instance::Subscriber::get_local_clock ( )
Returns
A reference to the local clock which received updates from the ptp::Instance. Thread safe and wait-free when called from a single consumer thread.

◆ ptp_configuration_updated()

virtual void rav::ptp::Instance::Subscriber::ptp_configuration_updated ( const Configuration & config)
inlinevirtual

Called when the configuration was updated.

Parameters
configThe new configuration.

Definition at line 88 of file ptp_instance.hpp.

◆ ptp_parent_changed()

virtual void rav::ptp::Instance::Subscriber::ptp_parent_changed ( const ParentDs & parent)
inlinevirtual

Called when the parent of the PTP instance changes.

Parameters
parentThe new parent data set.

Reimplemented in rav::nmos::Node, and rav::RavennaSender.

Definition at line 64 of file ptp_instance.hpp.

◆ ptp_port_changed_state()

virtual void rav::ptp::Instance::Subscriber::ptp_port_changed_state ( const Port & port)
inlinevirtual

Called when the state of a port changes.

Parameters
portThe port that changed state.

Reimplemented in rav::nmos::Node.

Definition at line 72 of file ptp_instance.hpp.

◆ ptp_port_removed()

virtual void rav::ptp::Instance::Subscriber::ptp_port_removed ( const uint16_t port_number)
inlinevirtual

Called when a port was removed.

Parameters
port_numberThe port number of the removed port.

Definition at line 80 of file ptp_instance.hpp.

◆ ptp_stats_updated()

virtual void rav::ptp::Instance::Subscriber::ptp_stats_updated ( const Stats & ptp_stats)
inlinevirtual

Called at a regular interval when the PTP stats are updated.

Parameters
ptp_statsThe updated statistics.

Definition at line 96 of file ptp_instance.hpp.

◆ Instance

friend class Instance
friend

Definition at line 107 of file ptp_instance.hpp.


The documentation for this class was generated from the following file: