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

Zusammenfassung

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

Öffentliche statische Funktionen
DefaultEventHandler(EventID aEvent, const InEventParam & aInParam, OutEventParam & aOutParam)
void

Öffentliche Funktionen
AbortSubscription(void)
void
Diese Funktion beendet ein Abo sofort – dies ist ein synchroner Aufruf.
AcceptSubscribeRequest(const uint32_t aLivenessTimeoutSec)
EndSubscription(const uint32_t aReasonProfileId, const uint16_t aReasonStatusCode)
Diese Funktion initiiert ein ordnungsgemäßes Herunterfahren des Abos und eine Bereinigung des Handler-Objekts.
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

Strukturen
nl::Weave::Profiles::DataManagement_Current::SubscriptionHandler::TraitInstanceInfo

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

Öffentliche Typen

@142

 @142

EventCallback

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

EventID

 EventID

HandlerId

uint8_t HandlerId

Öffentliche statische Funktionen

DefaultEventHandler

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

Öffentliche Funktionen

AbortSubscription

void AbortSubscription(
  void
)

Diese Funktion beendet ein Abo sofort – dies ist ein synchroner Aufruf.

Ein Abo beim Verlag oder Webpublisher abbrechen

Es wird nicht versucht, den Kunden über die Beendigung zu informieren, und der zugrunde liegende Kontext der Anzeigenplattform wird, falls vorhanden, sofort abgebrochen. Nach diesem Aufruf wird die Anwendung nicht mehr über weitere Aktivitäten zu diesem Objekt informiert. Außerdem darf die Anwendung anschließend über keine ihrer Methoden mit diesem Objekt interagieren.

Beendet das Abo des Verlags oder Webpublishers, ohne den Aboclient zu benachrichtigen oder ein OnSubscriptionTerminated-Ereignis an den Event-Handler der Anwendung zu senden. Wenn ein gemeinsames Abonnement besteht, wird auch das Gegenabonnement vom Verlag oder Webpublisher an den Kunden beendet.

Beim Aufrufen von AbortSubscription() wechselt das Objekt SubscriptionHandler in den Status Terminated. Wenn es nach Abschluss des Beendigungsvorgangs keine weiteren Verweise auf das Objekt gibt, wird das Objekt SubscriptionHandler freigegeben.

AcceptSubscribeRequest

WEAVE_ERROR AcceptSubscribeRequest(
  const uint32_t aLivenessTimeoutSec
)

EndSubscription

WEAVE_ERROR EndSubscription(
  const uint32_t aReasonProfileId,
  const uint16_t aReasonStatusCode
)

Diese Funktion initiiert ein ordnungsgemäßes Herunterfahren des Abos und eine Bereinigung des Handler-Objekts.

Ein Abo beim Verlag oder Webpublisher wird ordnungsgemäß gekündigt.

Dies ist ein asynchroner Aufruf und informiert einen Kunden gegebenenfalls mit einer SubscribeCancel/StatusReport-Nachricht über das bevorstehende Herunterfahren.

Insbesondere wird dadurch die Beteiligung der Anwendung an diesem Abonnement ausgesetzt. Nach diesem Aufruf wird die Anwendung nicht mehr über weitere Aktivitäten zu diesem Objekt informiert. Außerdem darf die Anwendung anschließend über keine ihrer Methoden mit diesem Objekt interagieren.

Kündigt das Abo des Verlags oder Webpublishers ordnungsgemäß. Wenn die Unterstützung für die Abokündigung aktiviert ist, wird eine „SubscribeCancelRequest“-Nachricht an den Aboclient gesendet und das System wartet auf eine Antwort, bevor das Abo gekündigt wird. Andernfalls wird das Abo sofort, ähnlich wie bei AbortSubscription(), beendet. Wenn ein gemeinsames Abo besteht, wird auch das Gegenabo vom Verlag oder Webpublisher an den Kunden gekündigt.

Details
Parameter
[in] aReasonProfileId
ProfileId des Statuscodes, der den Grund für die Beendigung angibt
[in] aReasonStatusCode
Statuscode, der den Grund für die Kündigung angibt
Rückgabewerte
Returns
Ein Weave-Fehlercode nur zu Informationszwecken. Bei jedem Fehler wird das Objekt synchron beendet (d. h. abgebrochen).

Während SubscriptionHandler auf eine Antwort auf eine „SubscribeCancelRequest“ wartet, wechselt sie in den Status Canceling.

Sobald der Beendigungsprozess beginnt, wechselt das Objekt SubscriptionHandler in den Status Terminated und ein OnSubscriptionTerminated-Ereignis wird an den Event-Handler der Anwendung übergeben. Hinweis: Wenn das Kündigen nicht aktiviert ist, kann der Event-Handler innerhalb des Aufrufs von EndSubscription() synchron aufgerufen werden.

Wenn es nach der Rückgabe des Event-Handlers der Anwendung keine weiteren Verweise auf das SubscriptionHandler-Objekt gibt, wird das Objekt freigegeben.

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
)