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

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

Se trata de un singleton que aloja todas las suscripciones de WDM Next, tanto del cliente como del editor.

Resumen

Constructores y destructores
SubscriptionEngine(void)

Tipos públicos
EventCallback)(void *const aAppState, EventID aEvent, const InEventParam &aInParam, OutEventParam &aOutParam) typedef
void(*
Configura la función de retroceso del evento y el puntero en el objeto de estado asociado para las devoluciones de llamadas específicas de SubscriptionEngine.
EventID enum
Eventos generados directamente a partir de este componente.

Funciones estáticas públicas
DefaultEventHandler(EventID aEvent, const InEventParam & aInParam, OutEventParam & aOutParam)
void
Este es el controlador de eventos predeterminado que llamará la capa de la aplicación para cualquier evento ignorado o no reconocido.
GetInstance(void)
Recupera el motor de suscripción singleton.

Funciones públicas
GetExchangeManager(void) const
GetMinEventLogPosition(size_t & outLogPosition) const
Recupera la posición relativa mínima del punto de descarga del evento de todos los controladores de suscripción activos.
Init(nl::Weave::WeaveExchangeManager *const apExchangeMgr, void *const aAppState, const EventCallback aEventCallback)
SetEventCallback(void *const aAppState, const EventCallback aEventCallback)
void
Configura la función de retroceso del evento y el puntero en el objeto de estado asociado para las devoluciones de llamadas específicas de SubscriptionEngine.

Unión
nl::Weave::Profiles::DataManagement_Current::SubscriptionEngine::InEventParam

Parámetros entrantes enviados con eventos generados directamente desde este componente

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

Los parámetros salientes enviados con eventos generados directamente desde este componente.

Tipos públicos

EventCallback

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

Configura la función de retroceso del evento y el puntero en el objeto de estado asociado para las devoluciones de llamadas específicas de SubscriptionEngine.

Detalles
Parámetros
[in] aAppState
Un puntero para el objeto de estado proporcionado por la capa de aplicación
[in] aEvent
Un puntero de función para la devolución de llamada del evento
[in] aInParam
Una referencia constante al parámetro de entrada para este evento
[out] aOutParam
Una referencia al parámetro de salida para este evento

EventID

 EventID

Eventos generados directamente a partir de este componente.

Funciones estáticas públicas

DefaultEventHandler

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

Este es el controlador de eventos predeterminado que llamará la capa de la aplicación para cualquier evento ignorado o no reconocido.

Detalles
Parámetros
[in] aEvent
Un puntero de función para la devolución de llamada del evento
[in] aInParam
Una referencia constante al parámetro de entrada para este evento
[out] aOutParam
Una referencia al parámetro de salida para este evento

GetInstance

SubscriptionEngine * GetInstance(
  void
)

Recupera el motor de suscripción singleton.

Ten en cuenta que la capa de adopción debe implementar esta función.

Detalles
Qué muestra
Un puntero al motor de suscripciones compartido

Funciones públicas

GetExchangeManager

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

GetMinEventLogPosition

WEAVE_ERROR GetMinEventLogPosition(
  size_t & outLogPosition
) const

Recupera la posición relativa mínima del punto de descarga del evento de todos los controladores de suscripción activos.

Recupera la posición relativa mínima (en relación con el tiempo de inicio) del punto de descarga del evento de todos los controladores de suscripción activos.

Detalles
Parámetros
[in,out] outLogPosition
Punto de descarga de registros mínimo para todos los controladores de suscripción activos. Si no hay controladores de suscripción activos, el valor no se modifica. La posición del registro se establece en 0 cuando se inicializa el controlador de suscripciones.
Valores que se muestran
WEAVE_NO_ERROR
incondicionalmente

Init

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

SetEventCallback

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

Configura la función de retroceso del evento y el puntero en el objeto de estado asociado para las devoluciones de llamadas específicas de SubscriptionEngine.

Detalles
Parámetros
[in] aAppState
Un puntero para el objeto de estado proporcionado por la capa de aplicación
[in] aEventCallback
Un puntero de función para la devolución de llamada del evento

SubscriptionEngine

 SubscriptionEngine(
  void
)