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

Resumen

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

Funciones estáticas públicas
DefaultEventHandler(EventID aEvent, const InEventParam & aInParam, OutEventParam & aOutParam)
void

Funciones públicas
AbortSubscription(void)
void
Esta función finaliza 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 una limpieza del objeto del controlador.
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

Structs
nl::Weave::Profiles::DataManagement_Current::SubscriptionHandler::TraitInstanceInfo

Uniones
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

Funciones estáticas públicas

DefaultEventHandler

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

Funciones públicas

AbortSubscription

void AbortSubscription(
  void
)

Esta función finaliza una suscripción de inmediato; esta es una llamada síncrona.

Anula la suscripción de un editor.

No se intenta notificar al cliente sobre la rescisión, y se anula de inmediato el contexto subyacente de intercambio, si está presente. Después de esta llamada, la aplicación no recibirá ninguna notificación sobre ninguna actividad adicional en este objeto. Además, la aplicación no puede interactuar con este objeto a partir de ese momento a través de ninguno de sus métodos.

Finaliza el final del publicador de una suscripción, sin notificar al cliente de suscripción y sin entregar un evento OnSubscriptionTerminated al controlador de eventos de la aplicación. Si existe una suscripción mutua, la suscripción de contador del editor al cliente también se cancela.

Cuando se llama a AbortSubscription(), el objeto SubscriptionHandler entra en el estado Terminated. Si no hay referencias adicionales al objeto cuando se completa el proceso de finalización, se libera el objeto SubscriptionHandler.

AcceptSubscribeRequest

WEAVE_ERROR AcceptSubscribeRequest(
  const uint32_t aLivenessTimeoutSec
)

EndSubscription

WEAVE_ERROR EndSubscription(
  const uint32_t aReasonProfileId,
  const uint16_t aReasonStatusCode
)

Esta función inicia un cierre correcto de la suscripción y una limpieza del objeto del controlador.

Finaliza correctamente la suscripción del editor.

Esta es una llamada asíncrona y notificará a un cliente sobre el cierre inminente a través de un mensaje 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á ninguna notificación sobre ninguna actividad adicional en este objeto. Además, la aplicación no puede interactuar con este objeto a partir de ese momento a través de ninguno de sus métodos.

Finaliza de manera correcta el final del publicador de una suscripción. Si está habilitada la compatibilidad con la cancelación de la suscripción, se envía un mensaje de SubscribeCancelRequest al cliente de la suscripción y el sistema espera una respuesta antes de finalizar la suscripción. De lo contrario, la suscripción se cancela inmediatamente de manera similar a AbortSubscription(). Si existe una suscripción mutua, la suscripción de contador del editor al cliente también se cancela.

Detalles
Parámetros
[in] aReasonProfileId
ProfileId del StatusCode que indica el motivo del cierre
[in] aReasonStatusCode
StatusCode que indica el motivo del cierre
Valores de retorno
Returns
un código de error de Weave solo con fines informativos. Ante cualquier error, el objeto se finalizará de manera síncrona (es decir, se anulará).

Mientras esperas una respuesta a SubscribeCancelRequest, SubscriptionHandler pasa al estado Canceling.

Una vez que comienza el proceso de finalización, el objeto SubscriptionHandler entra al estado Terminated y se entrega un evento OnSubscriptionTerminated al controlador de eventos de la aplicación. Ten en cuenta que, si la compatibilidad con la cancelación no está habilitada, el controlador de eventos se puede llamar de forma síncrona dentro de la llamada a EndSubscription().

Cuando 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

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
)