SNTP

This module includes functions that control SNTP communication.

Summary

Typedefs
`otSntpQuery`	typedef `struct otSntpQuery` This structure implements SNTP Query parameters.
`otSntpResponseHandler)(void *aContext, uint64_t aTime, otError aResult)`	typedef `void(*` This function pointer is called when a SNTP response is received.

Functions
`otSntpClientQuery(otInstance aInstance, const otSntpQuery aQuery, otSntpResponseHandler aHandler, void *aContext)`	`otError` This function sends a SNTP query.
`otSntpClientSetUnixEra(otInstance *aInstance, uint32_t aUnixEra)`	`void` This function sets the unix era number.

Structs
otSntpQuery	This structure implements SNTP Query parameters.

struct otSntpQuery otSntpQuery

This structure implements SNTP Query parameters.

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

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

Details

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.

Return Values

`OT_ERROR_NONE`	A response was received successfully and time is provided in `aTime`.
`OT_ERROR_ABORT`	A SNTP transaction was aborted by stack.
`OT_ERROR_BUSY`	The Kiss-o'-death packet has been received.
`OT_ERROR_RESPONSE_TIMEOUT`	No SNTP response has been received within timeout.
`OT_ERROR_FAILED`	A response was received but contains incorrect data.

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

This function sends a SNTP query.

This function is available only if feature OPENTHREAD_CONFIG_SNTP_CLIENT_ENABLE_CLIENT is enabled.

Details

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.

void otSntpClientSetUnixEra(
  otInstance *aInstance,
  uint32_t aUnixEra
)

This function sets the unix era number.

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

Details

Parameters

`[in] aInstance`	A pointer to an OpenThread instance.
`[in] aUnixEra`	Unix era number.

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

Defines default SNTP Server address - Google NTP Server.

 OT_SNTP_DEFAULT_SERVER_PORT 123

Defines default SNTP Server port.