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

摘要

公開類型
@142 列舉
EventCallback)(void *const aAppState, EventID aEvent, const InEventParam &aInParam, OutEventParam &aOutParam) typedef
void(*
EventID 列舉
HandlerId typedef
uint8_t

公開的靜態函式
DefaultEventHandler(EventID aEvent, const InEventParam & aInParam, OutEventParam & aOutParam)
void

公開函式
AbortSubscription(void)
void
這個函式會立即終止訂閱 - 這是同步呼叫。
AcceptSubscribeRequest(const uint32_t aLivenessTimeoutSec)
EndSubscription(const uint32_t aReasonProfileId, const uint16_t aReasonStatusCode)
此函式會安全關閉訂閱及清理處理常式物件。
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

聯合工會
nl::Weave::Profiles::DataManagement_Current::SubscriptionHandler::InEventParam
nl::Weave::Profiles::DataManagement_Current::SubscriptionHandler::OutEventParam

公開類型

142 次

 @142

EventCallback

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

EventID

 EventID

HandlerId

uint8_t HandlerId

公開的靜態函式

DefaultEventHandler

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

公開函式

AbortSubscription

void AbortSubscription(
  void
)

這個函式會立即終止訂閱 - 這是同步呼叫。

取消發布者訂閱項目。

不會嘗試通知用戶端終止。如果有立即取消，其基礎交換情境。呼叫後，應用程式將不會收到這個物件的任何後續活動通知。此外，之後應用程式也不得透過任何 方法與此物件互動。

這會終止發布者訂閱訂閱，而無需通知訂閱用戶端，也不必傳送 OnSubscriptionTerminated 事件至應用程式的事件處理常式。如果存在共同訂閱項目，將發布者訂閱回客戶的計數器訂閱也會終止。

呼叫 AbortSubscription() 後，SubscriptionHandler 物件就會進入 Terminated 狀態。終止程序完成後，如果沒有其他對物件參照，則會釋出 SubscriptionHandler 物件。

AcceptSubscribeRequest

WEAVE_ERROR AcceptSubscribeRequest(
  const uint32_t aLivenessTimeoutSec
)

EndSubscription

WEAVE_ERROR EndSubscription(
  const uint32_t aReasonProfileId,
  const uint16_t aReasonStatusCode
)

此函式會安全關閉訂閱及清理處理常式物件。

正常結束發布者訂閱。

這是非同步呼叫，且會在相關情況下透過 SubscribeCancel/StatusReport 訊息，通知用戶端即將停止服務。

值得注意的是，這種做法可以彌補應用程式對這項訂閱的參與。呼叫後，應用程式將不會收到這個物件的任何後續活動通知。此外，之後應用程式也不得透過任何 方法與此物件互動。

順利終止發布者訂閱。如果您已啟用訂閱取消支援，則會將 SubscribeCancelRequest 訊息傳送至訂閱用戶端，而系統會等待回覆後才會終止訂閱。否則系統會立即以類似 AbortSubscription() 的方式終止訂閱項目。如果存在共同訂閱項目，將發布者訂閱回客戶的計數器訂閱也會終止。

詳細資料
參數
[in] aReasonProfileId
StatusCode 的 ProfileId，用於說明終止原因
[in] aReasonStatusCode
說明終止原因的 StatusCode
傳回值
Returns
編織紋代碼僅供參考。發生任何錯誤時，系統會同步終止物件 (即取消)。

在等待回應 SubscribeCancelRequest 時，SubscriptionHandler 會進入 Canceling 狀態。

終止程序開始後，SubscriptionHandler 物件會進入 Terminated 狀態，並將 OnSubscriptionTerminated 事件傳送至應用程式的事件處理常式。請注意，如果「未」啟用取消支援，系統可能會在對 EndSubscription() 的呼叫內同步呼叫事件處理常式。

在應用程式的事件處理常式傳回後，如果 SubscriptionHandler 物件沒有其他參照，則會釋放物件。

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
)