nl::Weave::Profiles::DataManagement_Current::SubscriptionHandler

Resumo

Tipos públicos
@142 enum
EventCallback)(void *const aAppState, EventID aEvent, const InEventParam &aInParam, OutEventParam &aOutParam) typedef
void(*
EventID enum
HandlerId typedef
uint8_t

Funções estáticas públicas
DefaultEventHandler(EventID aEvent, const InEventParam & aInParam, OutEventParam & aOutParam)
void

Funções públicas
AbortSubscription(void)
void
Essa função encerra uma assinatura imediatamente. Esta é uma chamada síncrona.
AcceptSubscribeRequest(const uint32_t aLivenessTimeoutSec)
EndSubscription(const uint32_t aReasonProfileId, const uint16_t aReasonStatusCode)
Essa função inicia um encerramento sem dificuldades da assinatura e uma limpeza do objeto gerenciador.
GetBinding(void) const
GetMaxNotificationSize(void) const
uint32_t
GetPeerNodeId(void) const
uint64_t
GetSubscriptionId(uint64_t *const apSubscriptionId)
IsActive(void)
bool
IsCanceling() const
bool
IsEstablishedIdle()
bool
IsFree()
bool
IsTerminated()
bool
SetMaxNotificationSize(const uint32_t aMaxPayload)
void

Estruturas
nl::Weave::Profiles::DataManagement_Current::SubscriptionHandler::TraitInstanceInfo

União
nl::Weave::Profiles::DataManagement_Current::SubscriptionHandler::InEventParam
nl::Weave::Profiles::DataManagement_Current::SubscriptionHandler::OutEventParam

Tipos públicos

@142

 @142

EventCallback

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

EventID

 EventID

HandlerId

uint8_t HandlerId

Funções estáticas públicas

DefaultEventHandler

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

Funções públicas

AbortSubscription

void AbortSubscription(
  void
)

Essa função encerra uma assinatura imediatamente. Esta é uma chamada síncrona.

Cancelar a assinatura de um editor.

Não é feita nenhuma tentativa de notificar o cliente sobre a rescisão, e o contexto de troca subjacente, se presente, é abortado imediatamente. Após a chamada, o aplicativo não será notificado sobre nenhuma outra atividade no objeto. Além disso, o aplicativo não tem permissão para interagir com esse objeto posteriormente por nenhum dos métodos dele.

Encerra o final de uma assinatura do editor sem notificar o cliente de assinatura e sem enviar um evento OnSubscriptionTerminated ao manipulador de eventos do aplicativo. Se houver uma assinatura mútua, a inscrição da contração do editor de volta ao cliente também será encerrada.

Ao chamar AbortSubscription(), o objeto SubscriptionHandler entrará no estado Terminated. Se não houver outras referências ao objeto quando o processo de encerramento for concluído, o objeto SubscriptionHandler será liberado.

AcceptSubscribeRequest

WEAVE_ERROR AcceptSubscribeRequest(
  const uint32_t aLivenessTimeoutSec
)

EndSubscription

WEAVE_ERROR EndSubscription(
  const uint32_t aReasonProfileId,
  const uint16_t aReasonStatusCode
)

Essa função inicia um encerramento sem dificuldades da assinatura e uma limpeza do objeto gerenciador.

Encerre uma assinatura de editor de maneira prática.

Essa é uma chamada assíncrona e notificará um cliente sobre o encerramento iminente por meio de uma mensagem SubscriptionCancel/StatusReport, quando relevante.

Isso renuncia ao envolvimento do aplicativo nessa assinatura. Após a chamada, o aplicativo não será notificado sobre nenhuma outra atividade no objeto. Além disso, o aplicativo não tem permissão para interagir com esse objeto posteriormente por nenhum dos métodos dele.

Encerra corretamente o final de uma assinatura do editor. Se o suporte ao cancelamento de assinatura estiver ativado, uma mensagem SubscriptionCancelRequest será enviada ao cliente da assinatura e o sistema aguardará uma resposta antes de encerrar a assinatura. Caso contrário, a assinatura será imediatamente encerrada de maneira semelhante a AbortSubscription(). Se houver uma assinatura mútua, a inscrição da contração do editor de volta ao cliente também será encerrada.

Detalhes
Parâmetros
[in] aReasonProfileId
ProfileId do StatusCode que indica o motivo por trás do encerramento
[in] aReasonStatusCode
StatusCode que indica o motivo por trás do encerramento
Valores de retorno
Returns
um código de erro do Weave somente para fins informativos. Em qualquer erro, o objeto será encerrado de forma síncrona (ou seja, cancelado).

Enquanto aguarda uma resposta para um SubscriptionCancelRequest, o SubscriptionHandler entra no estado Canceling.

Quando o processo de encerramento começa, o objeto SubscriptionHandler entra no estado Terminated e um evento OnSubscriptionTerminated é entregue ao manipulador de eventos do aplicativo. Se o suporte ao cancelamento não estiver ativado, o manipulador de eventos poderá ser chamado de forma síncrona dentro da chamada para EndSubscription().

Depois que o manipulador de eventos do aplicativo retornar, se não houver referências adicionais ao objeto SubscriptionHandler, o objeto será liberado.

GetBinding

Binding * GetBinding(
  void
) const

GetMaxNotificationSize

uint32_t GetMaxNotificationSize(
  void
) const

GetPeerNodeId

uint64_t GetPeerNodeId(
  void
) const

GetSubscriptionId

WEAVE_ERROR GetSubscriptionId(
  uint64_t *const apSubscriptionId
)

IsActive

bool IsActive(
  void
)

IsCanceling

bool IsCanceling() const

IsEstablishedIdle

bool IsEstablishedIdle()

IsFree

bool IsFree()

IsTerminated

bool IsTerminated()

SetMaxNotificationSize

void SetMaxNotificationSize(
  const uint32_t aMaxPayload
)