Google 致力于为黑人社区推动种族平等。查看具体举措。

此页面由 Cloud Translation API 翻译。

nl::Weave::System::Layer

#include <src/system/SystemLayer.h>

This provides access to timers according to the configured event handling model.

摘要

对于 WEAVE_SYSTEM_CONFIG_USE_SOCKETS，事件就绪性通知通过平台适配上的传统轮询/选择实现来处理。

对于 WEAVE_SYSTEM_CONFIG_USE_LWIP，事件就绪性通知通过事件 / 消息以及事件/消息系统特定于平台和系统的钩子进行处理。

构造函数和析构函数
`Layer(void)`

公共类型
`EventHandler)(Object &aTarget, EventType aEventType, uintptr_t aArgument)`	typedef `Error(*`
`TimerCompleteFunct)(Layer aLayer, void aAppState, Error aError)`	typedef `void(*`

公共函数
`AddEventHandlerDelegate(LwIPEventHandlerDelegate & aDelegate)`	`Error` 这会将事件处理脚本委托添加到系统层，以扩展其处理 LwIP 事件的能力。
`CancelTimer(TimerCompleteFunct aOnComplete, void *aAppState)`	`void` 此方法用于取消之前通过 `StartTimer()` 开始的单次计时器。
`DispatchEvent(Event aEvent)`	`Error` 这会分派指定事件，以便由此实例进行处理。
`DispatchEvents(void)`	`Error` 这是特定于平台钩子的语法封装容器，该钩子影响事件循环，等待为该实例提供服务的队列，将事件从该队列中拉取，然后分派这些事件进行处理。
`GetPlatformData(void) const`	`void *` 这将返回分配给该实例的任何特定于客户端的平台数据（如果之前已设置）。
`HandleEvent(Object & aTarget, EventType aEventType, uintptr_t aArgument)`	`Error` 这样就能实现 Weave System Layer 事件的实际调度和处理。
`HandlePlatformTimer(void)`	`Error` 处理平台计时器到期事件。
`HandleSelectResult(int aSetSize, fd_set aReadSet, fd_set aWriteSet, fd_set *aExceptionSet)`	`void` 处理来自 select 调用的 I/O。
`Init(void *aContext)`	`Error`
`NewTimer(Timer *& aTimerPtr)`	`Error`
`PostEvent(Object & aTarget, EventType aEventType, uintptr_t aArgument)`	`Error` 这会将指定类型的事件 / 消息以及提供的参数发布到该实例的针对具体平台的事件队列中。
`PrepareSelect(int & aSetSize, fd_set aReadSet, fd_set aWriteSet, fd_set *aExceptionSet, struct timeval & aSleepTime)`	`void` 准备供 `select()` 使用的文件描述符集。
`ScheduleWork(TimerCompleteFunct aComplete, void *aAppState)`	`Error` 安排一个签名与 `TimerCompleteFunct` 完全相同的函数，尽快在 Weave 线程上运行。
`SetPlatformData(void *aPlatformData)`	`void` 这会将指定的客户端特定平台数据设置为该实例，以供客户端平台稍后检索。
`Shutdown(void)`	`Error`
`StartTimer(uint32_t aMilliseconds, TimerCompleteFunct aComplete, void *aAppState)`	`Error` 此方法会启动单次计时器。
`State(void) const`	`LayerState` 该方法会返回图层对象的当前状态。
`WakeSelect(void)`	`void` 使用 select() 将单个字节写入唤醒管道，以唤醒用于监控文件描述符的 I/O 线程。

公共静态函数
`GetClock_Monotonic(void)`	`uint64_t` 返回单调系统时间（以微秒为单位）。
`GetClock_MonotonicHiRes(void)`	`uint64_t` 返回（可能）高分辨率的单调系统时间（以微秒为单位）。
`GetClock_MonotonicMS(void)`	`uint64_t` 返回单调系统时间（以毫秒为单位）。
`GetClock_RealTime(uint64_t & curTime)`	`Error` 以微秒 Unix 时间格式返回当前实际（民用）时间。
`GetClock_RealTimeMS(uint64_t & curTimeMS)`	`Error` 以毫秒级 Unix 时间格式返回当前实际（民用）时间。
`SetClock_RealTime(uint64_t newCurTime)`	`Error` 设置平台对当前实际（民用）时间的概念。

公共类型

EventHandler

Error(* EventHandler)(Object &aTarget, EventType aEventType, uintptr_t aArgument)

TimerCompleteFunct

void(* TimerCompleteFunct)(Layer *aLayer, void *aAppState, Error aError)

公共函数

AddEventHandlerDelegate

Error AddEventHandlerDelegate(
  LwIPEventHandlerDelegate & aDelegate
)

这会将事件处理脚本委托添加到系统层，以扩展其处理 LwIP 事件的能力。

详细信息

参数

[in] aDelegate

未初始化的 LwIP 事件处理脚本委托结构

返回值

`WEAVE_SYSTEM_NO_ERROR`	成功时。
`WEAVE_SYSTEM_ERROR_BAD_ARGS`	如果 aDelegate 中包含的函数指针为 NULL

CancelTimer

void CancelTimer(
  TimerCompleteFunct aOnComplete,
  void *aAppState
)

此方法用于取消之前通过 StartTimer() 开始的单次计时器。

详细信息

参数

`[in] aOnComplete`	指向调用 `StartTimer()` 时使用的回调函数的指针。
`[in] aAppState`	指向调用 `StartTimer()` 时使用的应用状态对象的指针。

DispatchEvent

Error DispatchEvent(
  Event aEvent
)

这会分派指定事件，以便由此实例进行处理。

从事件中解组类型和参数由特定于平台的钩子进行处理，然后该钩子应回调至 Layer::HandleEvent 以进行实际调度。

详细信息

参数

[in] aEvent

要分派进行处理的针对具体平台的事件对象。

返回值

WEAVE_SYSTEM_NO_ERROR（如果成功）；否则，将出现指明初始化失败原因的具体错误。

DispatchEvents

Error DispatchEvents(
  void
)

这是特定于平台钩子的语法封装容器，该钩子影响事件循环，等待为该实例提供服务的队列，将事件从该队列中拉取，然后分派这些事件进行处理。

详细信息
返回值	WEAVE_SYSTEM_NO_ERROR（如果成功）；否则，将出现指明初始化失败原因的具体错误。

GetPlatformData

void * GetPlatformData(
  void
) const

这将返回分配给该实例的任何特定于客户端的平台数据（如果之前已设置）。

详细信息
返回值	特定于客户端的平台数据（如果之前已设置）；否则为 NULL。

HandleEvent

Error HandleEvent(
  Object & aTarget,
  EventType aEventType,
  uintptr_t aArgument
)

这样就可以实现 Weave System Layer 事件的实际调度和处理。

详细信息

参数

`[in,out] aTarget`	对事件所针对的图层对象的引用。
`[in] aEventType`	要处理的事件 / 消息类型。
`[in] aArgument`	与事件 / 消息关联的参数。

返回值

`WEAVE_SYSTEM_NO_ERROR`	成功时。
`WEAVE_SYSTEM_ERROR_UNEXPECTED_STATE`	InetLayer 对象的状态不正确。
`WEAVE_SYSTEM_ERROR_UNEXPECTED_EVENT`	事件类型无法识别时抛出。

HandlePlatformTimer

Error HandlePlatformTimer(
  void
)

处理平台计时器到期事件。

调用 nl::Weave::System::Timer::HandleExpiredTimers 来处理任何过期的计时器。假定仅在拥有 Weave System Layer 对象的线程上调用此 API。

详细信息
返回值	WEAVE_SYSTEM_NO_ERROR 表示成功，否则表示错误代码。

HandleSelectResult

void HandleSelectResult(
  int aSetSize,
  fd_set *aReadSet,
  fd_set *aWriteSet,
  fd_set *aExceptionSet
)

处理来自 select 调用的 I/O。

此方法会在每个活动端点中注册待处理的 I/O 事件，然后对这些端点调用相应的 I/O 处理函数。

详细信息

参数

`[in] aSetSize`	select 调用的返回值。
`[in] aReadSet`	指向读取文件描述符集的指针。
`[in] aWriteSet`	指向写入文件描述符集的指针。
`[in] aExceptionSet`	指向存在错误的文件描述符集的指针。

Init

Error Init(
  void *aContext
)

层

 Layer(
  void
)

NewTimer

Error NewTimer(
  Timer *& aTimerPtr
)

PostEvent

Error PostEvent(
  Object & aTarget,
  EventType aEventType,
  uintptr_t aArgument
)

这会将指定类型的事件 / 消息以及提供的参数发布到该实例的平台专用事件队列中。

详细信息

参数

`[in,out] aTarget`	指向发出 POST 请求的 Weave System Layer 对象的指针。
`[in] aEventType`	要发布的活动的类型。
`[in,out] aArgument`	与要发布的事件相关联的参数。

返回值

`WEAVE_SYSTEM_NO_ERROR`	成功时。
`WEAVE_SYSTEM_ERROR_UNEXPECTED_STATE`	Layer 对象的状态不正确时抛出该异常。
`WEAVE_SYSTEM_ERROR_NO_MEMORY`	如果事件队列已满。
`other`	生成特定于平台的错误，指明失败原因。

PrepareSelect

void PrepareSelect(
  int & aSetSize,
  fd_set *aReadSet,
  fd_set *aWriteSet,
  fd_set *aExceptionSet,
  struct timeval & aSleepTime
)

准备供 select() 使用的文件描述符集。

详细信息

参数

`[out] aSetSize`	文件描述符集中的文件描述符范围。
`[in] aReadSet`	指向一组可读文件描述符的指针。
`[in] aWriteSet`	指向可写入文件描述符集的指针。
`[in] aExceptionSet`	指向存在错误的文件描述符集的指针。
`[in] aSleepTime`	对最长休眠时间的引用。

ScheduleWork

Error ScheduleWork(
  TimerCompleteFunct aComplete,
  void *aAppState
)

安排一个签名与 TimerCompleteFunct 完全相同的函数，尽快在 Weave 线程上运行。

注意：此函数原则上可以实现为 StartTimer(0, aComplete, aAppState)。不过，SystemTimer 的规范允许执行某些可能导致该实现无法实现的优化。具体来说，SystemTimer API 只能从拥有特定 SystemLayer 的线程调用，而 ScheduleWork 可以从任何线程调用。此外，虽然 SystemTimer API 允许以内嵌方式调用已过期的处理程序，但 ScheduleWork 可保证仅在当前 Weave 事件完成后调用处理程序函数。

详细信息

参数

`[in] aComplete`	指向要触发此计时器时调用的回调函数的指针。
`[in] aAppState`	指向要作为参数传递给回调函数的应用状态对象的指针。

返回值

`WEAVE_SYSTEM_ERROR_UNEXPECTED_STATE`	如果 SystemLayer 尚未初始化。
`WEAVE_SYSTEM_ERROR_NO_MEMORY`	如果 SystemLayer 无法分配新计时器。
`WEAVE_SYSTEM_NO_ERROR`	成功时。

SetPlatformData

void SetPlatformData(
  void *aPlatformData
)

这会将指定的客户端特定平台数据设置为该实例，以供客户端平台稍后检索。

详细信息

参数

[in] aPlatformData

要设置的特定于客户端的平台数据。

关停

Error Shutdown(
  void
)

StartTimer

Error StartTimer(
  uint32_t aMilliseconds,
  TimerCompleteFunct aComplete,
  void *aAppState
)

此方法会启动单次计时器。

详细信息

参数

`[in] aMilliseconds`	到期时间（以毫秒为单位）。
`[in] aComplete`	指向计时器结束时调用的函数的指针。
`[in] aAppState`	指向计时器到期时使用的应用状态对象的指针。

返回值

WEAVE_SYSTEM_NO_ERROR 表示成功。

返回值

WEAVE_SYSTEM_ERROR_NO_MEMORY（如果无法分配计时器）。

返回值

指示计时器未能启动的其他值。

州

LayerState State(
  void
) const

该方法会返回图层对象的当前状态。

WakeSelect

void WakeSelect(
  void
)

使用 select() 将单个字节写入唤醒管道，以唤醒用于监控文件描述符的 I/O 线程。

注意：如果从 HandleSelectResult() 内调用 WakeSelect()，则可以跳过对唤醒管的写入操作，因为 I/O 线程已处于唤醒状态。此外，我们不在乎此次写入是否失败，因为唯一合理的可能失败是管道已满，在这种情况下，选择调用线程仍然会唤醒。

公共静态函数

GetClock_Monotonic

uint64_t GetClock_Monotonic(
  void
)

返回单调系统时间（以微秒为单位）。

此函数返回自平台定义的任意纪元以来经过的时间（以微秒为单位）。返回的值必定在系统重新启动之间不断增加（即从不换行）。此外，在不需要唤醒时重启的任何系统休眠模式期间，底层时间源保证会持续报时。

尽管某些平台可能会选择返回测量系统启动以来所经过时间的值，但应用不得依赖该值。此外，GetClock_Monotonic() 的周期不必与其他任何 GetClock... 函数的周期相同。因此，只能对同一函数返回的值执行相对时间计算。

该函数在任何使用线程处理的平台上都保证是线程安全的。

详细信息
返回值	自平台定义的任意周期以来所经过的时间（以微秒为单位）。

GetClock_MonotonicHiRes

uint64_t GetClock_MonotonicHiRes(
  void
)

返回（可能）高分辨率的单调系统时间（以微秒为单位）。

此函数返回自平台定义的任意纪元以来经过的时间（以微秒为单位）。返回的值必定在系统重新启动之间不断增加（即从不换行）。不过，在系统深度睡眠状态期间，底层计时器不需要持续计时。

某些平台可能会使用高分辨率计时器来实现 GetClock_MonotonicHiRes()，该计时器的精度要高于 GetClock_Monotonic()，并且不受渐进式时钟调整（偏差）的影响。没有此类计时器的系统可能直接返回与 GetClock_Monotonic() 相同的值。

GetClock_MonotonicHiRes() 返回的时间的周期不必与任何其他 GetClock... 函数（包括 GetClock_Monotonic()）的周期相同。

该函数在任何使用线程处理的平台上都保证是线程安全的。

详细信息
返回值	自平台定义的任意纪元以来经过的时间（以微秒为单位）。

GetClock_MonotonicMS

uint64_t GetClock_MonotonicMS(
  void
)

返回单调系统时间（以毫秒为单位）。

此函数返回自平台定义的任意周期以来经过的时间（以毫秒为单位）。返回的值必定在系统重新启动之间不断增加（即从不换行）。此外，在不需要唤醒时重启的任何系统休眠模式期间，底层时间源保证会持续报时。

该函数在任何使用线程处理的平台上都保证是线程安全的。

详细信息
返回值	自平台定义的任意周期起经过的时间（以毫秒为单位）。

GetClock_RealTime

Error GetClock_RealTime(
  uint64_t & curTime
)

以微秒 Unix 时间格式返回当前实际（民用）时间。

此方法返回本地平台对当前实时时间的概念，表示为以微秒为单位的 Unix 时间值。底层时钟至少以整秒（值为 1,000,000 秒）的速度报时，但在某些平台上可能会更快。

如果底层平台能够实时跟踪，但系统当前未同步，则 GetClock_RealTime() 将返回错误 WEAVE_SYSTEM_ERROR_REAL_TIME_NOT_SYNCED。

在无法进行实时跟踪的平台上，可能不会使用 GetClock_RealTime() 方法，从而导致引用它的所有应用出现链接错误。或者，此类平台可以提供始终返回错误 WEAVE_SYSTEM_ERROR_NOT_SUPPORTED 的 GetClock_RealTime() 实现。

该函数在任何使用线程处理的平台上都保证是线程安全的。

详细信息

参数

[out] curTime

当前时间，表示为以微秒为单位的 Unix 时间。

返回值

`WEAVE_SYSTEM_NO_ERROR`	如果方法执行成功。
`#WEAVE_SYSTEM_ERROR_REAL_TIME_NOT_SYNCED`	如果平台能够实时跟踪，但当前未同步。
`#WEAVE_SYSTEM_ERROR_NOT_SUPPORTED`	如果平台无法进行实时跟踪。

GetClock_RealTimeMS

Error GetClock_RealTimeMS(
  uint64_t & curTimeMS
)

以毫秒级 Unix 时间格式返回当前实际（民用）时间。

此方法返回本地平台对当前实时时间的概念，表示为扩展至毫秒的 Unix 时间值。底层时钟至少以整秒（值为 1,000,000 秒）的速度报时，但在某些平台上可能会更快。

如果底层平台能够实时跟踪，但系统当前未同步，则 GetClock_RealTimeMS() 将返回错误 WEAVE_SYSTEM_ERROR_REAL_TIME_NOT_SYNCED。

在无法进行实时跟踪的平台上，可能不会使用 GetClock_RealTimeMS() 方法，从而导致引用它的所有应用出现链接错误。或者，此类平台可以提供始终返回错误 WEAVE_SYSTEM_ERROR_NOT_SUPPORTED 的 GetClock_RealTimeMS() 的实现。

该函数在任何使用线程处理的平台上都保证是线程安全的。

详细信息

参数

[out] curTime

当前时间，表示为以毫秒为单位的 Unix 时间。

返回值

`WEAVE_SYSTEM_NO_ERROR`	如果方法执行成功。
`#WEAVE_SYSTEM_ERROR_REAL_TIME_NOT_SYNCED`	如果平台能够实时跟踪，但当前未同步。
`#WEAVE_SYSTEM_ERROR_NOT_SUPPORTED`	如果平台无法进行实时跟踪。

SetClock_RealTime

Error SetClock_RealTime(
  uint64_t newCurTime
)

设置平台对当前实际（民用）时间的概念。

应用可以调用此函数，以设置本地平台对当前实时的概念。新的当前时间表示为以微秒为单位的 Unix 时间值。

设置后，底层平台时钟会保证以至少整秒的粒度进行实时跟踪。

某些平台可能会限制哪些应用或进程可进行实时设置。如果调用方不允许进行实时更改，则 SetClock_RealTime() 函数将返回错误 WEAVE_SYSTEM_ERROR_ACCESS_DENIED。

在无法进行实时跟踪或不提供实时设置功能的平台上，可能会不存在 SetClock_RealTime() 函数，从而导致引用该函数的应用出现链接错误。或者，此类平台可以提供始终返回错误 WEAVE_SYSTEM_ERROR_NOT_SUPPORTED 的 SetClock_RealTime() 实现。

该函数在任何使用线程处理的平台上都保证是线程安全的。

详细信息

参数

[in] newCurTime

新的当前时间，表示为以微秒为单位的 Unix 时间。

返回值

`WEAVE_SYSTEM_NO_ERROR`	如果方法执行成功。
`#WEAVE_SYSTEM_ERROR_NOT_SUPPORTED`	如果平台无法进行实时跟踪。
`#WEAVE_SYSTEM_ERROR_ACCESS_DENIED`	如果发起调用的应用无权设置当前时间。

nl::Weave::System::Layer

摘要

构造函数和析构函数

公共类型

公共函数

公共静态函数

公共类型

EventHandler

TimerCompleteFunct

公共函数

AddEventHandlerDelegate

CancelTimer

DispatchEvent

DispatchEvents

GetPlatformData

HandleEvent

HandlePlatformTimer

HandleSelectResult

Init

层

NewTimer

PostEvent

PrepareSelect

ScheduleWork

SetPlatformData

关停

StartTimer

州

WakeSelect

公共静态函数

GetClock_Monotonic

GetClock_MonotonicHiRes

GetClock_MonotonicMS

GetClock_RealTime

GetClock_RealTimeMS

SetClock_RealTime