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 エラーに関連づけられ、OS 固有の記述的な C 文字列を NULL で終わる関数が実装されます。
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 システム レイヤエラーのイントロスペクション関数が実装されます。これにより、呼び出し元は、指定されたエラーが基盤となる内部 OS のエラーかどうかを判断できます。
IsEventOfType(EventType aType)
bool
EventType が有効なものかどうかを確認します。
MapErrorLwIP(err_t aError)
NL_DLL_EXPORT Error
これにより、Weave システム レイヤエラーのマッピング関数が実装されます。これにより、基盤となる 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=""> に含まれる空間から割り当てられた参照カウント オブジェクトを表します。渡されます。&lt;/t,&gt;
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.

名前空間
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

System Layer のスレッドで作業をスケジュールするためのイベント。

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 文字列を返します。

詳細
パラメータ
[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 システム レイヤエラーのイントロスペクション関数が実装されます。これにより、呼び出し元は、指定されたエラーが内部の基盤となる 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 システム レイヤエラーのマッピング関数が実装されます。これにより、基盤となる 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
)

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