TinyCTS
Bluetooth Current Time Service client and server for Arduino
Loading...
Searching...
No Matches
tiny_cts::TinyCTSTimeSource Class Referenceabstract

Abstract base class of the time sources: an object that knows the current UTC time. More...

#include <TinyCTSTimeSource.h>

Inheritance diagram for tiny_cts::TinyCTSTimeSource:
tiny_cts::TinyCTSClientBase tiny_cts::TinyCTSClockSource tiny_cts::TinyCTSSourceAdapter< T > tiny_cts::TinyCTSSystemSource tiny_cts::TinyCTSClient tiny_cts::TinyCTSClient tiny_cts::TinyCTSClient tiny_cts::TinyCTSClient

Public Member Functions

virtual uint64_t getTimeMs ()=0
 The current UTC time in milliseconds since 1970-01-01. It must not block.
virtual bool setTimeMs (uint64_t unixMs)
 Set the current UTC time, e.g. when a client writes the Current Time characteristic. The default implementation does not support this.

Detailed Description

Abstract base class of the time sources: an object that knows the current UTC time.

Member Function Documentation

◆ getTimeMs()

virtual uint64_t tiny_cts::TinyCTSTimeSource::getTimeMs ( )
pure virtual

The current UTC time in milliseconds since 1970-01-01. It must not block.

Returns
The time or 0 as long as it is not known.

Implemented in tiny_cts::TinyCTSClientBase, tiny_cts::TinyCTSClockSource, tiny_cts::TinyCTSSourceAdapter< T >, and tiny_cts::TinyCTSSystemSource.

◆ setTimeMs()

virtual bool tiny_cts::TinyCTSTimeSource::setTimeMs ( uint64_t unixMs)
inlinevirtual

Set the current UTC time, e.g. when a client writes the Current Time characteristic. The default implementation does not support this.

Returns
true if the time was set.

Reimplemented in tiny_cts::TinyCTSClient, tiny_cts::TinyCTSClient, tiny_cts::TinyCTSClient, tiny_cts::TinyCTSClient, tiny_cts::TinyCTSClockSource, and tiny_cts::TinyCTSSystemSource.


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