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

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

Bu, hem istemci hem de yayıncı tarafında tüm WDM Next aboneliklerini barındıran tek bir platformdur.

Özet

Oluşturucular ve Yıkıcılar
SubscriptionEngine(void)

Herkese açık türler
EventCallback)(void *const aAppState, EventID aEvent, const InEventParam &aInParam, OutEventParam &aOutParam) typedef
void(*
Etkinlik geri işlevini ve işaretçiyi, SubscriptionEngine'e özgü geri çağrılar için ilişkili durum nesnesine ayarlayın.
EventID enum
Doğrudan bu bileşenden oluşturulan etkinlikler.

Herkese açık statik işlevler
DefaultEventHandler(EventID aEvent, const InEventParam & aInParam, OutEventParam & aOutParam)
void
Bu, yoksayılan veya tanınmayan etkinlikler için uygulama katmanı tarafından çağrılacak varsayılan etkinlik işleyicidir.
GetInstance(void)
Singleton Subscription Engine'i alın.

Herkese açık işlevler
GetExchangeManager(void) const
GetMinEventLogPosition(size_t & outLogPosition) const
Tüm etkin abonelik işleyicilerden etkinlik boşaltma noktasının minimum göreli konumunu alın.
Init(nl::Weave::WeaveExchangeManager *const apExchangeMgr, void *const aAppState, const EventCallback aEventCallback)
SetEventCallback(void *const aAppState, const EventCallback aEventCallback)
void
Etkinlik geri işlevini ve işaretçiyi, SubscriptionEngine'e özgü geri çağrılar için ilişkili durum nesnesine ayarlayın.

Birlikler
nl::Weave::Profiles::DataManagement_Current::SubscriptionEngine::InEventParam

Doğrudan bu bileşenden oluşturulan etkinliklerle gönderilen gelen parametreler.

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

Doğrudan bu bileşenden oluşturulan etkinliklerle gönderilen giden parametreler.

Herkese açık türler

EventCallback

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

Etkinlik geri işlevini ve işaretçiyi, SubscriptionEngine'e özgü geri çağrılar için ilişkili durum nesnesine ayarlayın.

Ayrıntılar
Parametreler
[in] aAppState
Uygulama katmanı tarafından sağlanan durum nesnesine işaretçi
[in] aEvent
Etkinlik geri çağırması için işlev işaretçisi
[in] aInParam
Bu etkinliğin giriş parametresine const referansı
[out] aOutParam
Bu etkinliğin çıkış parametresine referans

EventID

 EventID

Doğrudan bu bileşenden oluşturulan etkinlikler.

Herkese açık statik işlevler

DefaultEventHandler

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

Bu, yoksayılan veya tanınmayan etkinlikler için uygulama katmanı tarafından çağrılacak varsayılan etkinlik işleyicidir.

Ayrıntılar
Parametreler
[in] aEvent
Etkinlik geri çağırması için işlev işaretçisi
[in] aInParam
Bu etkinliğin giriş parametresine const referansı
[out] aOutParam
Bu etkinliğin çıkış parametresine referans

Örnek Alma

SubscriptionEngine * GetInstance(
  void
)

Singleton Subscription Engine'i alın.

Bu işlevin benimseme katmanı tarafından uygulanması gerektiğini unutmayın.

Ayrıntılar
İadeler
Paylaşılan Subscription Engine'e yönlendiren bir işaret

Herkese açık işlevler

GetExchangeManager

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

GetMinEventLogPosition

WEAVE_ERROR GetMinEventLogPosition(
  size_t & outLogPosition
) const

Tüm etkin abonelik işleyicilerden etkinlik boşaltma noktasının minimum göreli konumunu alın.

Tüm etkin abonelik işleyicilerden etkinlik boşaltma noktasının minimum göreli (önyükleme zamanına göre) konumunu alır.

Ayrıntılar
Parametreler
[in,out] outLogPosition
Tüm etkin abonelik işleyiciler için minimum günlük boşaltma noktası. Etkin abonelik işleyici yoksa değer aynı kalır. Abonelik işleyici başlatıldıktan sonra günlük konumu 0 olarak ayarlanır.
Değerleri Döndür
WEAVE_NO_ERROR
koşulsuz olarak

Init

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

SetEventCallback

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

Etkinlik geri işlevini ve işaretçiyi, SubscriptionEngine'e özgü geri çağrılar için ilişkili durum nesnesine ayarlayın.

Ayrıntılar
Parametreler
[in] aAppState
Uygulama katmanı tarafından sağlanan durum nesnesine işaretçi
[in] aEventCallback
Etkinlik geri çağırması için işlev işaretçisi

SubscriptionEngine

 SubscriptionEngine(
  void
)