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

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

Si tratta di un singleton che ospita tutti gli abbonamenti a WDM Next, sia lato client che lato publisher.

Riepilogo

Costruttori e distruttori
SubscriptionEngine(void)

Tipi pubblici
EventCallback)(void *const aAppState, EventID aEvent, const InEventParam &aInParam, OutEventParam &aOutParam) typedef
void(*
Imposta la funzione Indietro dell'evento e il puntatore sull'oggetto di stato associato per le richiamate specifiche di SubscriptionEngine.
EventID enum
Eventi generati direttamente da questo componente.

Funzioni statiche pubbliche
DefaultEventHandler(EventID aEvent, const InEventParam & aInParam, OutEventParam & aOutParam)
void
Questo è il gestore di eventi predefinito che deve essere chiamato dal livello dell'applicazione per qualsiasi evento ignorato o non riconosciuto.
GetInstance(void)
Recupera il motore di sottoscrizione singleton.

Funzioni pubbliche
GetExchangeManager(void) const
GetMinEventLogPosition(size_t & outLogPosition) const
Recupera la posizione relativa minima del punto di offload dell'evento da tutti i gestori di abbonamenti attivi.
Init(nl::Weave::WeaveExchangeManager *const apExchangeMgr, void *const aAppState, const EventCallback aEventCallback)
SetEventCallback(void *const aAppState, const EventCallback aEventCallback)
void
Imposta la funzione Indietro dell'evento e il puntatore sull'oggetto di stato associato per le richiamate specifiche di SubscriptionEngine.

Sindacati
nl::Weave::Profiles::DataManagement_Current::SubscriptionEngine::InEventParam

Parametri in entrata inviati con eventi generati direttamente da questo componente.

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

Parametri in uscita inviati con eventi generati direttamente da questo componente.

Tipi pubblici

EventCallback

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

Imposta la funzione Indietro dell'evento e il puntatore sull'oggetto di stato associato per le richiamate specifiche di SubscriptionEngine.

Dettagli
Parametri
[in] aAppState
Un puntatore all'oggetto di stato fornito dal livello dell'applicazione
[in] aEvent
Un puntatore a funzione per il richiamo dell'evento
[in] aInParam
Un riferimento const al parametro di input per questo evento
[out] aOutParam
Un riferimento al parametro di output per questo evento

EventID

 EventID

Eventi generati direttamente da questo componente.

Funzioni statiche pubbliche

DefaultEventHandler

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

Questo è il gestore di eventi predefinito che deve essere chiamato dal livello dell'applicazione per qualsiasi evento ignorato o non riconosciuto.

Dettagli
Parametri
[in] aEvent
Un puntatore a funzione per la richiamata dell'evento
[in] aInParam
Un riferimento const al parametro di input per questo evento
[out] aOutParam
Un riferimento al parametro di output per questo evento

GetInstance

SubscriptionEngine * GetInstance(
  void
)

Recupera il motore di sottoscrizione singleton.

Tieni presente che questa funzione deve essere implementata dal livello di adozione.

Dettagli
Restituisce
Un puntatore al motore di sottoscrizione condiviso

Funzioni pubbliche

GetExchangeManager

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

GetMinEventLogPosition

WEAVE_ERROR GetMinEventLogPosition(
  size_t & outLogPosition
) const

Recupera la posizione relativa minima del punto di offload dell'evento da tutti i gestori di abbonamenti attivi.

Recupera la posizione relativa minima (rispetto al tempo di avvio) del punto di offload dell'evento da tutti i gestori di abbonamenti attivi.

Dettagli
Parametri
[in,out] outLogPosition
Punto minimo di offload del log per tutti i gestori di abbonamenti attivi. Se nessun gestore degli abbonamenti è attivo, il valore rimane invariato. La posizione del log è impostata su 0 durante l'inizializzazione del gestore degli abbonamenti.
Valori restituiti
WEAVE_NO_ERROR
incondizionatamente

Inizializzazione

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

SetEventCallback

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

Imposta la funzione Indietro dell'evento e il puntatore sull'oggetto di stato associato per le richiamate specifiche di SubscriptionEngine.

Dettagli
Parametri
[in] aAppState
Un puntatore all'oggetto di stato fornito dal livello dell'applicazione
[in] aEventCallback
Un puntatore a funzione per il richiamo dell'evento

SubscriptionEngine

 SubscriptionEngine(
  void
)