Modules#

SNTP#

This module includes functions that control SNTP communication.

typedef struct otSntpQuery

This structure implements SNTP Query parameters.

typedef void(*

otSntpResponseHandler)(void *aContext, uint64_t aTime, otError aResult)

This function pointer is called when a SNTP response is received.

otSntpClientQuery(otInstance *aInstance, const otSntpQuery *aQuery, otSntpResponseHandler aHandler, void *aContext)

This function sends a SNTP query.

void

otSntpClientSetUnixEra(otInstance *aInstance, uint32_t aUnixEra)

This function sets the unix era number.

#define

OT_SNTP_DEFAULT_SERVER_IP "2001:4860:4806:8::"

Defines default SNTP Server address - Google NTP Server.

#define

OT_SNTP_DEFAULT_SERVER_PORT 123

Defines default SNTP Server port.

typedef struct otSntpQuery otSntpQuery

This structure implements SNTP Query parameters.

typedef void(* otSntpResponseHandler) (void *aContext, uint64_t aTime, otError aResult) )(void *aContext, uint64_t aTime, otError aResult)

This function pointer is called when a SNTP response is received.

Parameters

Direction	Argument Name	Description
[in]	aContext	A pointer to application-specific context.
[in]	aTime	Specifies the time at the server when the response left for the client, in UNIX time.
[in]	aResult	A result of the SNTP transaction.

otError otSntpClientQuery (otInstance * aInstance, const otSntpQuery * aQuery, otSntpResponseHandler aHandler, void * aContext)

This function sends a SNTP query.

Parameters

Type	Direction	Argument Name	Description
otInstance *	[in]	aInstance	A pointer to an OpenThread instance.
const otSntpQuery *	[in]	aQuery	A pointer to specify SNTP query parameters.
otSntpResponseHandler	[in]	aHandler	A function pointer that shall be called on response reception or time-out.
void *	[in]	aContext	A pointer to arbitrary context information.

This function is available only if feature OPENTHREAD_CONFIG_SNTP_CLIENT_ENABLE is enabled.

void otSntpClientSetUnixEra (otInstance * aInstance, uint32_t aUnixEra)

This function sets the unix era number.

Parameters

Type	Direction	Argument Name	Description
otInstance *	[in]	aInstance	A pointer to an OpenThread instance.
uint32_t	[in]	aUnixEra	Unix era number.

The default value of unix era is set to 0. The subsequent eras start after year 2106.