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

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

Este es un singleton que aloja todas las suscripciones a WDM Next, tanto del lado del cliente como del publicador.

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 llamada específicas de SubscriptionEngine.
EventID enum
Eventos generados directamente desde este componente

Funciones estáticas públicas
DefaultEventHandler(EventID aEvent, const InEventParam & aInParam, OutEventParam & aOutParam)
void
Este es el controlador de eventos predeterminado que debe 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 suscripciones 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 llamada específicas de SubscriptionEngine.

Uniones
nl::Weave::Profiles::DataManagement_Current::SubscriptionEngine::InEventParam

Parámetros entrantes que se envían con eventos generados directamente desde este componente.

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

Parámetros de salida 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 llamada específicas de SubscriptionEngine.

Detalles
Parámetros
[in] aAppState
Un puntero para el objeto de estado proporcionado por la capa de la aplicación
[in] aEvent
Un puntero a función para la devolución de llamada de eventos
[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 desde 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 debe llamar la capa de la aplicación para cualquier evento ignorado o no reconocido.

Detalles
Parámetros
[in] aEvent
Un puntero a función para la devolución de llamada de eventos
[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 esta función se debe implementar a través de la capa de adopción.

Detalles
Resultado que se muestra
Un puntero al Motor de suscripción 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 suscripciones activos.

Recupera la posición relativa mínima (con respecto al 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 mínimo de registro para todos los controladores de suscripciones 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 la suscripción.
Valores de retorno
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 llamada específicas de SubscriptionEngine.

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

SubscriptionEngine

 SubscriptionEngine(
  void
)