SNTP

本模块包含控制 SNTP 通信的功能。

摘要

类型定义符
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 查询参数。

类型定义符

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 上提供的源代码。如需了解详情，或者为我们的文档做贡献，请参阅资源。