O Google tem o compromisso de promover a igualdade racial para as comunidades negras. Saiba como.

nl :: Tecer:: Perfis :: Batimento cardiaco:: WeaveHeartbeatSender

#include <src/lib/profiles/heartbeat/WeaveHeartbeat.h>

Weave pulsação classe Sender.

Resumo

Construtores e Destruidores

WeaveHeartbeatSender (void)

Tipos públicos

EventCallback )(void *appState, EventType eventType, const InEventParam &inParam, OutEventParam &outParam) typedef
void(*
EventType {
kEvent_UpdateSubscriptionState = 1,
kEvent_HeartbeatSent = 2,
kEvent_HeartbeatFailed = 3,
kEvent_DefaultCheck = 100
}
enum

Atributos públicos

AppState
void *

Funções públicas

GetBinding () const
Obtenha o objeto de ligação associado ao remetente de pulsação.
GetConfiguration (uint32_t & interval, uint32_t & phase, uint32_t & window) const
void
Obtenha a configuração de tempo de pulsação.
GetEventCallback () const
EventCallback
Retorna a função que será chamada para notificar a aplicação de eventos ou mudanças que ocorrem no WeaveHeartbeatSender .
GetRequestAck () const
bool
Retorna um sinalizador que indica se as mensagens de pulsação serão enviadas de maneira confiável usando o Weave Reliable Messaging.
GetSubscriptionState () const
uint8_t
Obtenha o valor do estado da assinatura atual.
Init ( WeaveExchangeManager *exchangeMgr, Binding *binding, EventCallback eventCallback, void *appState)
Inicializar o Weave pulsação Sender.
ScheduleHeartbeat (void)
Agende o envio de Weave Pulsação mensagens.
SendHeartbeatNow (void)
Enviar Weave pulsação mensagem agora.
SetConfiguration (uint32_t interval, uint32_t phase, uint32_t window)
void
Defina a configuração de tempo de pulsação.
SetEventCallback (EventCallback eventCallback)
void
Define a função que será chamada para notificar a aplicação de eventos ou mudanças que ocorrem no WeaveHeartbeatSender .
SetRequestAck (bool val)
void
Define um sinalizador que indica se as mensagens de pulsação devem ser enviadas de maneira confiável usando Weave Reliable Messaging.
SetSubscriptionState (uint8_t val)
void
Defina o estado da assinatura atual.
Shutdown (void)
Desligamento do Weave pulsação Sender.
StartHeartbeat (void)
Começar a enviar Weave Pulsação mensagens.
StopHeartbeat (void)
Parar de enviar Weave Pulsação mensagens.

Funções estáticas públicas

DefaultEventHandler (void *appState, EventType eventType, const InEventParam & inParam, OutEventParam & outParam)
void
Função de manipulador padrão para WeaveHeartbeatSender eventos API.

Structs

nl :: Weave :: Profiles :: pulsação :: WeaveHeartbeatSender :: InEventParam

Parâmetros de entrada para WeaveHeartbeatSender evento API.

nl :: Weave :: Profiles :: pulsação :: WeaveHeartbeatSender :: OutEventParam

Parâmetros de saída para WeaveHeartbeatSender evento API.

Tipos públicos

EventCallback

void(* EventCallback)(void *appState, EventType eventType, const InEventParam &inParam, OutEventParam &outParam)

Tipo de evento

 EventType
Propriedades
kEvent_DefaultCheck

Usado para verificar o tratamento de eventos padrão correto no aplicativo.

Os aplicativos NÃO devem lidar expressamente com esse evento.

kEvent_HeartbeatFailed

Uma mensagem de pulsação falhou ao ser enviada ao par.

kEvent_HeartbeatSent

Uma mensagem de pulsação foi enviada com sucesso ao par.

Se a transmissão confiável estiver habilitada, este evento indica que a mensagem foi confirmada.

kEvent_UpdateSubscriptionState

O aplicativo é solicitado a atualizar o estado da assinatura.

Atributos públicos

AppState

void * AppState

Funções públicas

GetBinding

Binding * GetBinding() const 

Obtenha o objeto de ligação associado ao remetente de pulsação.

GetConfiguration

void GetConfiguration(
  uint32_t & interval,
  uint32_t & phase,
  uint32_t & window
) const 

Obtenha a configuração de tempo de pulsação.

Detalhes
Parâmetros
[out] interval
Uma referência a um número inteiro para receber o intervalo de pulsação.
[out] phase
Uma referência a um número inteiro para receber a fase de pulsação.
[out] window
Uma referência a um número inteiro para receber a janela de randomização de pulsação.

GetEventCallback

EventCallback GetEventCallback() const 

Retorna a função que será chamada para notificar a aplicação de eventos ou mudanças que ocorrem no WeaveHeartbeatSender .

GetRequestAck

bool GetRequestAck() const 

Retorna um sinalizador que indica se as mensagens de pulsação serão enviadas de maneira confiável usando o Weave Reliable Messaging.

GetSubscriptionState

uint8_t GetSubscriptionState() const 

Obtenha o valor do estado da assinatura atual.

Iniciar

WEAVE_ERROR Init(
  WeaveExchangeManager *exchangeMgr,
  Binding *binding,
  EventCallback eventCallback,
  void *appState
)

Inicializar o Weave pulsação Sender.

Detalhes
Parâmetros
[in] exchangeMgr
Um ponteiro para o sistema Weave Exchange Manager.
[in] binding
Um ponteiro para um objeto de ligação Weave que será usado para endereçar o nó par.
[in] eventCallback
Um ponteiro para uma função que será chamada para notificar a aplicação de eventos ou mudanças de estado que ocorrem no remetente.
[in] appState
Um ponteiro para dados específicos do aplicativo. Este ponteiro será retornado em retornos de chamada para o aplicativo.
Valores Retornados
WEAVE_ERROR_INCORRECT_STATE
Se o WeaveHeartbeatSender objeto já foi inicializado.
WEAVE_ERROR_INVALID_ARGUMENT
Se algum dos argumentos fornecidos for nulo.
WEAVE_NO_ERROR
Com sucesso.

ScheduleHeartbeat

WEAVE_ERROR ScheduleHeartbeat(
  void
)

Agende o envio de Weave Pulsação mensagens.

Detalhes
Valores Retornados
WEAVE_SYSTEM_ERROR_NO_MEMORY
se StartTimer () falhou
WEAVE_NO_ERROR
no sucesso

SendHeartbeatNow

WEAVE_ERROR SendHeartbeatNow(
  void
)

Enviar Weave pulsação mensagem agora.

Detalhes
Valores Retornados
WEAVE_ERROR_INCORRECT_STATE
se WeaveHeartbeatSender não é inicializado
WEAVE_NO_ERROR
no sucesso

SetConfiguration

void SetConfiguration(
  uint32_t interval,
  uint32_t phase,
  uint32_t window
)

Defina a configuração de tempo de pulsação.

Detalhes
Parâmetros
[in] interval
Intervalo para usar quando enviar Weave Pulsação mensagens.
[in] phase
Fase para usar quando enviar Weave Pulsação mensagens.
[in] window
Intervalo da janela a ser usado para escolher o intervalo aleatório

SetEventCallback

void SetEventCallback(
  EventCallback eventCallback
)

Define a função que será chamada para notificar a aplicação de eventos ou mudanças que ocorrem no WeaveHeartbeatSender .

SetRequestAck

void SetRequestAck(
  bool val
)

Define um sinalizador que indica se as mensagens de pulsação devem ser enviadas de maneira confiável usando o Weave Reliable Messaging.

Observe que este sinalizador só é significativo ao usar UDP como um transporte.

Detalhes
Parâmetros
[in] val
Verdadeiro se as mensagens de pulsação devem ser enviadas de maneira confiável.

SetSubscriptionState

void SetSubscriptionState(
  uint8_t val
)

Defina o estado da assinatura atual.

Detalhes
Parâmetros
[in] val
Um valor de estado de assinatura de 8 bits a ser transmitido com a mensagem de pulsação.

Desligar

WEAVE_ERROR Shutdown(
  void
)

Desligamento do Weave pulsação Sender.

Detalhes
Valores Retornados
WEAVE_NO_ERROR
Com sucesso.

StartHeartbeat

WEAVE_ERROR StartHeartbeat(
  void
)

Começar a enviar Weave Pulsação mensagens.

Detalhes
Valores Retornados
INET_ERROR_NO_MEMORY
se StartTimer () falhou
WEAVE_NO_ERROR
no sucesso

StopHeartbeat

WEAVE_ERROR StopHeartbeat(
  void
)

Parar de enviar Weave Pulsação mensagens.

Detalhes
Valores Retornados
WEAVE_NO_ERROR
incondicionalmente

WeaveHeartbeatSender

 WeaveHeartbeatSender(
  void
)

Funções estáticas públicas

DefaultEventHandler

void DefaultEventHandler(
  void *appState,
  EventType eventType,
  const InEventParam & inParam,
  OutEventParam & outParam
)

Função de manipulador padrão para WeaveHeartbeatSender eventos API.

Os aplicativos devem chamar essa função para quaisquer eventos de API que eles não manipulam.