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

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

Este é um Singleton que hospeda todas as assinaturas do WDM Next, do lado do cliente e do editor.

Resumo

Construtores e destrutores
SubscriptionEngine(void)

Tipos públicos
EventCallback)(void *const aAppState, EventID aEvent, const InEventParam &aInParam, OutEventParam &aOutParam) typedef
void(*
Defina a função de retorno do evento e o ponteiro para o objeto de estado associado para retornos de chamada específicos de SubscriptionEngine.
EventID enum
Eventos gerados diretamente desse componente.

Funções estáticas públicas
DefaultEventHandler(EventID aEvent, const InEventParam & aInParam, OutEventParam & aOutParam)
void
Esse é o manipulador de eventos padrão a ser chamado pela camada do aplicativo para qualquer evento ignorado ou não reconhecido.
GetInstance(void)
Recuperar o Subscription Engine Singleton.

Funções públicas
GetExchangeManager(void) const
GetMinEventLogPosition(size_t & outLogPosition) const
Recupere a posição relativa mínima do ponto de descarga do evento de todos os gerenciadores de assinatura ativos.
Init(nl::Weave::WeaveExchangeManager *const apExchangeMgr, void *const aAppState, const EventCallback aEventCallback)
SetEventCallback(void *const aAppState, const EventCallback aEventCallback)
void
Defina a função de retorno do evento e o ponteiro para o objeto de estado associado para retornos de chamada específicos de SubscriptionEngine.

Sindicatos
nl::Weave::Profiles::DataManagement_Current::SubscriptionEngine::InEventParam

Parâmetros de entrada enviados com eventos gerados diretamente por esse componente.

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

Parâmetros de saída enviados com eventos gerados diretamente por esse componente.

Tipos públicos

EventCallback

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

Defina a função de retorno do evento e o ponteiro para o objeto de estado associado para retornos de chamada específicos de SubscriptionEngine.

Detalhes
Parâmetros
[in] aAppState
Um ponteiro para o objeto de estado fornecido pela camada do aplicativo
[in] aEvent
Um ponteiro de função para retorno de chamada do evento
[in] aInParam
Uma referência constante ao parâmetro de entrada deste evento
[out] aOutParam
Uma referência ao parâmetro de saída para este evento

EventID

 EventID

Eventos gerados diretamente desse componente.

Funções estáticas públicas

DefaultEventHandler

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

Esse é o manipulador de eventos padrão a ser chamado pela camada do aplicativo para qualquer evento ignorado ou não reconhecido.

Detalhes
Parâmetros
[in] aEvent
Um ponteiro de função para retorno de chamada do evento
[in] aInParam
Uma referência constante ao parâmetro de entrada deste evento
[out] aOutParam
Uma referência ao parâmetro de saída para este evento

GetInstance

SubscriptionEngine * GetInstance(
  void
)

Recuperar o Subscription Engine Singleton.

Essa função precisa ser implementada pela camada de adoção.

Detalhes
Retorna
Um ponteiro para o mecanismo de assinatura compartilhado

Funções públicas

GetExchangeManager

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

GetMinEventLogPosition

WEAVE_ERROR GetMinEventLogPosition(
  size_t & outLogPosition
) const

Recupere a posição relativa mínima do ponto de descarga do evento de todos os gerenciadores de assinatura ativos.

Recupera a posição mínima relativa (ao tempo de inicialização) do ponto de descarga do evento de todos os manipuladores de assinatura ativos.

Detalhes
Parâmetros
[in,out] outLogPosition
Ponto mínimo de transferência de registros para todos os gerenciadores de assinatura ativos. Se nenhum gerenciador de assinatura estiver ativo, o valor permanecerá inalterado. A posição do registro é definida como 0 na inicialização do gerenciador de assinaturas.
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
)

Defina a função de retorno do evento e o ponteiro para o objeto de estado associado para retornos de chamada específicos de SubscriptionEngine.

Detalhes
Parâmetros
[in] aAppState
Um ponteiro para o objeto de estado fornecido pela camada do aplicativo
[in] aEventCallback
Um ponteiro de função para retorno de chamada do evento

SubscriptionEngine

 SubscriptionEngine(
  void
)