En Google, luchamos por la equidad racial de la comunidad negra. Más información

nl :: Tejido:: Perfiles: DataManagement_Current :: SubscriptionHandler

Resumen

Tipos públicos

@142 enumeración
EventCallback )(void *const aAppState, EventID aEvent, const InEventParam &aInParam, OutEventParam &aOutParam) typedef
void(*
EventID enumeración
HandlerId typedef
uint8_t

Funciones estáticas públicas

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

Funciones publicas

AbortSubscription (void)
void
Esta función finaliza una suscripción inmediatamente; se trata de una llamada sincrónica.
AcceptSubscribeRequest (const uint32_t aLivenessTimeoutSec)
EndSubscription (const uint32_t aReasonProfileId, const uint16_t aReasonStatusCode)
Esta función inicia un cierre ordenado de la suscripción y la limpieza del objeto 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

Estructuras

nl :: Armadura :: Perfiles :: DataManagement_Current :: :: SubscriptionHandler TraitInstanceInfo

Sindicatos

nl :: Armadura :: Perfiles :: DataManagement_Current :: :: SubscriptionHandler InEventParam
nl :: Armadura :: Perfiles :: 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 publicas

AbortSubscription

void AbortSubscription(
  void
)

Esta función finaliza una suscripción inmediatamente; se trata de una llamada sincrónica.

Cancelar una suscripción de editor.

No se intenta notificar al cliente de la terminación, y el contexto de intercambio subyacente, si está presente, se cancela inmediatamente. Después de esta llamada, la aplicación no será notificada de ninguna actividad adicional en este objeto. Además, la aplicación no puede interactuar con este objeto a partir de entonces a través de ninguno de sus métodos.

Termina al final del editor de una suscripción, sin notificar al cliente de suscripción y sin la entrega de un OnSubscriptionTerminated caso de controlador de eventos de la aplicación. Si existe una suscripción mutua, la contra suscripción del editor al cliente también se cancela.

Al llamar AbortSubscription () , el SubscriptionHandler objeto entra en el Terminated estado. Si no hay referencias adicionales al objeto cuando se complete el proceso de terminación, el SubscriptionHandler objeto se libera.

AceptarSuscribirseSolicitar

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 ordenado de la suscripción y la limpieza del objeto controlador.

Finalice correctamente una suscripción de editor.

Esta es una llamada asincrónica y notificará al cliente del cierre inminente a través de un mensaje SubscribeCancel / StatusReport cuando sea relevante.

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 será notificada de ninguna actividad adicional en este objeto. Además, la aplicación no puede interactuar con este objeto a partir de entonces a través de ninguno de sus métodos.

Termina correctamente la finalización de una suscripción por parte del editor. Si el soporte de cancelación de suscripción está habilitado, se envía un mensaje SubscribeCancelRequest al cliente de suscripción y el sistema espera una respuesta antes de finalizar la suscripción; de lo contrario la suscripción se termina inmediatamente en una manera similar a AbortSubscription () . Si existe una suscripción mutua, la contra suscripción del editor al cliente también se cancela.

Detalles
Parámetros
[in] aReasonProfileId
ProfileId del StatusCode que indica el motivo de la terminación
[in] aReasonStatusCode
StatusCode que indica el motivo de la rescisión
Valores devueltos
Returns
un código de error de Weave solo con fines informativos. Ante cualquier error, el objeto se terminará sincrónicamente (es decir, se cancelará).

A la espera de una respuesta a una SubscribeCancelRequest, la SubscriptionHandler entra en la Canceling estado.

Una vez que comienza el proceso de terminación, el SubscriptionHandler objeto entra en el Terminated estado y un OnSubscriptionTerminated evento se entrega al gestor de eventos de la aplicación. Tenga en cuenta que, si cancelar el apoyo no está habilitado, el controlador de eventos se puede llamar de forma sincrónica dentro de la llamada a EndSubscription () .

Después de retornos de control de eventos de la aplicación, si no hay referencias adicionales a la SubscriptionHandler objeto, el objeto 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
)

Está activo

bool IsActive(
  void
)

Está cancelando

bool IsCanceling() const 

Está Establecido Inactivo

bool IsEstablishedIdle()

Está libre

bool IsFree()

Esta terminado

bool IsTerminated()

SetMaxNotificationSize

void SetMaxNotificationSize(
  const uint32_t aMaxPayload
)