nl::Weave::System

摘要

枚举
@18{
  kTimerFactor_micro_per_milli = 1000,
  kTimerFactor_milli_per_unit = 1000,
  kTimerFactor_nano_per_milli = 1000000,
  kTimerFactor_micro_per_unit = 1000000
} 		枚举
@19{
  kEvent_ReleaseObj = _WEAVE_SYSTEM_CONFIG_LWIP_EVENT(0),
  kEvent_ScheduleWork = _WEAVE_SYSTEM_CONFIG_LWIP_EVENT(1)
} 		枚举
Inet 层事件类型定义。
LayerState{
  kLayerState_NotInitialized = 0,
  kLayerState_Initialized = 1
} 		枚举
Layer 对象的状态。

类型定义符
Event nl::Weave::System::Event
所有 InetLayer 事件的基本对象。
EventType nl::Weave::System::EventType
所有 InetLayer 事件的基本类型。
LwIPEventHandlerFunction)(Object &aTarget, EventType aEventType, uintptr_t aArgument) typedef
Error(*

函数
DescribeErrorLwIP(Error aError)
NL_DLL_EXPORT const char *
这会实现一个函数，以返回以 NULL 结尾的 LwIP 专用的描述性 C 字符串，该字符串与指定的已映射 LwIP 错误相关联。
DescribeErrorPOSIX(Error aError)
NL_DLL_EXPORT const char *
该函数会实现一个函数，以返回以 NULL 结尾的特定于操作系统的描述性 C 字符串，该字符串与指定的已映射操作系统错误相关联。
FormatLwIPError(char *buf, uint16_t bufSize, int32_t err)
bool
如果出现 LwIP 错误，则返回直观易懂的以 NULL 结尾的 C 字符串，以描述错误。
FormatPOSIXError(char *buf, uint16_t bufSize, int32_t err)
bool
如果存在 POSIX 错误，则返回直观易懂的以 NULL 结尾的 C 字符串，用于描述错误。
FormatSystemLayerError(char *buf, uint16_t bufSize, int32_t err)
bool
如果出现系统层错误，则返回直观易懂的以 NULL 结尾的 C 字符串，用于描述错误。
IsErrorLwIP(Error aError)
NL_DLL_EXPORT bool
这会针对 Weave System Layer 错误实现内省函数，使调用方能够确定指定的错误是否为内部底层 LwIP 错误。
IsErrorPOSIX(Error aError)
NL_DLL_EXPORT bool
这会针对 Weave System Layer 错误实现内省函数，使调用方能够确定指定的错误是否为内部底层操作系统错误。
IsEventOfType(EventType aType)
bool
检查验证 EventType 是否有效。
MapErrorLwIP(err_t aError)
NL_DLL_EXPORT Error
这样可以针对 Weave 系统图层错误实现映射函数，从而将底层 LwIP 网络堆栈错误映射到特定于平台或系统的范围。
MapErrorPOSIX(int aError)
NL_DLL_EXPORT Error
这样可以针对 Weave System Layer 错误实现映射函数，从而将底层 POSIX 网络数字空间中的整数和操作系统堆栈错误映射到特定于平台或系统的范围。
RegisterLwIPErrorFormatter(void)
void
针对 LwIP 错误注册文本错误格式设置工具。
RegisterPOSIXErrorFormatter(void)
void
针对 POSIX 错误注册文本错误格式设置工具。
RegisterSystemLayerErrorFormatter(void)
void
针对系统层错误注册文本错误格式设置工具。

类
nl::Weave::System::Layer 

This provides access to timers according to the configured event handling model.
nl::Weave::System::LwIPEventHandlerDelegate
nl::Weave::System::Mutex 

This class represents a simple mutual exclusion lock used on platforms with preemptively scheduled multi-threaded
programming environments, for example, POSIX threads and FreeRTOS.
nl::Weave::System::Object

这表示从 ObjectPool<t, n=""> 对象中包含的空间分配的引用计数对象。</t,>
nl::Weave::System::PacketBuffer

数据包缓冲区类是用于操控八位字节序列化数据数据包的核心结构，通常用于数据通信网络，如蓝牙或互联网协议。
nl::Weave::System::Timer

它是 Weave System Layer 的内部类，用于表示进行中的单发计时器。

结构体
nl::Weave::System::LwIPEvent

联合体
nl::Weave::System::ObjectArena 

A union template used for representing a well-aligned block of memory.

命名空间
nl::Weave::System::Platform
nl::Weave::System::Stats

枚举

@18

 @18
属性
kTimerFactor_micro_per_milli

纳秒（以微秒为单位）。
kTimerFactor_micro_per_unit

一毫秒中的纳秒时间。
kTimerFactor_milli_per_unit

一毫秒中的微秒数。
kTimerFactor_nano_per_milli

每秒的毫秒数。

@19

 @19

Inet 层事件类型定义。

属性
kEvent_ReleaseObj

SystemLayer 对象的放下事件。
kEvent_ScheduleWork

用于在系统层的线程上调度工作的事件。

LayerState

 LayerState

Layer 对象的状态。

属性
kLayerState_Initialized

初始化状态。
kLayerState_NotInitialized

未初始化状态。

类型定义符

事件

WEAVE_SYSTEM_CONFIG_LWIP_EVENT_OBJECT_TYPE Event

所有 InetLayer 事件的基本对象。

此字段被定义为特定于平台或系统的类型。

EventType

WEAVE_SYSTEM_CONFIG_LWIP_EVENT_TYPE EventType

所有 InetLayer 事件的基本类型。

此字段被定义为特定于平台或系统的类型。

LwIPEventHandlerFunction

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

函数

DescribeErrorLwIP

NL_DLL_EXPORT const char * DescribeErrorLwIP(
  Error aError
)

这会实现一个函数，以返回以 NULL 结尾的 LwIP 专用的描述性 C 字符串，该字符串与指定的已映射 LwIP 错误相关联。

具体说明
参数
[in] err
要描述的映射的 LwIP 特定错误。
返回值
以 NULL 结尾且特定于 LwIP 的描述性 C 字符串，用于描述错误。

DescribeErrorPOSIX

NL_DLL_EXPORT const char * DescribeErrorPOSIX(
  Error aError
)

该函数会实现一个函数，以返回以 NULL 结尾的特定于操作系统的描述性 C 字符串，该字符串与指定的已映射操作系统错误相关联。

具体说明
参数
[in] err
要描述的映射的特定于操作系统的错误。
返回值
以 NULL 结尾、特定于操作系统的描述性 C 字符串，用于描述错误。

FormatLwIPError

bool FormatLwIPError(
  char *buf,
  uint16_t bufSize,
  int32_t err
)

如果出现 LwIP 错误，则返回直观易懂的以 NULL 结尾的 C 字符串，以描述错误。

具体说明
参数
[in] buf
将在其中放入错误字符串的缓冲区。
[in] bufSize
所提供缓冲区的大小（以字节为单位）。
[in] err
要描述的错误。
返回值
如果说明字符串已写入所提供的缓冲区，则返回 true。
返回值
如果提供的错误不是 LwIP 错误，则返回 false。

FormatPOSIXError

bool FormatPOSIXError(
  char *buf,
  uint16_t bufSize,
  int32_t err
)

如果存在 POSIX 错误，则返回直观易懂的以 NULL 结尾的 C 字符串，用于描述错误。

具体说明
参数
[in] buf
将在其中放入错误字符串的缓冲区。
[in] bufSize
所提供缓冲区的大小（以字节为单位）。
[in] err
要描述的错误。
返回值
如果说明字符串已写入所提供的缓冲区，则返回 true。
返回值
如果提供的错误不是 POSIX 错误，则返回 false。

FormatSystemLayerError

bool FormatSystemLayerError(
  char *buf,
  uint16_t bufSize,
  int32_t err
)

如果出现系统层错误，则返回直观易懂的以 NULL 结尾的 C 字符串，用于描述错误。

具体说明
参数
[in] buf
将在其中放入错误字符串的缓冲区。
[in] bufSize
所提供缓冲区的大小（以字节为单位）。
[in] err
要描述的错误。
返回值
如果说明字符串已写入所提供的缓冲区，则返回 true。
返回值
如果提供的错误不是系统层错误，则为 false。

IsErrorLwIP

NL_DLL_EXPORT bool IsErrorLwIP(
  Error aError
)

这会针对 Weave System Layer 错误实现内省函数，使调用方能够确定指定的错误是否为内部底层 LwIP 错误。

具体说明
参数
[in] err
用于确定是否是 LwIP 错误的映射错误。
返回值
如果指定的错误为 LwIP 错误，则为 true；否则为 false。

IsErrorPOSIX

NL_DLL_EXPORT bool IsErrorPOSIX(
  Error aError
)

这会针对 Weave System Layer 错误实现内省函数，使调用方能够确定指定的错误是否为内部底层操作系统错误。

具体说明
参数
[in] err
映射错误，用于确定是否是由操作系统错误造成的。
返回值
如果指定的错误为操作系统错误，则为 true；否则为 false。

IsEventOfType

bool IsEventOfType(
  EventType aType
)

检查验证 EventType 是否有效。

具体说明
参数
[in] aEventType
Weave 系统 Layer 事件类型。
返回值
如果值在枚举范围内，则为 true；否则为 false。

MapErrorLwIP

NL_DLL_EXPORT Error MapErrorLwIP(
  err_t aError
)

这样可以针对 Weave 系统图层错误实现映射函数，从而将底层 LwIP 网络堆栈错误映射到特定于平台或系统的范围。

具体说明
参数
[in] e
要映射的 LwIP 错误。
返回值
映射的 LwIP 网络或操作系统错误。

MapErrorPOSIX

NL_DLL_EXPORT Error MapErrorPOSIX(
  int aError
)

这样可以针对 Weave System Layer 错误实现映射函数，从而将底层 POSIX 网络数字空间中的整数和操作系统堆栈错误映射到特定于平台或系统的范围。

除了目前由 POSIX 或 ISO C/C++ 标准定义的错误代码之外，错误代码的映射与标准代码类似。

具体说明
参数
[in] e
要映射的 POSIX 网络或操作系统错误。
返回值
映射的 POSIX 网络或操作系统错误。

RegisterLwIPErrorFormatter

void RegisterLwIPErrorFormatter(
  void
)

针对 LwIP 错误注册文本错误格式设置工具。

RegisterPOSIXErrorFormatter

void RegisterPOSIXErrorFormatter(
  void
)

针对 POSIX 错误注册文本错误格式设置工具。

RegisterSystemLayerErrorFormatter

void RegisterSystemLayerErrorFormatter(
  void
)

针对系统层错误注册文本错误格式设置工具。