SNTP#

This module includes functions that control SNTP communication.

Modules#

otSntpQuery

Typedefs#

typedef struct otSntpQuery
otSntpQuery

Implements SNTP Query parameters.

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

Pointer is called when a SNTP response is received.

Functions#

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

Sends a SNTP query.

void
otSntpClientSetUnixEra(otInstance *aInstance, uint32_t aUnixEra)

Sets the unix era number.

Macros#

#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 Documentation#

otSntpQuery#

typedef struct otSntpQuery otSntpQuery

Implements SNTP Query parameters.


Definition at line 66 of file include/openthread/sntp.h

otSntpResponseHandler#

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

Pointer is called when a SNTP response is received.

Parameters
[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.


Definition at line 83 of file include/openthread/sntp.h

Function Documentation#

otSntpClientQuery#

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

Sends a SNTP query.

Parameters
[in]aInstance

A pointer to an OpenThread instance.

[in]aQuery

A pointer to specify SNTP query parameters.

[in]aHandler

A function pointer that shall be called on response reception or time-out.

[in]aContext

A pointer to arbitrary context information.

Is available only if feature OPENTHREAD_CONFIG_SNTP_CLIENT_ENABLE is enabled.


Definition at line 96 of file include/openthread/sntp.h

otSntpClientSetUnixEra#

void otSntpClientSetUnixEra (otInstance *aInstance, uint32_t aUnixEra)

Sets the unix era number.

Parameters
[in]aInstance

A pointer to an OpenThread instance.

[in]aUnixEra

Unix era number.

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


Definition at line 110 of file include/openthread/sntp.h

Macro Definition Documentation#

OT_SNTP_DEFAULT_SERVER_IP#

#define OT_SNTP_DEFAULT_SERVER_IP
Value:
"2001:4860:4806:8::"

Defines default SNTP Server address - Google NTP Server.


Definition at line 56 of file include/openthread/sntp.h

OT_SNTP_DEFAULT_SERVER_PORT#

#define OT_SNTP_DEFAULT_SERVER_PORT
Value:
123

Defines default SNTP Server port.


Definition at line 57 of file include/openthread/sntp.h