nl::Weave::Profiles::DataManagement_Current::LoggingManagement

外部に格納された一連のイベントを登録するための公開 API。

FetchExternalEventsFunct 形式のコールバックを登録します。この API では、プラットフォームが登録時のイベント数を把握している必要があります。また、内部動作により、この数値は一定である必要があります。この API ではプラットフォームが特定のイベント ID を登録できないため、（少なくとも一意のイベント ID を含む）イベントを永続的に保存できなくなります。

登録ユーザーがこの範囲内のイベント ID を何度でも取得しようとすると、コールバックは登録が解除されるまで呼び出されます。

この関数のバリアントは、イベントがサブスクライバーに配信されたときと、外部イベント オブジェクトが強制排除されたときの両方で外部プロバイダが通知を受け取りたい場合に使用します。

イベントが配信されると、外部プロバイダに、受信者のノード ID、その受信者に配信された最後のイベントの ID とともに、その旨が通知されます。同じイベント ID について外部プロバイダに複数回通知される場合があります。ハンドラには特別な制限はありません。特に、外部イベント ID の登録を解除できます。

外部イベント オブジェクトがログバッファから削除されると、外部イベント オブジェクトのコピーとともに外部プロバイダに通知されます。

失敗すると、ExternalEvents 構造体へのポインタが NULL になります。それ以外の場合は、コールバックに割り当てられた開始イベント ID と終了イベント ID が入力されます。このポインタを使用して、一連のイベントの登録を解除する必要があります。

コールバックで何を実装する必要があるかについては、FetchExternalEventsFunct のドキュメントをご覧ください。

外部に格納された一連のイベントを登録するための公開 API。

FetchExternalEventsFunct フォームのコールバックを登録します。この API では、プラットフォームが登録時のイベント数を把握している必要があります。また、内部動作により、この数値は一定である必要があります。この API ではプラットフォームが特定のイベント ID を登録できないため、（少なくとも一意のイベント ID を含む）イベントを永続的に保存できなくなります。

登録ユーザーがこの範囲内のイベント ID を何度でも取得しようとすると、コールバックは登録が解除されるまで呼び出されます。

この関数のバリアントは、イベントがサブスクライバーに配信された際に外部プロバイダが通知を受け取りたい場合に使用します。ただし、外部イベント オブジェクトが削除された場合は通知されません。イベントが配信されると、外部プロバイダには、受信者のノード ID と、その受信者に配信された最後のイベントの ID とともに、その旨が通知されます。同じイベント ID について外部プロバイダに複数回通知される場合があります。ハンドラには特別な制限はありません。特に、外部イベント ID の登録を解除できます。

失敗した場合、ExternalEvents 構造体へのポインタは NULL になります。それ以外の場合は、コールバックに割り当てられた開始イベント ID と終了イベント ID が入力されます。このポインタを使用して、一連のイベントの登録を解除する必要があります。

コールバックで何を実装する必要があるかについては、FetchExternalEventsFunct のドキュメントをご覧ください。

外部に格納された一連のイベントを登録するための公開 API。

FetchExternalEventsFunct フォームのコールバックを登録します。この API では、プラットフォームが登録時のイベント数を把握している必要があります。また、内部動作により、この数値は一定である必要があります。この API ではプラットフォームが特定のイベント ID を登録できないため、（少なくとも一意のイベント ID を含む）イベントを永続的に保存できなくなります。

登録ユーザーがこの範囲内のイベント ID を何度でも取得しようとすると、コールバックは登録が解除されるまで呼び出されます。

この関数のバリアントは、外部プロバイダが、外部イベントが配信されたとき、または外部イベント オブジェクトが強制排除されたときのいずれでも通知を行わない場合に使用します。

失敗した場合、ExternalEvents 構造体へのポインタは NULL になります。それ以外の場合は、コールバックに割り当てられた開始イベント ID と終了イベント ID が入力されます。このポインタを使用して、一連のイベントの登録を解除する必要があります。

コールバックで何を実装する必要があるかについては、FetchExternalEventsFunct のドキュメントをご覧ください。

ログ オフロード タスクをスケジュールします。

この関数は、タスク オフロード プロセスをスケジュールするかどうかを決定し、スケジュールすると、Weave スレッドで非同期に LoggingFlushHandler が実行されるようにスケジュールします。

フラッシュをスケジュールするかどうかは、次の 3 つの要因によって決まります。

バッファをフラッシュするための明示的なリクエスト

イベント バッファの状態、まだイベント コンシューマと同期されていないデータの量

すでに保留中のリクエスト フラッシュ リクエスト イベントがあるかどうか。

フラッシュをスケジュールする明示的なリクエストは、入力パラメータを介して渡されます。

通常、新しいオフロードを開始するのに十分なデータがイベント バッファに格納されると、自動フラッシュがスケジュールされます。オフロード戦略によっては、オフロード間の最小時間や最大時間など、その他のトリガーも考慮される場合があります。

イベントログの保留状態は、mUploadRequested 変数で示されます。この関数は複数のスレッドから呼び出すことができるため、通知の送信前に冗長な LoggingFlushHandler がスケジュールされないように、mUploadRequested をアトミックに読み取り、設定する必要があります。

すべての重要タイプの Weave イベントをシリアル化します。

WeaveCircularTLVBuffer のイベントと関連する状態を、指定されたバッファにシリアル化します。

このメソッドは、スリープ中に RAM を保持しないデバイスで使用するためのものです。スリープ状態になる前にイベントを保持して、イベントの損失を防ぐことが目的です

SetExchangeManager

WEAVE_ERROR SetExchangeManager(
  nl::Weave::WeaveExchangeManager *inMgr
)

SetLoggingEndpoint

WEAVE_ERROR SetLoggingEndpoint(
  event_id_t *inEventEndpoints,
  size_t inNumImportanceLevels,
  size_t & outLoggingPosition
)

void SkipEvent(
  EventLoadOutContext *aContext
)

void ThrottleLogger(
  void
)

void UnregisterEventCallbackForImportance(
  ImportanceType inImportance,
  event_id_t inEventID
)

void UnthrottleLogger(
  void
)

静的パブリック関数

void CreateLoggingManagement(
  nl::Weave::WeaveExchangeManager *inMgr,
  size_t inNumBuffers,
  const LogStorageResources *const inLogStorageResources
)

void DestroyLoggingManagement(
  void
)

LoggingManagement & GetInstance(
  void
)