nl::Weave::System::Layer

#include <src/system/SystemLayer.h> 

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

概要

WEAVE_SYSTEM_CONFIG_USE_SOCKETS の場合、イベントの準備状況の通知は、プラットフォーム アダプテーションでの従来のアンケート/選択の実装を介して処理されます。

WEAVE_SYSTEM_CONFIG_USE_LWIP の場合、イベントの準備状況通知は、イベント / メッセージと、イベント/メッセージ システム用のプラットフォームおよびシステム固有のフックを介して処理されます。

コンストラクタとデストラクタ
Layer(void)

公開タイプ
EventHandler)(Object &aTarget, EventType aEventType, uintptr_t aArgument) typedef
Error(*
TimerCompleteFunct)(Layer *aLayer, void *aAppState, Error aError) typedef
void(*

パブリック関数
AddEventHandlerDelegate(LwIPEventHandlerDelegate & aDelegate)
Error
これにより、イベント ハンドラのデリゲートがシステム層に追加され、LwIP イベントを処理する能力が拡張されます。
CancelTimer(TimerCompleteFunct aOnComplete, void *aAppState)
void
このメソッドは、以前に StartTimer() で開始されたワンショット タイマーをキャンセルします。
DispatchEvent(Event aEvent)
Error
これにより、このインスタンスで処理するために、指定されたイベントがディスパッチされます。
DispatchEvents(void)
Error
これは、イベントループを発生させ、このインスタンスにサービスを提供するキューで待機し、そのキューからイベントを pull して処理のためにイベントをディスパッチする、プラットフォーム固有のフックの構文ラッパーです。
GetPlatformData(void) const
void *
これにより、インスタンスに割り当てられているクライアント固有のプラットフォーム データが返されます（すでに設定されている場合）。
HandleEvent(Object & aTarget, EventType aEventType, uintptr_t aArgument)
Error
これにより、Weave システム レイヤ イベントの実際のディスパッチと処理が実装されます。
HandlePlatformTimer(void)
Error
プラットフォーム タイマーの有効期限イベントを処理します。
HandleSelectResult(int aSetSize, fd_set *aReadSet, fd_set *aWriteSet, fd_set *aExceptionSet)
void
select 呼び出しからの I/O を処理します。
Init(void *aContext)
Error
NewTimer(Timer *& aTimerPtr)
Error
PostEvent(Object & aTarget, EventType aEventType, uintptr_t aArgument)
Error
このメソッドは、指定された引数を使用して、指定されたタイプのイベント / メッセージを、このインスタンスのプラットフォーム固有のイベントキューに送信します。
PrepareSelect(int & aSetSize, fd_set *aReadSet, fd_set *aWriteSet, fd_set *aExceptionSet, struct timeval & aSleepTime)
void
select() で使用するファイル記述子のセットを準備します。
ScheduleWork(TimerCompleteFunct aComplete, void *aAppState)
Error
TimerCompleteFunct と同一のシグネチャを持つ関数が、できるだけ早く Weave スレッドで実行されるようにスケジュールします。
SetPlatformData(void *aPlatformData)
void
これにより、指定されたクライアント固有のプラットフォーム データがインスタンスに設定され、後でクライアント プラットフォームで取得できるようになります。
Shutdown(void)
Error
StartTimer(uint32_t aMilliseconds, TimerCompleteFunct aComplete, void *aAppState)
Error
このメソッドは、ワンショット タイマーを開始します。
State(void) const
LayerState
レイヤ オブジェクトの現在の状態を返します。
WakeSelect(void)
void
select() を使用してウェイク パイプに 1 バイトを書き込み、ファイル記述子をモニタリングする I/O スレッドを復帰させます。

静的パブリック関数
GetClock_Monotonic(void)
uint64_t
マイクロ秒単位の単調なシステム時間を返します。
GetClock_MonotonicHiRes(void)
uint64_t
（潜在的に）高解像度の単調なシステム時間をマイクロ秒単位で返します。
GetClock_MonotonicMS(void)
uint64_t
単調なシステム時間をミリ秒単位で返します。
GetClock_RealTime(uint64_t & curTime)
Error
現在の実（常用）時刻をマイクロ秒単位の Unix 時間形式で返します。
GetClock_RealTimeMS(uint64_t & curTimeMS)
Error
現在の実（常用）時刻をミリ秒単位の Unix 時間形式で返します。
SetClock_RealTime(uint64_t newCurTime)
Error
プラットフォームの現在の実（常用）時間の概念を設定します。

公開タイプ

EventHandler

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

TimerCompleteFunct

void(* TimerCompleteFunct)(Layer *aLayer, void *aAppState, Error aError)

パブリック関数

AddEventHandlerDelegate

Error AddEventHandlerDelegate(
  LwIPEventHandlerDelegate & aDelegate
)

これにより、イベント ハンドラのデリゲートがシステム層に追加され、LwIP イベントを処理する能力が拡張されます。

詳細
パラメータ
[in] aDelegate
初期化されていない LwIP イベント ハンドラの委任構造
戻り値
WEAVE_SYSTEM_NO_ERROR
成功時。
WEAVE_SYSTEM_ERROR_BAD_ARGS
aDelegate に含まれる関数ポインタが NULL の場合

CancelTimer

void CancelTimer(
  TimerCompleteFunct aOnComplete,
  void *aAppState
)

このメソッドは、以前に StartTimer() で開始されたワンショット タイマーをキャンセルします。

詳細
パラメータ
[in] aOnComplete
StartTimer() の呼び出しで使用されるコールバック関数へのポインタ。
[in] aAppState
StartTimer() の呼び出しで使用されるアプリケーション状態オブジェクトへのポインタ。

DispatchEvent

Error DispatchEvent(
  Event aEvent
)

これにより、このインスタンスで処理するために、指定されたイベントがディスパッチされます。

イベントからの型と引数のマーシャリング解除は、プラットフォーム固有のフックによって処理され、その後、実際のディスパッチのために Layer::HandleEvent にコールバックする必要があります。

詳細
パラメータ
[in] aEvent
処理のためにディスパッチするプラットフォーム固有のイベント オブジェクト。
戻り値
成功すると WEAVE_SYSTEM_NO_ERROR。それ以外の場合は、初期化が失敗した理由を示す特定のエラー。

DispatchEvents

Error DispatchEvents(
  void
)

これは、イベントループを発生させ、このインスタンスにサービスを提供するキューで待機し、そのキューからイベントを pull して処理のためにイベントをディスパッチする、プラットフォーム固有のフックの構文ラッパーです。

詳細
戻り値
成功すると WEAVE_SYSTEM_NO_ERROR。それ以外の場合は、初期化が失敗した理由を示す特定のエラー。

GetPlatformData

void * GetPlatformData(
  void
) const

これにより、インスタンスに割り当てられているクライアント固有のプラットフォーム データが返されます（すでに設定されている場合）。

詳細
戻り値
クライアント固有のプラットフォーム データ（すでに設定されている場合）それ以外の場合は NULL を返します。

HandleEvent

Error HandleEvent(
  Object & aTarget,
  EventType aEventType,
  uintptr_t aArgument
)

これにより、Weave システム レイヤ イベントの実際のディスパッチと処理が実装されます。

詳細
パラメータ
[in,out] aTarget
イベントのターゲットとなるレイヤ オブジェクトへの参照。
[in] aEventType
処理するイベント / メッセージのタイプ。
[in] aArgument
イベントやメッセージに関連付けられた引数。
戻り値
WEAVE_SYSTEM_NO_ERROR
成功時。
WEAVE_SYSTEM_ERROR_UNEXPECTED_STATE
InetLayer オブジェクトの状態が正しくない場合。
WEAVE_SYSTEM_ERROR_UNEXPECTED_EVENT
イベントタイプを認識できない場合。

HandlePlatformTimer

Error HandlePlatformTimer(
  void
)

プラットフォーム タイマーの有効期限イベントを処理します。

終了したタイマーを処理するために、nl::Weave::System::Timer::HandleExpiredTimers を呼び出します。この API は、Weave システム レイヤ オブジェクトを所有するスレッドでのみ呼び出されるものと想定しています。

詳細
戻り値
成功した場合は WEAVE_SYSTEM_NO_ERROR、それ以外の場合はエラーコード。

HandleSelectResult

void HandleSelectResult(
  int aSetSize,
  fd_set *aReadSet,
  fd_set *aWriteSet,
  fd_set *aExceptionSet
)

select 呼び出しからの I/O を処理します。

このメソッドは、保留中の I/O イベントをアクティブなエンドポイントごとに登録し、それらのエンドポイントのそれぞれの I/O 処理関数を呼び出します。

詳細
パラメータ
[in] aSetSize
select 呼び出しの戻り値。
[in] aReadSet
読み取りファイル記述子のセットへのポインタ。
[in] aWriteSet
書き込みファイル記述子のセットへのポインタ。
[in] aExceptionSet
エラーが発生したファイル記述子のセットへのポインタ。

init

Error Init(
  void *aContext
)

レイヤ

 Layer(
  void
)

NewTimer

Error NewTimer(
  Timer *& aTimerPtr
)

PostEvent

Error PostEvent(
  Object & aTarget,
  EventType aEventType,
  uintptr_t aArgument
)

このメソッドは、指定された引数を使用して、指定されたタイプのイベント / メッセージを、このインスタンスのプラットフォーム固有のイベントキューに送信します。

詳細
パラメータ
[in,out] aTarget
ポスト リクエストを行う Weave システム レイヤ オブジェクトへのポインタ。
[in] aEventType
送信するイベントのタイプ。
[in,out] aArgument
送信するイベントに関連付けられている引数。
戻り値
WEAVE_SYSTEM_NO_ERROR
成功時。
WEAVE_SYSTEM_ERROR_UNEXPECTED_STATE
Layer オブジェクトの状態が正しくない場合。
WEAVE_SYSTEM_ERROR_NO_MEMORY
イベントキューがすでにいっぱいの場合。
other
失敗の理由を示す生成済みのプラットフォーム固有のエラー。

PrepareSelect

void PrepareSelect(
  int & aSetSize,
  fd_set *aReadSet,
  fd_set *aWriteSet,
  fd_set *aExceptionSet,
  struct timeval & aSleepTime
)

select() で使用するファイル記述子のセットを準備します。

詳細
パラメータ
[out] aSetSize
ファイル記述子セット内のファイル記述子の範囲。
[in] aReadSet
読み取り可能なファイル記述子のセットへのポインタ。
[in] aWriteSet
書き込み可能なファイル記述子のセットへのポインタ。
[in] aExceptionSet
エラーが発生したファイル記述子のセットへのポインタ。
[in] aSleepTime
最大スリープ時間への参照。

ScheduleWork

Error ScheduleWork(
  TimerCompleteFunct aComplete,
  void *aAppState
)

TimerCompleteFunct と同一のシグネチャを持つ関数が、できるだけ早く Weave スレッドで実行されるようにスケジュールします。

詳細
パラメータ
[in] aComplete
このタイマーが発生したときに呼び出されるコールバック関数へのポインタ。
[in] aAppState
コールバック関数に引数として渡されるアプリ状態オブジェクトへのポインタ。
戻り値
WEAVE_SYSTEM_ERROR_UNEXPECTED_STATE
SystemLayer が初期化されていない場合。
WEAVE_SYSTEM_ERROR_NO_MEMORY
SystemLayer が新しいタイマーを割り当てることができない場合。
WEAVE_SYSTEM_NO_ERROR
成功時。

SetPlatformData

void SetPlatformData(
  void *aPlatformData
)

これにより、指定されたクライアント固有のプラットフォーム データがインスタンスに設定され、後でクライアント プラットフォームで取得できるようになります。

詳細
パラメータ
[in] aPlatformData
設定するクライアント固有のプラットフォーム データ。

シャットダウン

Error Shutdown(
  void
)

StartTimer

Error StartTimer(
  uint32_t aMilliseconds,
  TimerCompleteFunct aComplete,
  void *aAppState
)

このメソッドは、ワンショット タイマーを開始します。

詳細
パラメータ
[in] aMilliseconds
ミリ秒単位の有効期限。
[in] aComplete
タイマーが切れたときに呼び出される関数へのポインタ。
[in] aAppState
タイマーが切れたときに使用されるアプリケーション状態オブジェクトへのポインタ。
戻り値
WEAVE_SYSTEM_NO_ERROR 成功時。
戻り値
WEAVE_SYSTEM_ERROR_NO_MEMORY タイマーを割り当てられない場合。
戻り値
タイマーの開始に失敗したことを示すその他の値。

州

LayerState State(
  void
) const

レイヤ オブジェクトの現在の状態を返します。

WakeSelect

void WakeSelect(
  void
)

select() を使用してウェイク パイプに 1 バイトを書き込み、ファイル記述子をモニタリングする I/O スレッドを復帰させます。

注: WakeSelect() が HandleSelectResult() 内から呼び出されている場合は、I/O スレッドがすでに起動しているため、復帰パイプへの書き込みはスキップできます。 さらに、この書き込みが失敗しても問題ありません。ごく可能性が高いのは、パイプがいっぱいであることだけです。この場合は、SELECT の呼び出しスレッドがウェイクアップします。

静的パブリック関数

GetClock_Monotonic

uint64_t GetClock_Monotonic(
  void
)

マイクロ秒単位の単調なシステム時間を返します。

この関数は、プラットフォームで定義された任意のエポックからの経過時間をマイクロ秒単位で返します。返される値は、システムの再起動の間に増加し続けること（ラップがない）ことが保証されます。さらに、復帰時の再起動を必要としないシステム スリープ モードでも、基盤となるタイムソースが継続的に作動することが保証されます。

プラットフォームによっては、システムの起動からの時間を測定する値を返すことがありますが、アプリはこれに依存してはいけません。また、GetClock_Monotonic() のエポックは、他の GetClock... 関数のエポックと同じである必要はありません。したがって、相対時間の計算は、同じ関数から返された値に対してのみ実行できます。

この関数は、スレッドを使用するすべてのプラットフォームでスレッドセーフであることが保証されます。

詳細
戻り値
プラットフォームで定義された任意のエポックからの経過時間（マイクロ秒単位）。

GetClock_MonotonicHiRes

uint64_t GetClock_MonotonicHiRes(
  void
)

（潜在的に）高解像度の単調なシステム時間をマイクロ秒単位で返します。

この関数は、プラットフォームで定義された任意のエポックからの経過時間をマイクロ秒単位で返します。返される値は、システムの再起動の間に増加し続けること（ラップがない）ことが保証されます。ただし、システムのディープ スリープ状態でも、基になるタイマーは継続的に作動する必要はありません。

プラットフォームによっては、GetClock_Monotonic() よりも精度の高い高精度のタイマーを使用して GetClock_MonotonicHiRes() を実装しており、段階的なクロック調整（スルーイング）の対象とならない場合があります。このようなタイマーがないシステムは、GetClock_Monotonic() と同じ値を返すことがあります。

GetClock_MonotonicHiRes() によって返される時刻のエポックは、GetClock_Monotonic() を含む他の GetClock... 関数のエポックと同じにする必要はありません。

この関数は、スレッドを使用するすべてのプラットフォームでスレッドセーフであることが保証されます。

詳細
戻り値
プラットフォームで定義された任意のエポックからの経過時間（マイクロ秒単位）。

GetClock_MonotonicMS

uint64_t GetClock_MonotonicMS(
  void
)

単調なシステム時間をミリ秒単位で返します。

この関数は、プラットフォームで定義された任意のエポックからの経過時間をミリ秒単位で返します。返される値は、システムの再起動間で増加し続けること（ラップがない）ことが保証されます。さらに、復帰時の再起動を必要としないシステム スリープ モードでも、基盤となるタイムソースが継続的に作動することが保証されています。

プラットフォームによっては、システムの起動からの時間を測定する値を返すことがありますが、アプリはこれに依存してはいけません。また、GetClock_Monotonic() のエポックは、他の GetClock... 関数のエポックと同じにする必要はありません。したがって、相対時間の計算は、同じ関数から返された値に対してのみ実行できます。

この関数は、スレッドを使用するすべてのプラットフォームでスレッドセーフであることが保証されます。

詳細
戻り値
プラットフォームで定義された任意のエポックからの経過時間（ミリ秒）。

GetClock_RealTime

Error GetClock_RealTime(
  uint64_t & curTime
)

現在の実（常用）時刻をマイクロ秒単位の Unix 時間形式で返します。

このメソッドは、ローカル プラットフォームの現在のリアルタイム概念を、マイクロ秒単位にスケーリングされた Unix 時間値として表して返します。基礎となるクロックは少なくとも整数秒（1,000,000 値）のレートで動作することが保証されていますが、プラットフォームによってはさらに速く動作することがあります。

基盤となるプラットフォームがリアルタイムでトラッキングできても、システムが現在同期されていない場合、GetClock_RealTime() はエラー WEAVE_SYSTEM_ERROR_REAL_TIME_NOT_SYNCED を返します。

リアルタイムでトラッキングできないプラットフォームでは、GetClock_RealTime() メソッドが存在しない場合、そのメソッドを参照するすべてのアプリケーションでリンクエラーが発生します。または、このようなプラットフォームでは、常にエラー WEAVE_SYSTEM_ERROR_NOT_SUPPORTED を返す GetClock_RealTime() の実装が提供されることがあります。

この関数は、スレッドを使用するすべてのプラットフォームでスレッドセーフであることが保証されます。

詳細
パラメータ
[out] curTime
マイクロ秒単位にスケーリングされた Unix 時間で表される現在の時刻。
戻り値
WEAVE_SYSTEM_NO_ERROR
メソッドが成功した場合。
#WEAVE_SYSTEM_ERROR_REAL_TIME_NOT_SYNCED
プラットフォームがリアルタイムで追跡できるが、現在は同期されていない場合。
#WEAVE_SYSTEM_ERROR_NOT_SUPPORTED
プラットフォームがリアルタイムで追跡できない場合。

GetClock_RealTimeMS

Error GetClock_RealTimeMS(
  uint64_t & curTimeMS
)

現在の実（常用）時刻をミリ秒単位の Unix 時間形式で返します。

このメソッドは、ローカル プラットフォームの現在のリアルタイム概念を、ミリ秒単位にスケーリングされた Unix 時間値として表して返します。基礎となるクロックは少なくとも整数秒（1,000,000 値）のレートで動作することが保証されていますが、プラットフォームによってはさらに速く動作することがあります。

基盤となるプラットフォームがリアルタイムでトラッキングできても、システムが現在同期されていない場合、GetClock_RealTimeMS() はエラー WEAVE_SYSTEM_ERROR_REAL_TIME_NOT_SYNCED を返します。

リアルタイムでトラッキングできないプラットフォームでは、GetClock_RealTimeMS() メソッドが存在しない場合、そのメソッドを参照するすべてのアプリケーションでリンクエラーが発生します。または、このようなプラットフォームでは、常にエラー WEAVE_SYSTEM_ERROR_NOT_SUPPORTED を返す GetClock_RealTimeMS() の実装が提供されることがあります。

この関数は、スレッドを使用するすべてのプラットフォームでスレッドセーフであることが保証されます。

詳細
パラメータ
[out] curTime
ミリ秒単位にスケーリングされた Unix 時間で表される現在の時刻。
戻り値
WEAVE_SYSTEM_NO_ERROR
メソッドが成功した場合。
#WEAVE_SYSTEM_ERROR_REAL_TIME_NOT_SYNCED
プラットフォームがリアルタイムで追跡できるが、現在は同期されていない場合。
#WEAVE_SYSTEM_ERROR_NOT_SUPPORTED
プラットフォームがリアルタイムで追跡できない場合。

SetClock_RealTime

Error SetClock_RealTime(
  uint64_t newCurTime
)

プラットフォームの現在の実（常用）時間の概念を設定します。

アプリケーションはこの関数を呼び出して、ローカル プラットフォームの現在のリアルタイムという概念を設定できます。新しい現在時刻は、マイクロ秒単位にスケーリングされた Unix 時間値で表されます。

設定すると、基盤となるプラットフォーム クロックは少なくとも秒単位の粒度でリアルタイムにトラッキングされることが保証されます。

プラットフォームによっては、リアルタイムで設定できるアプリケーションやプロセスが制限されていることがあります。呼び出し元にリアルタイムでの変更が許可されていない場合、SetClock_RealTime() 関数はエラー WEAVE_SYSTEM_ERROR_ACCESS_DENIED を返します。

リアルタイムでトラッキングできないプラットフォームや、リアルタイムで設定できないプラットフォームでは、SetClock_RealTime() 関数が存在しない場合、関数を参照するすべてのアプリでリンクエラーが発生します。または、このようなプラットフォームでは、常にエラー WEAVE_SYSTEM_ERROR_NOT_SUPPORTED を返す SetClock_RealTime() の実装が提供されることがあります。

この関数は、スレッドを使用するすべてのプラットフォームでスレッドセーフであることが保証されます。

詳細
パラメータ
[in] newCurTime
マイクロ秒単位にスケーリングされた Unix 時間で表される新しい現在時刻。
戻り値
WEAVE_SYSTEM_NO_ERROR
メソッドが成功した場合。
#WEAVE_SYSTEM_ERROR_NOT_SUPPORTED
プラットフォームがリアルタイムで追跡できない場合。
#WEAVE_SYSTEM_ERROR_ACCESS_DENIED
呼び出し元アプリケーションに現在の時刻を設定する権限がない場合。