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

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

Il s'agit d'un singleton hébergeant tous les abonnements WDM Next, côté client et éditeur.

Résumé

Constructeurs et destructeurs
SubscriptionEngine(void)

Types publics
EventCallback)(void *const aAppState, EventID aEvent, const InEventParam &aInParam, OutEventParam &aOutParam) typedef
void(*
Définit la fonction de retour de l'événement et le pointeur sur l'objet d'état associé pour les rappels spécifiques à SubscriptionEngine.
EventID énum
Événements générés directement à partir de ce composant.

Fonctions statiques publiques
DefaultEventHandler(EventID aEvent, const InEventParam & aInParam, OutEventParam & aOutParam)
void
Il s'agit du gestionnaire d'événements par défaut à appeler par la couche d'application pour tout événement ignoré ou non reconnu.
GetInstance(void)
Récupérer le moteur d'abonnement du singleton

Fonctions publiques
GetExchangeManager(void) const
GetMinEventLogPosition(size_t & outLogPosition) const
Récupérez la position relative minimale du point de déchargement de l'événement auprès de tous les gestionnaires d'abonnements actifs.
Init(nl::Weave::WeaveExchangeManager *const apExchangeMgr, void *const aAppState, const EventCallback aEventCallback)
SetEventCallback(void *const aAppState, const EventCallback aEventCallback)
void
Définit la fonction de retour de l'événement et le pointeur sur l'objet d'état associé pour les rappels spécifiques à SubscriptionEngine.

Union
nl::Weave::Profiles::DataManagement_Current::SubscriptionEngine::InEventParam

Paramètres entrants envoyés avec des événements générés directement à partir de ce composant.

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

Paramètres sortants envoyés avec des événements générés directement à partir de ce composant.

Types publics

EventCallback

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

Définit la fonction de retour de l'événement et le pointeur sur l'objet d'état associé pour les rappels spécifiques à SubscriptionEngine.

Détails
Paramètres
[in] aAppState
Pointeur vers l'objet d'état fourni par la couche d'application
[in] aEvent
Pointeur de fonction pour le rappel d'événement
[in] aInParam
Référence constante au paramètre d'entrée de cet événement
[out] aOutParam
Référence au paramètre de sortie pour cet événement

EventID

 EventID

Événements générés directement à partir de ce composant.

Fonctions statiques publiques

DefaultEventHandler

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

Il s'agit du gestionnaire d'événements par défaut à appeler par la couche d'application pour tout événement ignoré ou non reconnu.

Détails
Paramètres
[in] aEvent
Pointeur de fonction pour le rappel d'événement
[in] aInParam
Référence constante au paramètre d'entrée de cet événement
[out] aOutParam
Référence au paramètre de sortie pour cet événement

GetInstance

SubscriptionEngine * GetInstance(
  void
)

Récupérer le Singleton Subscription Engine

Notez que cette fonction doit être implémentée par la couche d'adoption.

Détails
Renvoie
Pointeur vers le moteur d'abonnement partagé

Fonctions publiques

GetExchangeManager

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

GetMinEventLogPosition

WEAVE_ERROR GetMinEventLogPosition(
  size_t & outLogPosition
) const

Récupérez la position relative minimale du point de déchargement de l'événement auprès de tous les gestionnaires d'abonnements actifs.

Récupère la position minimale par rapport (par rapport au temps de démarrage) du point de déchargement de l'événement à partir de tous les gestionnaires d'abonnements actifs.

Détails
Paramètres
[in,out] outLogPosition
Point de déchargement minimal des journaux pour tous les gestionnaires d'abonnement actifs. Si aucun gestionnaire d'abonnement n'est actif, la valeur reste inchangée. La position dans le journal est définie sur 0 lors de l'initialisation du gestionnaire d'abonnement.
Valeurs renvoyées
WEAVE_NO_ERROR
sans condition

Init

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

SetEventCallback

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

Définit la fonction de retour de l'événement et le pointeur sur l'objet d'état associé pour les rappels spécifiques à SubscriptionEngine.

Détails
Paramètres
[in] aAppState
Pointeur vers l'objet d'état fourni par la couche d'application
[in] aEventCallback
Pointeur de fonction pour le rappel d'événement

SubscriptionEngine

 SubscriptionEngine(
  void
)