alexaClientSDK::avsCommon::utils::timing::SystemClockMonitor Class Reference

#include <SystemClockMonitor.h>

Public Member Functions
void	notifySystemClockSynchronized ()
void	addSystemClockMonitorObserver (const std::shared_ptr< avsCommon::sdkInterfaces::SystemClockMonitorObserverInterface > &observer)
void	removeSystemClockMonitorObserver (const std::shared_ptr< avsCommon::sdkInterfaces::SystemClockMonitorObserverInterface > &observer)

Static Public Member Functions
static std::shared_ptr< SystemClockMonitor >	createSystemClockMonitor ()

Detailed Description

This class monitors the system clock. When the system clock is synchronized, this class notifies its observers of the synchronization.

Member Function Documentation

addSystemClockMonitorObserver()

void alexaClientSDK::avsCommon::utils::timing::SystemClockMonitor::addSystemClockMonitorObserver

(

const std::shared_ptr< avsCommon::sdkInterfaces::SystemClockMonitorObserverInterface > &

observer

)

Add an observer to the system clock monitor

Parameters

observer

The observer to add to our set

createSystemClockMonitor()

std::shared_ptr< SystemClockMonitor > alexaClientSDK::avsCommon::utils::timing::SystemClockMonitor::createSystemClockMonitor ( )

static

Factory method that creates a new SystemClockMonitor.

Returns

A shared_ptr to a SystemClockMonitor.

notifySystemClockSynchronized()

void alexaClientSDK::avsCommon::utils::timing::SystemClockMonitor::notifySystemClockSynchronized

(

)

Should be called when the device clock has synchronized (ex. ntp time sync)

removeSystemClockMonitorObserver()

void alexaClientSDK::avsCommon::utils::timing::SystemClockMonitor::removeSystemClockMonitorObserver

(

const std::shared_ptr< avsCommon::sdkInterfaces::SystemClockMonitorObserverInterface > &

observer

)

Remove an observer to the system clock monitor

Parameters

observer

The observer to remove from our set

---

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

• /workplace/avs-device-sdk/AVSCommon/Utils/include/AVSCommon/Utils/Timing/SystemClockMonitor.h
• /workplace/avs-device-sdk/AVSCommon/Utils/src/SystemClockMonitor.cpp