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

Riepilogo

Tipi pubblici
@142 enum
EventCallback)(void *const aAppState, EventID aEvent, const InEventParam &aInParam, OutEventParam &aOutParam) typedef
void(*
EventID enum
HandlerId typedef
uint8_t

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

Funzioni pubbliche
AbortSubscription(void)
void
Questa funzione termina immediatamente una sottoscrizione. Si tratta di una chiamata sincrona.
AcceptSubscribeRequest(const uint32_t aLivenessTimeoutSec)
EndSubscription(const uint32_t aReasonProfileId, const uint16_t aReasonStatusCode)
Questa funzione avvia un arresto controllato della sottoscrizione e la pulizia dell'oggetto gestore.
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

Strutture
nl::Weave::Profiles::DataManagement_Current::SubscriptionHandler::TraitInstanceInfo

Unione
nl::Weave::Profiles::DataManagement_Current::SubscriptionHandler::InEventParam
nl::Weave::Profiles::DataManagement_Current::SubscriptionHandler::OutEventParam

Tipi pubblici

@142

 @142

EventCallback

void(* EventCallback)(void *const aAppState, EventID aEvent, const InEventParam &aInParam, OutEventParam &aOutParam)

EventID

 EventID

HandlerId

uint8_t HandlerId

Funzioni statiche pubbliche

DefaultEventHandler

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

Funzioni pubbliche

AbortSubscription

void AbortSubscription(
  void
)

Questa funzione termina immediatamente una sottoscrizione. Si tratta di una chiamata sincrona.

Interrompere l'abbonamento a un editore.

Non viene effettuato alcun tentativo di notifica al cliente della risoluzione e il contesto di scambio sottostante, se presente, viene interrotto immediatamente. Dopo questa chiamata, l'applicazione non riceverà notifiche relative a ulteriori attività relative a questo oggetto. Inoltre, l'applicazione non potrà interagire con questo oggetto in seguito tramite nessuno dei suoi metodi.

Termina la fine di un abbonamento dell'editore, senza informare il client dell'abbonamento e senza consegnare un evento OnSubscriptionTerminated al gestore di eventi dell'applicazione. Se esiste una sottoscrizione reciproca, viene terminata anche la controscrizione che l'editore ha restituito al cliente.

Dopo aver chiamato AbortSubscription(), l'oggetto SubscriptionHandler entra nello stato Terminated. Se non esistono riferimenti aggiuntivi all'oggetto al termine del processo di terminazione, l'oggetto SubscriptionHandler viene liberato.

AcceptSubscribeRequest

WEAVE_ERROR AcceptSubscribeRequest(
  const uint32_t aLivenessTimeoutSec
)

EndSubscription

WEAVE_ERROR EndSubscription(
  const uint32_t aReasonProfileId,
  const uint16_t aReasonStatusCode
)

Questa funzione avvia un arresto controllato della sottoscrizione e la pulizia dell'oggetto gestore.

Termina automaticamente un abbonamento dell'editore.

Si tratta di una chiamata asincrona e, se pertinente, invierà una notifica al cliente circa l'imminente disattivazione tramite un messaggio SubscribeCancel/StatusReport.

In particolare, ciò rinuncia al coinvolgimento dell'applicazione nell'abbonamento. Dopo questa chiamata, l'applicazione non riceverà notifiche relative a ulteriori attività relative a questo oggetto. Inoltre, l'applicazione non potrà interagire con questo oggetto in seguito tramite nessuno dei suoi metodi.

Termina automaticamente la fine di un abbonamento presso l'editore. Se il supporto per l'annullamento dell'abbonamento è attivato, al client dell'abbonamento viene inviato un messaggio SubscribeCancelRequest e il sistema attende una risposta prima di terminare l'abbonamento. In caso contrario, l'abbonamento viene interrotto immediatamente in modo simile a AbortSubscription(). Se esiste un abbonamento reciproca, anche la contronotifica dell'editore inviata al client viene terminata.

Dettagli
Parametri
[in] aReasonProfileId
ProfileId dello StatusCode che indica il motivo alla base della risoluzione
[in] aReasonStatusCode
StatusCode che indica il motivo della chiusura
Valori restituiti
Returns
un codice di errore Weave solo a scopo informativo. A ogni errore, l'oggetto verrà terminato in modo sincrono (ovvero interrotto).

Durante l'attesa di una risposta a una SubscriptionCancelRequest, il SubscriptionHandler entra nello stato Canceling.

Una volta iniziato il processo di terminazione, l'oggetto SubscriptionHandler entra nello stato Terminated e un evento OnSubscriptionTerminated viene consegnato al gestore di eventi dell'applicazione. Tieni presente che se il supporto per l'annullamento non è abilitato, il gestore di eventi potrebbe essere chiamato in modo sincrono all'interno della chiamata EndSubscription().

Dopo la restituzione del gestore di eventi dell'applicazione, se non ci sono ulteriori riferimenti all'oggetto SubscriptionHandler, l'oggetto viene liberato.

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
)