dpyRtc Namespace Reference

Deepsy Rtc namespace that includes the different enums, structs or method signatures that should be used.

Classes
struct	DateSources
struct	ParamConfig
	Parameters struct which contains the response received from the service. More...

Typedefs
typedef boost::function< void(const bool &available)>	service_availability_handler
	Prototype of the handler function used to monitor service availability. More...
typedef boost::function< void(boost::system::error_code &ec)>	result_handler
	Handler for result function callback. This type of function is called when the status callback is done. More...
typedef boost::function< void(boost::system::error_code &ec, dpyRtc::ParamConfig &)>	params_handler
	Handler for result function callback. This type of function is called when the status callback is done. More...
typedef boost::function< void(boost::system::error_code &ec, struct tm date_and_time)>	time_and_date_handler
	Handler for result function callback. This type of function is called when the status callback is done. More...
typedef boost::function< void(boost::system::error_code &ec, struct tm date_and_time, struct tm last_set_date_and_time)>	time_date_set_handler
	Handler for result function callback. This type of function is called when the status callback is done. More...
typedef boost::function< void(boost::system::error_code &ec, struct tm date_and_time, struct tm last_set_date_and_time, struct tm sunrise_date_and_time, struct tm sunset_date_and_time, bool is_day)>	time_date_set_daylight_handler
	Handler for result function callback. This type of function is called when the status callback is done. More...
typedef boost::function< void(boost::system::error_code &ec, std::map< std::string, dpyRtc::DateSources > sourceList)>	sources_list_handler
	Prototype of the handler function for getting sources list. More...

Enumerations
enum	DateSourceType { GNSS = 0, MODEM = 1, SNTP = 2, FILE = 3 }
	Defines the possible status of date sources. More...

Typedef Documentation

params_handler

typedef boost::function<void(boost::system::error_code& ec, dpyRtc::ParamConfig &)> params_handler

Parameters

ec	error code (if any)
ParamConfig

result_handler

typedef boost::function<void(boost::system::error_code& ec)> result_handler

Parameters

ec	error code (if any)

service_availability_handler

typedef boost::function<void(const bool &available)> service_availability_handler

Parameters

available

true if the service is available, false otherwise

sources_list_handler

typedef boost::function<void(boost::system::error_code& ec, std::map<std::string, dpyRtc::DateSources> sourceList)> sources_list_handler

Parameters

error_code	error code (if any)
sources	list of rtc sources

time_and_date_handler

typedef boost::function<void(boost::system::error_code& ec, struct tm date_and_time)> time_and_date_handler

Parameters

ec	error code (if any)
date_and_time	date and time provided by the service

Deprecated:

time_date_set_daylight_handler

typedef boost::function<void(boost::system::error_code& ec, struct tm date_and_time,struct tm last_set_date_and_time, struct tm sunrise_date_and_time, struct tm sunset_date_and_time, bool is_day)> time_date_set_daylight_handler

Parameters

ec	error code (if any)
date_and_time	date and time provided by the service
last_set_date_and_time	last time the RTC performed a set date
sunrise_date_and_time	sunrise date and time provided by the service
sunset_date_and_time	sunset date and time provided by the service
is_day	boolean that indicates if it is day or night at the moment of the

time_date_set_handler

typedef boost::function<void(boost::system::error_code& ec, struct tm date_and_time,struct tm last_set_date_and_time)> time_date_set_handler

Parameters

ec	error code (if any)
date_and_time	date and time provided by the service
last_set_date_and_time	last time the RTC performed a set date

Enumeration Type Documentation

DateSourceType

enum DateSourceType

Enumerator
GNSS	Gnss device.
MODEM	Modem device.
SNTP	SNTP Server.
FILE	File , containing a line with date time info in ISO 8601:2000 standard date format [FTTZ].