NL::编织::系统

概括

枚举

@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
}
枚举
一个的状态对象。

类型定义

Event nl::Weave::System::Event
所有 InetLayer 事件的基本对象。
EventType nl::Weave::System::EventType
所有 InetLayer 事件的基本类型。
LwIPEventHandlerFunction )(Object &aTarget, EventType aEventType, uintptr_t aArgument)类型定义
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
这实现了用于编织系统的内省功能,其允许呼叫者,以确定指定的错误是否是一个内部,底层LwIP的错误的错误。
IsErrorPOSIX (Error aError)
NL_DLL_EXPORT bool
这实现了用于编织系统的内省功能的错误,允许调用者确定指定的错误是否是一个内部,底层OS错误。
IsEventOfType (EventType aType)
bool
检查以验证 EventType 是否有效。
MapErrorLwIP (err_t aError)
NL_DLL_EXPORT Error
这实现了用于编织系统的映射函数错误,允许映射底层LwIP的网络堆栈误差引入一个与平台或系统特定的范围内。
MapErrorPOSIX (int aError)
NL_DLL_EXPORT Error
这实现了用于编织系统的映射函数错误,允许映射整数在底层POSIX网络和OS堆栈错误的数量空间分成与平台或系统特定的范围内。
RegisterLwIPErrorFormatter (void)
void
为 LwIP 错误注册文本错误格式化程序。
RegisterPOSIXErrorFormatter (void)
void
为 POSIX 错误注册一个文本错误格式化程序。
RegisterSystemLayerErrorFormatter (void)
void
注册系统文本错误格式的错误。

班级

NL ::编织::系统::层

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

NL ::编织::系统:: LwIPEventHandlerDelegate
NL ::编织::系统::互斥

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 ::编织::系统::对象

这表示从 ObjectPool 中包含的空间分配的引用计数对象目的。

NL ::编织::系统:: PacketBuffer

数据包缓冲区类是用于操作八位字节序列化数据数据包的核心结构,通常在数据通信网络的上下文中,如蓝牙或互联网协议。

NL ::编织::系统::定时器

这是一个内部类织系统,用于表示正在进行中的单次计时器。

结构

NL ::编织::系统:: LwIPEvent

工会

NL ::编织::系统:: ObjectArena

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

命名空间

NL ::编织::系统::平台
NL ::编织::系统::统计

枚举

@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

一个的状态对象。

特性
kLayerState_Initialized

初始化状态。

kLayerState_NotInitialized

未初始化状态。

类型定义

事件

WEAVE_SYSTEM_CONFIG_LWIP_EVENT_OBJECT_TYPE Event

所有 InetLayer 事件的基本对象。

这被定义为特定于平台或系统的类型。

事件类型

WEAVE_SYSTEM_CONFIG_LWIP_EVENT_TYPE EventType

所有 InetLayer 事件的基本类型。

这被定义为特定于平台或系统的类型。

LwIPEventHandler 函数

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

职能

描述错误LwIP

NL_DLL_EXPORT const char * DescribeErrorLwIP(
  Error aError
)

这实现了一个函数来返回一个以 NULL 结尾的 LwIP 特定的描述性 C 字符串,与指定的映射 LwIP 错误相关联。

细节
参数
[in] err
要描述的映射 LwIP 特定错误。
退货
以 NULL 结尾的、特定于 LwIP 的描述性 C 字符串,用于描述错误。

描述错误POSIX

NL_DLL_EXPORT const char * DescribeErrorPOSIX(
  Error aError
)

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

细节
参数
[in] err
要描述的映射的特定于操作系统的错误。
退货
以 NULL 结尾的、特定于操作系统的描述性 C 字符串,用于描述错误。

格式LwIP错误

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

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

细节
参数
[in] buf
将放置错误字符串的缓冲区。
[in] bufSize
提供的缓冲区的大小(以字节为单位)。
[in] err
要描述的错误。
退货
如果将描述字符串写入提供的缓冲区,则为 true。
退货
false 如果提供的错误不是 LwIP 错误。

格式POSIX错误

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

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

细节
参数
[in] buf
将放置错误字符串的缓冲区。
[in] bufSize
提供的缓冲区的大小(以字节为单位)。
[in] err
要描述的错误。
退货
如果将描述字符串写入提供的缓冲区,则为 true。
退货
false 如果提供的错误不是 POSIX 错误。

格式系统层错误

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

给定一个系统错误,则返回一个描述错误的人类可读的NULL终止的C字符串。

细节
参数
[in] buf
将放置错误字符串的缓冲区。
[in] bufSize
提供的缓冲区的大小(以字节为单位)。
[in] err
要描述的错误。
退货
如果描述字符串已写入提供的缓冲区,则为 true。
退货
假如果提供的错误不是一个系统错误。

IsErrorLwIP

NL_DLL_EXPORT bool IsErrorLwIP(
  Error aError
)

这实现了用于编织系统的内省功能,其允许呼叫者,以确定指定的错误是否是一个内部,底层LwIP的错误的错误。

细节
参数
[in] err
确定是否为 LwIP 错误的映射错误。
退货
如果指定的错误是 LwIP 错误,则为真;否则为假。

错误POSIX

NL_DLL_EXPORT bool IsErrorPOSIX(
  Error aError
)

这实现了用于编织系统的内省功能的错误,允许调用者确定指定的错误是否是一个内部,底层OS错误。

细节
参数
[in] err
映射错误以确定它是否是操作系统错误。
退货
如果指定的错误是操作系统错误,则为真;否则为假。

事件类型

bool IsEventOfType(
  EventType aType
)

检查以验证 EventType 是否有效。

细节
参数
[in] aEventType
织制事件类型。
退货
如果它落在枚举范围内,则为真;否则为假。

地图错误LwIP

NL_DLL_EXPORT Error MapErrorLwIP(
  err_t aError
)

这实现了用于编织系统的映射函数错误,允许映射底层LwIP的网络堆栈误差引入一个与平台或系统特定的范围内。

细节
参数
[in] e
要映射的 LwIP 错误。
退货
映射的 LwIP 网络或操作系统错误。

地图错误POSIX

NL_DLL_EXPORT Error MapErrorPOSIX(
  int aError
)

这实现了用于编织系统的映射函数错误,允许映射整数在底层POSIX网络和OS堆栈错误的数量空间分成与平台或系统特定的范围内。

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

细节
参数
[in] e
要映射的 POSIX 网络或操作系统错误。
退货
映射的 POSIX 网络或操作系统错误。

注册LwIPErrorFormatter

void RegisterLwIPErrorFormatter(
  void
)

为 LwIP 错误注册文本错误格式化程序。

注册POSIXErrorFormatter

void RegisterPOSIXErrorFormatter(
  void
)

为 POSIX 错误注册一个文本错误格式化程序。

注册系统层错误格式器

void RegisterSystemLayerErrorFormatter(
  void
)

注册系统文本错误格式的错误。