nl :: Tecer:: Perfis :: DataManagement_Current :: SubscriptionEngine

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

Este é um singleton que hospeda todas as assinaturas WDM Next, tanto do lado do cliente quanto do editor.

Resumo

Construtores e Destruidores

SubscriptionEngine (void)

Tipos públicos

EventCallback )(void *const aAppState, EventID aEvent, const InEventParam &aInParam, OutEventParam &aOutParam) typedef
void(*
Definir a função de evento para trás e ponteiro para objeto de estado associado para SubscriptionEngine chamada costas específico.
EventID enum
Eventos gerados diretamente a partir deste componente.

Funções estáticas públicas

DefaultEventHandler ( EventID aEvent, const InEventParam & aInParam, OutEventParam & aOutParam)
void
Este é o manipulador de eventos padrão a ser chamado pela camada do aplicativo para qualquer evento ignorado ou não reconhecido.
GetInstance (void)
Recupere o mecanismo de assinatura singleton.

Funções públicas

GetExchangeManager (void) const
GetMinEventLogPosition (size_t & outLogPosition) const
Recupere a posição relativa mínima do ponto de transferência do evento de todos os manipuladores de assinatura ativos.
Init ( nl::Weave::WeaveExchangeManager *const apExchangeMgr, void *const aAppState, const EventCallback aEventCallback)
SetEventCallback (void *const aAppState, const EventCallback aEventCallback)
void
Definir a função de evento para trás e ponteiro para objeto de estado associado para SubscriptionEngine chamada costas específico.

Sindicatos

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

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

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

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

Tipos públicos

EventCallback

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

Definir a função de evento para trás e ponteiro para objeto de estado associado para SubscriptionEngine chamada costas específico.

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

EventID

 EventID

Eventos gerados diretamente a partir deste componente.

Funções estáticas públicas

DefaultEventHandler

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

Este é 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 de evento
[in] aInParam
Uma referência constante para o parâmetro de entrada para este evento
[out] aOutParam
Uma referência ao parâmetro de saída para este evento

GetInstance

SubscriptionEngine * GetInstance(
  void
)

Recupere o mecanismo de assinatura singleton.

Observe que esta função deve ser implementada pela camada de adoção.

Detalhes
Devoluções
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 transferência do evento de todos os manipuladores de assinatura ativos.

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

Detalhes
Parâmetros
[in,out] outLogPosition
Ponto de descarregamento de log mínimo para todos os manipuladores de assinatura ativos. Se nenhum manipulador de assinatura estiver ativo, o valor permanecerá inalterado. A posição do log é definida como 0 na inicialização do manipulador de assinatura.
Valores Retornados
WEAVE_NO_ERROR
incondicionalmente

Iniciar

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

SetEventCallback

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

Definir a função de evento para trás e ponteiro para objeto de estado associado para SubscriptionEngine chamada costas específico.

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

SubscriptionEngine

 SubscriptionEngine(
  void
)