nl:: Weave:: DataManagement_Current:: DataManagement_Current:: SubscriptionHandler
Resumen
Tipos públicos |
|
---|---|
@142
|
enum |
EventCallback)(void *const aAppState, EventID aEvent, const InEventParam &aInParam, OutEventParam &aOutParam)
|
typedefvoid(*
|
EventID
|
enum |
HandlerId
|
typedefuint8_t
|
Funciones estáticas públicas |
|
---|---|
DefaultEventHandler(EventID aEvent, const InEventParam & aInParam, OutEventParam & aOutParam)
|
void
|
Funciones públicas |
|
---|---|
AbortSubscription(void)
|
void
Esta función resuelve una suscripción de inmediato: esta es una llamada síncrona.
|
AcceptSubscribeRequest(const uint32_t aLivenessTimeoutSec)
|
|
EndSubscription(const uint32_t aReasonProfileId, const uint16_t aReasonStatusCode)
|
Esta función inicia un cierre correcto de la suscripción y la limpieza del objeto del controlador.
|
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
|
Structs |
|
---|---|
nl:: |
Unión |
|
---|---|
nl:: |
|
nl:: |
Tipos públicos
@142
@142
EventCallback
void(* EventCallback)(void *const aAppState, EventID aEvent, const InEventParam &aInParam, OutEventParam &aOutParam)
ID del evento
EventID
ID del controlador
uint8_t HandlerId
Funciones estáticas públicas
DefaultEventHandler.
void DefaultEventHandler( EventID aEvent, const InEventParam & aInParam, OutEventParam & aOutParam )
Funciones públicas
Anular suscripción
void AbortSubscription( void )
Esta función resuelve una suscripción de inmediato: esta es una llamada síncrona.
Anula una suscripción del editor.
No se intentará notificar al cliente sobre la rescisión y el contexto del intercambio subyacente si se anula de inmediato. Después de esta llamada, la aplicación no recibirá notificaciones de ninguna otra actividad en este objeto. Además, la aplicación no puede interactuar con este objeto posteriormente a través de ninguno de sus métodos.
Finaliza el editor al finalizar una suscripción, sin notificar al cliente y sin entregar un evento OnSubscriptionTerminated
al controlador de eventos de la aplicación. Si existe una suscripción mutua, también se cancelará la contranotificación del publicador al cliente.
Cuando llamas a AbortSubscription(), el objeto SubscriptionHandler
pasa al estado Terminated
. Si no hay referencias adicionales al objeto cuando se completa el proceso de finalización, se libera el objeto SubscriptionHandler
.
Aceptar solicitud de suscripción
WEAVE_ERROR AcceptSubscribeRequest( const uint32_t aLivenessTimeoutSec )
Finalizar suscripción
WEAVE_ERROR EndSubscription( const uint32_t aReasonProfileId, const uint16_t aReasonStatusCode )
Esta función inicia un cierre correcto de la suscripción y la limpieza del objeto del controlador.
Finaliza correctamente una suscripción del editor.
Esta es una llamada asíncrona y notificará a un cliente sobre el cierre inminente mediante un mensaje de SubscribeCancel/StatusReport cuando corresponda.
En particular, esta acción renuncia a la participación de la aplicación en esta suscripción. Después de esta llamada, la aplicación no recibirá notificaciones de ninguna otra actividad en este objeto. Además, la aplicación no puede interactuar con este objeto posteriormente a través de ninguno de sus métodos.
Finaliza sin inconvenientes el fin del editor de una suscripción. Si se habilita la compatibilidad con la cancelación de la suscripción, se envía un mensaje de CancelCancelRequest al cliente de suscripción y el sistema espera una respuesta antes de cerrarla. De lo contrario, la suscripción se cancela de forma similar a AbortSubscription(). Si existe una suscripción mutua, también se cancelará la contranotificación del publicador al cliente.
Detalles | |||||
---|---|---|---|---|---|
Parámetros |
|
||||
Valores que se muestran |
|
Mientras esperas una respuesta a una solicitud de CancelCancelRequest, SubscriptionHandler
pasa al estado Canceling
.
Una vez que comienza el proceso de finalización, el objeto SubscriptionHandler
pasa al estado Terminated
y se entrega un evento OnSubscriptionTerminated
al controlador de eventos de la aplicación. Ten en cuenta que, si no se habilita la compatibilidad con la cancelación, se puede llamar al controlador del evento de forma síncrona dentro de la llamada a EndSubscription().
Una vez que se muestra el controlador de eventos de la aplicación, si no hay referencias adicionales al objeto SubscriptionHandler
, se libera el objeto.
GetBinding
Binding * GetBinding( void ) const
GetMaxNotificationSize
uint32_t GetMaxNotificationSize( void ) const
ID de GetPeerNode
uint64_t GetPeerNodeId( void ) const
ID de suscripción
WEAVE_ERROR GetSubscriptionId( uint64_t *const apSubscriptionId )
IsActive
bool IsActive( void )
Se está cancelando
bool IsCanceling() const
está establecida
bool IsEstablishedIdle()
Es gratuita
bool IsFree()
Terminado
bool IsTerminated()
Tamaño de la notificación de configuración máxima
void SetMaxNotificationSize( const uint32_t aMaxPayload )