nl:: örgü:: Profiller:: DataManagement_Current:: AbonelikMotor

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

Bu, hem istemci hem de yayıncı tarafları olmak üzere tüm WDM Next aboneliklerini barındıran bir tekildir.

Özet

Yapıcılar ve Yıkıcılar

SubscriptionEngine (void)

Genel türler

EventCallback )(void *const aAppState, EventID aEvent, const InEventParam &aInParam, OutEventParam &aOutParam) typedef
void(*
İçin ilgili durum nesnesine Etkinlik, fonksiyon ve işaretçiyi ayarlama SubscriptionEngine özel çağrı sırt.
EventID Sıralama
Doğrudan bu bileşenden oluşturulan olaylar.

Genel statik işlevler

DefaultEventHandler ( EventID aEvent, const InEventParam & aInParam, OutEventParam & aOutParam)
void
Bu, göz ardı edilen veya tanınmayan herhangi bir olay için uygulama katmanı tarafından çağrılacak varsayılan olay işleyicisidir.
GetInstance (void)
Singleton Abonelik Motorunu alın.

Kamu işlevleri

GetExchangeManager (void) const
GetMinEventLogPosition (size_t & outLogPosition) const
Tüm etkin abonelik işleyicilerinden olay 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
İçin ilgili durum nesnesine Etkinlik, fonksiyon ve işaretçiyi ayarlama SubscriptionEngine özel çağrı sırt.

Birlikler

nl :: Dokuma :: Profiller :: DataManagement_Current :: SubscriptionEngine :: InEventParam

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

nl :: Dokuma :: Profiller :: DataManagement_Current :: SubscriptionEngine :: OutEventParam

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

Genel türler

OlayGeri arama

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

İçin ilgili durum nesnesine Etkinlik, fonksiyon ve işaretçiyi ayarlama SubscriptionEngine özel çağrı sırt.

Ayrıntılar
parametreler
[in] aAppState
Uygulama katmanı tarafından sağlanan durum nesnesine yönelik bir işaretçi
[in] aEvent
Olay geri araması için bir işlev işaretçisi
[in] aInParam
Bu olay için giriş parametresine bir const referansı
[out] aOutParam
Bu olay için çıktı parametresine bir referans

Olay Kimliği

 EventID

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

Genel statik işlevler

VarsayılanOlay İşleyicisi

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

Bu, göz ardı edilen veya tanınmayan herhangi bir olay için uygulama katmanı tarafından çağrılacak varsayılan olay işleyicisidir.

Ayrıntılar
parametreler
[in] aEvent
Olay geri araması için bir işlev işaretçisi
[in] aInParam
Bu olay için giriş parametresine bir const referansı
[out] aOutParam
Bu olay için çıktı parametresine bir referans

GetInstance

SubscriptionEngine * GetInstance(
  void
)

Singleton Abonelik Motorunu alın.

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

Ayrıntılar
İadeler
Paylaşılan Abonelik Motoruna yönelik bir işaretçi

Kamu işlevleri

GetExchangeManager

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

GetMinEventLogPosition

WEAVE_ERROR GetMinEventLogPosition(
  size_t & outLogPosition
) const 

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

Tüm etkin abonelik işleyicilerinden olay boşaltma noktasının minimum göreli (önyükleme süresine) konumunu alır.

Ayrıntılar
parametreler
[in,out] outLogPosition
Tüm etkin abonelik işleyicileri için minimum günlük boşaltma noktası. Hiçbir abonelik işleyicisi aktif değilse, değer değişmeden kalır. Abonelik işleyicisi başlatıldıktan sonra günlük konumu 0'a ayarlanır.
Dönüş Değerleri
WEAVE_NO_ERROR
koşulsuz olarak

İçinde

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

SetEventCallback

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

İçin ilgili durum nesnesine Etkinlik, fonksiyon ve işaretçiyi ayarlama SubscriptionEngine özel çağrı sırt.

Ayrıntılar
parametreler
[in] aAppState
Uygulama katmanı tarafından sağlanan durum nesnesine yönelik bir işaretçi
[in] aEventCallback
Olay geri araması için bir işlev işaretçisi

AbonelikMotor

 SubscriptionEngine(
  void
)