nl:: Weave:: Profiles:: DataManagement_Current:: SubscriptionHandler
Resumo
Tipos públicos |
|
---|---|
@142
|
enum |
EventCallback)(void *const aAppState, EventID aEvent, const InEventParam &aInParam, OutEventParam &aOutParam)
|
typedefvoid(*
|
EventID
|
enum |
HandlerId
|
typedefuint8_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. Essa é uma chamada síncrona.
|
AcceptSubscribeRequest(const uint32_t aLivenessTimeoutSec)
|
|
EndSubscription(const uint32_t aReasonProfileId, const uint16_t aReasonStatusCode)
|
Essa função inicia um encerramento otimizado da assinatura e a limpeza do objeto do gerenciador.
|
GetBinding(void) const
|
Binding *
|
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:: |
Sindicatos |
|
---|---|
nl:: |
|
nl:: |
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. Essa é uma chamada síncrona.
cancelar uma assinatura de editor;
Nenhuma tentativa de notificar o cliente sobre o encerramento é feita, e o contexto da troca subjacente, se presente, é cancelado imediatamente. Após essa chamada, o aplicativo não será notificado sobre nenhuma outra atividade nesse objeto. Além disso, o aplicativo não tem permissão para interagir com esse objeto posteriormente usando nenhum dos métodos dele.
Encerra o término de uma assinatura do editor sem notificar o cliente da assinatura e sem entregar um evento OnSubscriptionTerminated
ao manipulador de eventos do aplicativo. Se houver uma assinatura mútua, a assinatura de contagem do editor de volta para o cliente também será encerrada.
Ao chamar AbortSubscription(), o objeto SubscriptionHandler
entra 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 otimizado da assinatura e a limpeza do objeto do gerenciador.
Encerre uma assinatura de editor sem dificuldades.
Trata-se de uma chamada assíncrona que notificará um cliente sobre o encerramento iminente por meio de uma mensagem SubscribeCancel/StatusReport quando relevante.
Isso renuncia ao envolvimento do aplicativo nessa assinatura. Após essa chamada, o aplicativo não será notificado sobre nenhuma outra atividade nesse objeto. Além disso, o aplicativo não tem permissão para interagir com esse objeto posteriormente usando nenhum dos métodos dele.
Encerra o final de uma assinatura do editor. Se o suporte ao cancelamento da assinatura estiver ativado, uma mensagem SubscribeCancelRequest será enviada ao cliente de assinatura e o sistema aguardará uma resposta antes de encerrá-la. Caso contrário, a assinatura será encerrada imediatamente de maneira semelhante a AbortSubscription(). Se houver uma assinatura mútua, a assinatura de contranotificação do editor para o cliente também será encerrada.
Detalhes | |||||
---|---|---|---|---|---|
Parâmetros |
|
||||
Valores de retorno |
|
Enquanto aguarda uma resposta a um SubscribeCancelRequest, o SubscriptionHandler
entra no estado Canceling
.
Assim que 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 para cancelamento não estiver ativado, o manipulador de eventos poderá ser chamado de forma síncrona na chamada para EndSubscription().
Depois que o manipulador de eventos do aplicativo retornar, se não houver outras referências 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 )