SNTP

這個模組內含控制 SNTP 通訊的功能。

摘要

Typedefs
otSntpQuery typedef
struct otSntpQuery
導入 SNTP 查詢參數。
otSntpResponseHandler)(void *aContext, uint64_t aTime, otError aResult) typedef
void(*
收到 SNTP 回應時，會呼叫指標。

函式
otSntpClientQuery(otInstance *aInstance, const otSntpQuery *aQuery, otSntpResponseHandler aHandler, void *aContext)
傳送 SNTP 查詢。
otSntpClientSetUnixEra(otInstance *aInstance, uint32_t aUnixEra)
void
設定 Unix 年代數字。

結構
otSntpQuery

導入 SNTP 查詢參數。

Typedefs

otSntpQuery

struct otSntpQuery otSntpQuery

導入 SNTP 查詢參數。

otSntpResponseHandler

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

收到 SNTP 回應時，會呼叫指標。

詳細說明
參數
[in] aContext
指向應用程式特定背景資訊的指標。
[in] aTime
以 UNIX 時間指定伺服器回應離開伺服器的時間。
[in] aResult
SNTP 交易的結果。
傳回值
OT_ERROR_NONE
已成功收到回應，並在 aTime 中提供時間。
OT_ERROR_ABORT
因堆疊取消 SNTP 交易。
OT_ERROR_BUSY
已收到 Kiss-o'-death 封包。
OT_ERROR_RESPONSE_TIMEOUT
逾時內未收到 SNTP 回應。
OT_ERROR_FAILED
已收到回應，但包含不正確的資料。

函式

otSntpClientQuery

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

傳送 SNTP 查詢。

須啟用「OPENTHREAD_CONFIG_SNTP_CLIENT_ENABLE」功能才能使用。

詳細說明
參數
[in] aInstance
指向 OpenThread 執行個體的指標。
[in] aQuery
指定 SNTP 查詢參數的指標。
[in] aHandler
要在回應接收或逾時時呼叫的函式指標。
[in] aContext
指向任意背景資訊的指標。

otSntpClientSetUnixEra

void otSntpClientSetUnixEra(
  otInstance *aInstance,
  uint32_t aUnixEra
)

設定 Unix 年代數字。

Unix era 的預設值是 0。後續時代則從 2106 年開始。

詳細說明
參數
[in] aInstance
指向 OpenThread 執行個體的指標。
[in] aUnixEra
Unixera 編號。

巨集

OT_SNTP_DEFAULT_SERVER_IP

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

定義預設的 SNTP 伺服器位址 - Google NTP 伺服器。

OT_SNTP_DEFAULT_SERVER_PORT

 OT_SNTP_DEFAULT_SERVER_PORT 123

定義預設的 SNTP 伺服器通訊埠。

資源

OpenThread API 參考資料主題源自原始碼，請前往 GitHub 取得。如要瞭解詳情或對說明文件做出貢獻，請參閱資源。