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

概要

パブリック タイプ
@142 enum
EventCallback)(void *const aAppState, EventID aEvent, const InEventParam &aInParam, OutEventParam &aOutParam) typedef
void(*
EventID enum
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

構造体
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
Weave のエラーコードは、情報提供のみを目的としています。エラーが発生すると、オブジェクトは同期的に終了（中止）されます。

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
)