SNTP

このモジュールには、SNTP 通信を制御する関数が含まれています。

概要

Typedef
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 クエリ パラメータを実装します。

Typedef

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
UNIX の年代番号。

マクロ

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 で入手できるソースコードに由来しています。 詳細について、またはドキュメントへの投稿については、リソースをご覧ください。