nl::Weave::Profiles::DataManagement_Current::SubscriptionEngine

#include <src/lib/profiles/data-management/Current/SubscriptionEngine.h>

これは、クライアント側とパブリッシャー側の両方で、すべての WDM Next サブスクリプションをホストするシングルトンです。

概要

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

公開タイプ
EventCallback)(void *const aAppState, EventID aEvent, const InEventParam &aInParam, OutEventParam &aOutParam) typedef
void(*
SubscriptionEngine 固有のコールバックに対して、イベントバック関数と関連する状態オブジェクトへのポインタを設定します。
EventID enum
このコンポーネントから直接生成されるイベント。

静的パブリック関数
DefaultEventHandler(EventID aEvent, const InEventParam & aInParam, OutEventParam & aOutParam)
void
これは、無視されたイベントや認識されないイベントが発生した場合にアプリケーション レイヤによって呼び出されるデフォルトのイベント ハンドラです。
GetInstance(void)
シングルトン サブスクリプション エンジンを取得します。

パブリック関数
GetExchangeManager(void) const
GetMinEventLogPosition(size_t & outLogPosition) const
すべてのアクティブなサブスクリプション ハンドラから、イベント オフロード ポイントの最小相対位置を取得します。
Init(nl::Weave::WeaveExchangeManager *const apExchangeMgr, void *const aAppState, const EventCallback aEventCallback)
SetEventCallback(void *const aAppState, const EventCallback aEventCallback)
void
SubscriptionEngine 固有のコールバックに対して、イベントバック関数と関連する状態オブジェクトへのポインタを設定します。

共用体
nl::Weave::Profiles::DataManagement_Current::SubscriptionEngine::InEventParam

このコンポーネントから直接生成されたイベントとともに送信される受信パラメータ。
nl::Weave::Profiles::DataManagement_Current::SubscriptionEngine::OutEventParam

このコンポーネントから直接生成されたイベントとともに送信される送信パラメータ。

公開タイプ

EventCallback

void(* EventCallback)(void *const aAppState, EventID aEvent, const InEventParam &aInParam, OutEventParam &aOutParam)

SubscriptionEngine 固有のコールバックに対して、イベントバック関数と関連する状態オブジェクトへのポインタを設定します。

詳細
パラメータ
[in] aAppState
アプリケーション レイヤから提供される状態オブジェクトへのポインタ
[in] aEvent
イベント コールバック用の関数ポインタ
[in] aInParam
このイベントの入力パラメータへの定数参照
[out] aOutParam
このイベントの出力パラメータへの参照。

EventID

 EventID

このコンポーネントから直接生成されるイベント。

静的パブリック関数

DefaultEventHandler

void DefaultEventHandler(
  EventID aEvent,
  const InEventParam & aInParam,
  OutEventParam & aOutParam
)

これは、無視されたイベントや認識されないイベントが発生した場合にアプリケーション レイヤによって呼び出されるデフォルトのイベント ハンドラです。

詳細
パラメータ
[in] aEvent
イベント コールバック用の関数ポインタ
[in] aInParam
このイベントの入力パラメータへの定数参照
[out] aOutParam
このイベントの出力パラメータへの参照。

GetInstance

SubscriptionEngine * GetInstance(
  void
)

シングルトン サブスクリプション エンジンを取得します。

なお、この機能は導入層で実装する必要があります。

詳細
戻り値
共有サブスクリプション エンジンへのポインタ

パブリック関数

GetExchangeManager

nl::Weave::WeaveExchangeManager * GetExchangeManager(
  void
) const

GetMinEventLogPosition

WEAVE_ERROR GetMinEventLogPosition(
  size_t & outLogPosition
) const

すべてのアクティブなサブスクリプション ハンドラから、イベント オフロード ポイントの最小相対位置を取得します。

すべてのアクティブなサブスクリプション ハンドラから、イベント オフロード ポイントの（起動時間からの）最小相対位置を取得します。

詳細
パラメータ
[in,out] outLogPosition
すべてのアクティブなサブスクリプション ハンドラの最小ログ オフロード ポイント。有効なサブスクリプション ハンドラがない場合、値は変更されません。ログの位置は、サブスクリプション ハンドラの初期化時に 0 に設定されます。
戻り値
WEAVE_NO_ERROR
無条件

init

WEAVE_ERROR Init(
  nl::Weave::WeaveExchangeManager *const apExchangeMgr,
  void *const aAppState,
  const EventCallback aEventCallback
)

SetEventCallback

void SetEventCallback(
  void *const aAppState,
  const EventCallback aEventCallback
)

SubscriptionEngine 固有のコールバックに対して、イベントバック関数と関連する状態オブジェクトへのポインタを設定します。

詳細
パラメータ
[in] aAppState
アプリケーション レイヤから提供される状態オブジェクトへのポインタ
[in] aEventCallback
イベント コールバック用の関数ポインタ

SubscriptionEngine

 SubscriptionEngine(
  void
)