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

Unión
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.

Anular la suscripción del editor

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

Finaliza el final de una suscripción por parte del editor, 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, también se cancela la suscripción de contador del editor al cliente.

Después de llamar 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, esto 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 relacionada con este objeto. Además, la aplicación no podrá interactuar con este objeto a partir de ese momento a través de ninguno de sus métodos.

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

Detalles
Parámetros
[in] aReasonProfileId
ProfileId del StatusCode que indica el motivo de la rescisión
[in] aReasonStatusCode
StatusCode que indica el motivo de la rescisión
Valores que se muestran
Returns
un código de error de Weave solo con fines informativos. En caso de que se produzca un error, el objeto se finalizará de manera síncrona (es decir, se anulará).

Mientras se espera una respuesta a una SubscribeCancelRequest, el SubscriptionHandler entra en el estado Canceling.

Una vez que se inicia el proceso de finalización, el objeto SubscriptionHandler entra en el 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, se puede llamar al controlador de eventos de forma síncrona dentro de la llamada a EndSubscription().

Una vez que devuelve el controlador de eventos de la aplicación, si no hay referencias adicionales al objeto SubscriptionHandler, este se libera.

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
)