Mit Sammlungen den Überblick behalten Sie können Inhalte basierend auf Ihren Einstellungen speichern und kategorisieren.

nl::Weave::Profile::DataManagement_Current::SubscriptionHandler

Fazit

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

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

Öffentliche Funktionen
AbortSubscription(void)
void
Mit dieser Funktion wird ein Abo sofort beendet – ein synchroner Aufruf.
AcceptSubscribeRequest(const uint32_t aLivenessTimeoutSec)
EndSubscription(const uint32_t aReasonProfileId, const uint16_t aReasonStatusCode)
Mit dieser Funktion wird das Abo ordnungsgemäß beendet und das Handler-Objekt bereinigt.
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

Strebenklemmen
nl::Weave::Profile::DataManagement_Current::SubscriptionHandler::TraitInstanceInfo

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

Öffentliche Typen

@142

 @142

Ereignis-Callback

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

Ereignis-ID

 EventID

Handler-ID

uint8_t HandlerId

Öffentliche statische Funktionen

Standard-EventHandler

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

Öffentliche Funktionen

Abo kündigen

void AbortSubscription(
  void
)

Mit dieser Funktion wird ein Abo sofort beendet – ein synchroner Aufruf.

Abo des Verlags oder Webpublishers kündigen

Es wird nicht versucht, den Kunden über die Kündigung zu informieren, und der zugrunde liegende Exchange-Kontext wird sofort abgebrochen. Nach diesem Aufruf wird die Anwendung nicht mehr über weitere Aktivitäten in diesem Objekt informiert. Außerdem ist es der App nicht gestattet, danach über eine ihrer Methoden mit diesem Objekt zu interagieren.

Beendet das Ende des Abos des Verlags, ohne den Aboclient zu benachrichtigen, und ohne dass ein OnSubscriptionTerminated-Ereignis an den Ereignis-Handler gesendet wird. Falls ein gemeinsames Abo vorhanden ist, wird auch das Zählerabo des Verlags oder Webpublishers für den Kunden beendet.

Beim Aufrufen von AbortSubscription() erhält das SubscriptionHandler-Objekt den Status Terminated. Wenn nach Abschluss des Vorgangs keine weiteren Verweise auf das Objekt vorhanden sind, wird das Objekt SubscriptionHandler freigegeben.

Abonnieren abonnieren

WEAVE_ERROR AcceptSubscribeRequest(
  const uint32_t aLivenessTimeoutSec
)

Abo beenden

WEAVE_ERROR EndSubscription(
  const uint32_t aReasonProfileId,
  const uint16_t aReasonStatusCode
)

Mit dieser Funktion wird das Abo ordnungsgemäß beendet und das Handler-Objekt bereinigt.

Kündigen Sie ein Abo für den Verlag oder Webpublisher.

Dies ist ein asynchroner Aufruf, der den Kunden über eine anstehende Beendigung über eine SubscribeCancel/StatusReport-Nachricht informiert.

Auf diese Weise wird der Interesse an der Anwendung an diesem Abo aufgehoben. Nach diesem Aufruf wird die Anwendung nicht mehr über weitere Aktivitäten in diesem Objekt informiert. Außerdem ist es der App nicht gestattet, danach über eine ihrer Methoden mit diesem Objekt zu interagieren.

Kündigt das Abo des Verlags oder Webpublishers ordnungsgemäß. Wenn der Support für die Abo-Kündigung aktiviert ist, wird eine SubscribeCancelRequest-Nachricht an den Abo-Client gesendet. Das System wartet dann auf eine Antwort, bevor das Abo gekündigt wird. Andernfalls wird das Abo ähnlich wie bei AbortSubscription() sofort beendet. Wenn ein gemeinsames Abo vorhanden ist, wird auch das Zählerabo des Verlags oder Webpublishers an den Client gekündigt.

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

Während auf eine Antwort auf ein SubscribeCancelRequest gewartet wird, wechselt SubscriptionHandler in den Status Canceling.

Sobald der Vorgang gestartet wird, wechselt das SubscriptionHandler-Objekt in den Status Terminated und ein OnSubscriptionTerminated-Ereignis wird an den Ereignis-Handler der Anwendung gesendet. Wenn die Unterstützung für die Kündigung nicht aktiviert ist, kann der Ereignis-Handler innerhalb des Aufrufs von EndSubscription() synchron aufgerufen werden.

Wenn der Event-Handler der Anwendung zurückgegeben wird und keine weiteren Verweise auf das Objekt SubscriptionHandler vorhanden sind, wird das Objekt freigegeben.

GetBindung

Binding * GetBinding(
  void
) const

maximale Benachrichtigungsgröße

uint32_t GetMaxNotificationSize(
  void
) const

PeerNodeNode

uint64_t GetPeerNodeId(
  void
) const

Abo-ID abrufen

WEAVE_ERROR GetSubscriptionId(
  uint64_t *const apSubscriptionId
)

IsActive

bool IsActive(
  void
)

Wird abgebrochen

bool IsCanceling() const

Ist eingerichtet

bool IsEstablishedIdle()

Ist Kostenlos

bool IsFree()

Beendet

bool IsTerminated()

Maximale Benachrichtigungsgröße

void SetMaxNotificationSize(
  const uint32_t aMaxPayload
)