Google は、黒人コミュニティのための人種的公平の促進に取り組んでいます。詳細をご覧ください。

このページは Cloud Translation API によって翻訳されました。

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` これはプラットフォーム固有のフックの構文ラッパーで、イベントループに影響を与え、このインスタンスにサービスを提供するキューを待機して、そのキューからイベントを取得し、処理するためにディスパッチします。
`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` wakeup パイプに 1 バイトを書き込むことで、select() を使用してファイル記述子をモニタリングする 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
)

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

詳細
戻り値	成功した場合は 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::タイマー::HandleExpiredTimers を呼び出して、期限切れのタイマーを処理します。この API は、Weave システムの Layer オブジェクトを所有するスレッド上でのみ呼び出されることを前提としています。

詳細
戻り値	成功した場合は 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 処理関数を呼び出します。

注: コールバックを行う前にすべてのエンドポイントに保留中の I/O フィールドを設定することが重要です。これにより、エンドポイントが閉じた後、別のエンドポイントのコールバック内で再び開かれる事態が回避されます。この場合、新しいエンドポイントには古いエンドポイントと同じファイル記述子が割り当てられる可能性があります。ただし、そのファイル記述子番号の保留中の I/O は、現在のエンドポイントではなく、古い実装に関連する 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 システムの Layer オブジェクトへのポインタ。
`[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 スレッドでできるだけ早く実行されるようにスケジュールします。

注: この関数は原理的に StartTimer(0, aComplete, aAppState) として実装できます。ただし、SystemTimer の仕様では、ある種の最適化が可能であるため、その実装を不可能にする可能性があります。具体的には、SystemTimer API は特定の SystemLayer を所有するスレッドからのみ呼び出すことができますが、ScheduleWork は任意のスレッドから呼び出すことができます。さらに、SystemTimer API ではすでに期限切れのハンドラをインラインで呼び出すことができますが、ScheduleWork は、現在の 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
)

wakeup パイプに 1 バイトを書き込むことで、select() を使用してファイル記述子をモニタリングする 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... 関数（GetClock_Monotonic() を含む）と同じである必要はありません。

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

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

GetClock_MonotonicMS

uint64_t GetClock_MonotonicMS(
  void
)

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

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

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

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

GetClock_RealTime

Error GetClock_RealTime(
  uint64_t & curTime
)

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

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

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

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

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

詳細

パラメータ

[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() メソッドが存在しないため、これを参照するすべてのアプリケーションでリンクエラーが発生します。あるいは、このようなプラットフォームが提供する GetClock_RealTimeMS() の実装によって、常にエラー WEAVE_SYSTEM_ERROR_NOT_SUPPORTED が返される場合もあります。

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

詳細

パラメータ

[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`	呼び出し元のアプリケーションに現在の時刻を設定する権限がない場合。

nl::Weave::System::Layer

概要

コンストラクタとデストラクタ

パブリック タイプ

パブリック関数

静的パブリック関数

パブリック タイプ

EventHandler

TimerCompleteFunct

パブリック関数

AddEventHandlerDelegate

CancelTimer

DispatchEvent

DispatchEvents

GetPlatformData

HandleEvent

HandlePlatformTimer

HandleSelectResult

init

レイヤ

NewTimer

PostEvent

PrepareSelect

ScheduleWork

SetPlatformData

シャットダウン

StartTimer

状態

WakeSelect

静的パブリック関数

GetClock_Monotonic

GetClock_MonotonicHiRes

GetClock_MonotonicMS

GetClock_RealTime

GetClock_RealTimeMS

SetClock_RealTime

パブリックタイプ

パブリックタイプ