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
)