nl ：：織り::プロファイル:: DataManagement_Current ：： SubscriptionEngine

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

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

概要

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

SubscriptionEngine (void)

公開型

EventCallback )(void *const aAppState, EventID aEvent, const InEventParam &aInParam, OutEventParam &aOutParam) typedef
void(*
以下のために、関連する状態オブジェクトにイベントバック関数ポインタを設定しSubscriptionEngineの特定のコールバック。
EventID列挙型
このコンポーネントから直接生成されたイベント。

パブリック静的関数

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 ::織り::プロファイル:: DataManagement_Current :: SubscriptionEngine :: InEventParam

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

NL ::織り::プロファイル:: DataManagement_Current :: SubscriptionEngine :: OutEventParam

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

公開型

EventCallback

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

以下のために、関連する状態オブジェクトにイベントバック関数ポインタを設定しSubscriptionEngineの特定のコールバック。

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

イベントID

 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
無条件に

初期化

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
)