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 côté éditeur.

Résumé

Constructeurs et destructeurs
SubscriptionEngine(void)

Types publics
EventCallback)(void *const aAppState, EventID aEvent, const InEventParam &aInParam, OutEventParam &aOutParam) typedef
void(*
Définissez la fonction de retour d'événement et le pointeur sur l'objet d'état associé pour les rappels spécifiques à SubscriptionEngine.
EventID enum
É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 que la couche application doit appeler pour tout événement ignoré ou non reconnu.
GetInstance(void)
Récupérez 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 à partir 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éfinissez la fonction de retour d'événement et le pointeur sur l'objet d'état associé pour les rappels spécifiques à SubscriptionEngine.

Unions
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 les é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éfinissez la fonction de retour d'événement et le pointeur sur l'objet d'état associé pour les rappels spécifiques à SubscriptionEngine.

Détails
Paramètres
[in] aAppState
Un pointeur vers un 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 "const" au paramètre d'entrée de cet événement
[out] aOutParam
Référence au paramètre de sortie de 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 que la couche application doit appeler 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 "const" au paramètre d'entrée de cet événement
[out] aOutParam
Référence au paramètre de sortie de cet événement

GetInstance

SubscriptionEngine * GetInstance(
  void
)

Récupérez le moteur d'abonnement du singleton.

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

Détails
Renvoie
Un 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 à partir de tous les gestionnaires d'abonnements actifs.

Récupère la position relative minimale (par rapport au 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 de journal minimal pour tous les gestionnaires d'abonnements actifs. Si aucun gestionnaire d'abonnements n'est actif, la valeur reste inchangée. La position du journal est définie sur 0 lors de l'initialisation du gestionnaire d'abonnements.
Valeurs de retour
WEAVE_NO_ERROR
sans conditions

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éfinissez la fonction de retour d'événement et le pointeur sur l'objet d'état associé pour les rappels spécifiques à SubscriptionEngine.

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

SubscriptionEngine

 SubscriptionEngine(
  void
)