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 系统层错误实现一个自省函数，该函数可让调用方确定指定的错误是否属于内部底层 LwIP 错误。
IsErrorPOSIX(Error aError)
NL_DLL_EXPORT bool
这会针对 Weave 系统层错误实现一个内省函数，该函数可让调用方确定指定的错误是否属于内部底层操作系统错误。
IsEventOfType(EventType aType)
bool
检查以确认 EventType 是否有效。
MapErrorLwIP(err_t aError)
NL_DLL_EXPORT Error
这会为 Weave System Layer 错误实现一项映射功能，以便将底层 LwIP 网络堆栈错误映射到特定于平台或系统的范围。
MapErrorPOSIX(int aError)
NL_DLL_EXPORT Error
这会针对 Weave 系统层错误实现一个映射函数，从而允许将底层 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=""> 中包含的空间分配的引用计数对象对象。&lt;/t,&gt;
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。
返回值
false 如果提供的错误不是 LwIP 错误。

FormatPOSIXError

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

给定 POSIX 错误，返回一个人类可读、以 NULL 结尾的 C 字符串来描述错误。

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

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 系统层错误实现一个自省函数，该函数可让调用方确定指定的错误是否属于内部底层 LwIP 错误。

详细信息
参数
[in] err
用于确定是否是 LwIP 错误的映射错误。
返回值
如果指定的错误是 LwIP 错误，则为 true；否则为 false。

IsErrorPOSIX

NL_DLL_EXPORT bool IsErrorPOSIX(
  Error aError
)

这会针对 Weave 系统层错误实现一个自省函数，该函数可让调用方确定指定的错误是否属于内部底层操作系统错误。

详细信息
参数
[in] err
映射的错误，用于确定是否属于操作系统错误。
返回值
如果指定的错误是操作系统错误，则为 true；否则为 false。

IsEventOfType

bool IsEventOfType(
  EventType aType
)

检查以确认 EventType 是否有效。

详细信息
参数
[in] aEventType
Weave 系统图层事件类型。
返回值
如果它在枚举范围内，则为 true；否则为 false。

MapErrorLwIP

NL_DLL_EXPORT Error MapErrorLwIP(
  err_t aError
)

这会为 Weave System Layer 错误实现一项映射功能，以便将底层 LwIP 网络堆栈错误映射到特定于平台或系统的范围。

详细信息
参数
[in] e
要映射的 LwIP 错误。
返回值
映射的 LwIP 网络或操作系统错误。

MapErrorPOSIX

NL_DLL_EXPORT Error MapErrorPOSIX(
  int aError
)

这会针对 Weave 系统层错误实现一个映射函数，从而允许将底层 POSIX 网络和操作系统堆栈错误的数量空间中的整数映射到特定于平台或系统的范围。

超出 POSIX 或 ISO C/C++ 标准当前定义的错误代码的映射与标准代码类似。

详细信息
参数
[in] e
要映射的 POSIX 网络或操作系统错误。
返回值
映射的 POSIX 网络或操作系统错误。

RegisterLwIPErrorFormatter

void RegisterLwIPErrorFormatter(
  void
)

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

RegisterPOSIXErrorFormatter

void RegisterPOSIXErrorFormatter(
  void
)

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

RegisterSystemLayerErrorFormatter

void RegisterSystemLayerErrorFormatter(
  void
)

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