nl::Weave::System

概要

列挙型
@18{
  kTimerFactor_micro_per_milli = 1000,
  kTimerFactor_milli_per_unit = 1000,
  kTimerFactor_nano_per_milli = 1000000,
  kTimerFactor_micro_per_unit = 1000000
} 		enum
@19{
  kEvent_ReleaseObj = _WEAVE_SYSTEM_CONFIG_LWIP_EVENT(0),
  kEvent_ScheduleWork = _WEAVE_SYSTEM_CONFIG_LWIP_EVENT(1)
} 		enum
Inet レイヤのイベントタイプの定義。
LayerState{
  kLayerState_NotInitialized = 0,
  kLayerState_Initialized = 1
} 		enum
Layer オブジェクトの状態。

Typedef
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 *
これは、マッピングされた指定された LwIP エラーに関連付けられた、NULL で終端した LwIP 固有の C 文字列を返す関数を実装します。
DescribeErrorPOSIX(Error aError)
NL_DLL_EXPORT const char *
これは、マッピングされた指定された OS エラーに関連付けられた、NULL で終了する OS 固有の C 文字列を返す関数を実装します。
FormatLwIPError(char *buf, uint16_t bufSize, int32_t err)
bool
LwIP エラーが発生すると、人が読める形式の NULL 終了 C 文字列でエラーを説明する C 文字列が返されます。
FormatPOSIXError(char *buf, uint16_t bufSize, int32_t err)
bool
POSIX エラーが発生すると、人が読める形式の NULL 終了 C 文字列でエラーを説明する C 文字列が返されます。
FormatSystemLayerError(char *buf, uint16_t bufSize, int32_t err)
bool
システムレイヤエラーが発生した場合は、エラーを説明する、人が読める形式の NULL 終了 C 文字列を返します。
IsErrorLwIP(Error aError)
NL_DLL_EXPORT bool
これにより、Weave システムの Layer エラーのイントロスペクション関数が実装され、呼び出し元は、指定されたエラーが内部の基盤となる LwIP エラーであるかどうかを判定できるようになります。
IsErrorPOSIX(Error aError)
NL_DLL_EXPORT bool
これにより、Weave システムのレイヤエラーのイントロスペクション関数が実装されています。これにより、呼び出し元は指定されたエラーが内部の基盤となる OS エラーであるかどうかを判定できます。
IsEventOfType(EventType aType)
bool
EventType が有効なものかどうかを確認してください。
MapErrorLwIP(err_t aError)
NL_DLL_EXPORT Error
これにより、Weave システムの Layer エラーのマッピング関数が実装されます。これにより、基盤となる LwIP ネットワーク スタックのエラーをプラットフォームまたはシステム固有の範囲にマッピングできます。
MapErrorPOSIX(int aError)
NL_DLL_EXPORT Error
これにより、Weave システム レイヤエラーのマッピング関数が実装されます。これにより、基盤となる POSIX ネットワークの数値空間内の整数と OS スタックのエラーを、プラットフォームまたはシステム固有の範囲にマッピングできます。
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

パケット バッファクラスは、オクテットシリアル化されたデータのパケットを操作するために使用されるコア構造であり、通常は Bluetooth やインターネット プロトコルなどのデータ通信ネットワークのコンテキストで使用されています。
nl::Weave::System::Timer

これは Weave システム レイヤの内部クラスで、進行中のワンショット タイマーを表すために使用されます。

構造体
nl::Weave::System::LwIPEvent

共用体
nl::Weave::System::ObjectArena 

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

Namespace
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

1 秒あたりのミリ秒数。

@19

 @19

Inet レイヤのイベントタイプの定義。

プロパティ
kEvent_ReleaseObj

SystemLayer オブジェクトのドロップのイベント。
kEvent_ScheduleWork

作業をスケジューリングするためのイベントは、システム レイヤのスレッドで発生します。

LayerState

 LayerState

Layer オブジェクトの状態。

プロパティ
kLayerState_Initialized

初期化された状態。
kLayerState_NotInitialized

初期化されていない状態。

Typedef

イベント

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
)

これは、マッピングされた指定された LwIP エラーに関連付けられた、NULL で終端した LwIP 固有の C 文字列を返す関数を実装します。

詳細
パラメータ
[in] err
説明するマッピングされた LwIP 固有のエラー。
戻り値
エラーを説明する、NULL で終わる LwIP 固有の記述的な C 文字列。

DescribeErrorPOSIX

NL_DLL_EXPORT const char * DescribeErrorPOSIX(
  Error aError
)

これは、マッピングされた指定された OS エラーに関連付けられた、NULL で終了する OS 固有の C 文字列を返す関数を実装します。

詳細
パラメータ
[in] err
説明するマッピングされた OS 固有のエラー。
戻り値
NULL で終了する、エラーを説明する OS 固有の C 文字列。

FormatLwIPError

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

LwIP エラーが発生すると、人が読める形式の NULL 終了 C 文字列でエラーを説明する C 文字列が返されます。

詳細
パラメータ
[in] buf
エラー文字列が配置されるバッファ。
[in] bufSize
指定されたバッファのサイズ（バイト単位）。
[in] err
説明するエラー。
戻り値
指定されたバッファに description 文字列が書き込まれた場合は true。
戻り値
false - 提供されたエラーが LwIP エラーではなかった場合。

FormatPOSIXError

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

POSIX エラーが発生すると、人が読める形式の NULL 終了 C 文字列でエラーを説明する C 文字列が返されます。

詳細
パラメータ
[in] buf
エラー文字列が配置されるバッファ。
[in] bufSize
指定されたバッファのサイズ（バイト単位）。
[in] err
説明するエラー。
戻り値
指定されたバッファに description 文字列が書き込まれた場合は true。
戻り値
false - 提供されたエラーが POSIX エラーではなかった場合。

FormatSystemLayerError

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

システムレイヤエラーが発生した場合は、エラーを説明する、人が読める形式の NULL 終了 C 文字列を返します。

詳細
パラメータ
[in] buf
エラー文字列が配置されるバッファ。
[in] bufSize
指定されたバッファのサイズ（バイト単位）。
[in] err
説明するエラー。
戻り値
指定されたバッファに description 文字列が書き込まれた場合は true。
戻り値
false - 提供されたエラーがシステムレイヤエラーではなかった場合。

IsErrorLwIP

NL_DLL_EXPORT bool IsErrorLwIP(
  Error aError
)

これにより、Weave システムの Layer エラーのイントロスペクション関数が実装され、呼び出し元は、指定されたエラーが内部の基盤となる LwIP エラーであるかどうかを判定できるようになります。

詳細
パラメータ
[in] err
LwIP エラーかどうかを判断するためのマッピングされたエラー。
戻り値
指定されたエラーが LwIP エラーの場合は true、そうでない場合は false です。

IsErrorPOSIX

NL_DLL_EXPORT bool IsErrorPOSIX(
  Error aError
)

これにより、Weave システムのレイヤエラーのイントロスペクション関数が実装されています。これにより、呼び出し元は指定されたエラーが内部の基盤となる OS エラーであるかどうかを判定できます。

詳細
パラメータ
[in] err
OS エラーかどうかを判断するためにマッピングされたエラー。
戻り値
指定されたエラーが OS エラーの場合は true、それ以外の場合は false です。

IsEventOfType

bool IsEventOfType(
  EventType aType
)

EventType が有効なものかどうかを確認してください。

詳細
パラメータ
[in] aEventType
Weave システムレイヤのイベントタイプ。
戻り値
列挙範囲内にある場合は true、そうでない場合は false です。

MapErrorLwIP

NL_DLL_EXPORT Error MapErrorLwIP(
  err_t aError
)

これにより、Weave システムの Layer エラーのマッピング関数が実装されます。これにより、基盤となる LwIP ネットワーク スタックのエラーをプラットフォームまたはシステム固有の範囲にマッピングできます。

詳細
パラメータ
[in] e
マッピングする LwIP エラー。
戻り値
マッピングされた LwIP ネットワークまたは OS エラー。

MapErrorPOSIX

NL_DLL_EXPORT Error MapErrorPOSIX(
  int aError
)

これにより、Weave システム レイヤエラーのマッピング関数が実装されます。これにより、基盤となる POSIX ネットワークの数値空間内の整数と OS スタックのエラーを、プラットフォームまたはシステム固有の範囲にマッピングできます。

POSIX や ISO C/C++ 標準で定義されている以外のエラーコードも、標準のエラーコードと同様にマッピングされます。

詳細
パラメータ
[in] e
マッピングする POSIX ネットワークまたは OS エラー。
戻り値
マッピングされた POSIX ネットワークまたは OS エラー。

RegisterLwIPErrorFormatter

void RegisterLwIPErrorFormatter(
  void
)

LwIP エラーのテキストエラー フォーマッタを登録します。

RegisterPOSIXErrorFormatter

void RegisterPOSIXErrorFormatter(
  void
)

POSIX エラーのテキストエラー フォーマッタを登録します。

RegisterSystemLayerErrorFormatter

void RegisterSystemLayerErrorFormatter(
  void
)

システムレイヤエラーのテキストエラー フォーマッタを登録します。