nl:: Weave:: Profiles:: DataManagement_Current:: SubscriptionHandler
まとめ
パブリック タイプ |
|
---|---|
@142
|
列挙型 |
EventCallback)(void *const aAppState, EventID aEvent, const InEventParam &aInParam, OutEventParam &aOutParam)
|
typedefvoid(*
|
EventID
|
列挙型 |
HandlerId
|
typedefuint8_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
|
Binding *
|
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:: |
共用体 |
|
---|---|
nl:: |
|
nl:: |
パブリック タイプ
142
@142
イベント コールバック
void(* EventCallback)(void *const aAppState, EventID aEvent, const InEventParam &aInParam, OutEventParam &aOutParam)
EventID
EventID
ハンドラ ID
uint8_t HandlerId
静的パブリック関数
DefaultEventHandler
void DefaultEventHandler( EventID aEvent, const InEventParam & aInParam, OutEventParam & aOutParam )
パブリック関数
中止サブスクリプション
void AbortSubscription( void )
この関数はサブスクリプションを直ちに終了します。これは同期呼び出しです。
ニュース メディアの購読を中止します。
終了についてクライアントに通知しようとしても、基になるエクスチェンジのコンテキストが存在する場合は、すぐに中止されます。この呼び出しの後、このオブジェクトに対するそれ以上のアクティビティはアプリケーションに通知されません。また、その後、アプリケーションでそのメソッドを使用してこのオブジェクトを操作することはできません。
ニュース メディアは、定期購入クライアントに通知せずに、またアプリケーションのイベント ハンドラに OnSubscriptionTerminated
イベントを配信することなく、定期購入を終了できます。相互のサブスクリプションが存在する場合、パブリッシャーからクライアントへのカウンタ サブスクリプションも終了します。
AbortSubscription() を呼び出すと、SubscriptionHandler
オブジェクトは Terminated
状態になります。終了プロセスが完了したときにオブジェクトへの追加の参照がない場合、SubscriptionHandler
オブジェクトは解放されます。
AcceptSubscribeRequest(承諾リクエスト)
WEAVE_ERROR AcceptSubscribeRequest( const uint32_t aLivenessTimeoutSec )
エンド サブスクリプション
WEAVE_ERROR EndSubscription( const uint32_t aReasonProfileId, const uint16_t aReasonStatusCode )
この関数によって、サブスクリプションの正常なシャットダウンとハンドラ オブジェクトのクリーンアップが開始されます。
ニュース メディアのサブスクリプションを正常に終了します。
これは非同期呼び出しであり、必要に応じて SubscribeCancel/StatusReport メッセージを介してシャットダウンをクライアントに通知します。
特に、このサブスクリプションとアプリの関係は放棄します。この呼び出しの後、このオブジェクトに対するそれ以上のアクティビティはアプリケーションに通知されません。また、その後、アプリケーションでそのメソッドを使用してこのオブジェクトを操作することはできません。
ニュース メディアが定期購入を正常に終了します。定期購入の解約サポートが有効になっている場合、SubscribeCancelRequest メッセージは定期購入クライアントに送信され、定期購入を終了する前にシステムは応答を待機します。それ以外の場合は、AbortSubscription() と同様の方法で定期購入は直ちに終了します。相互定期購入が存在する場合、パブリッシャーからクライアントへのカウンタ定期購入も終了します。
詳細 | |||||
---|---|---|---|---|---|
パラメータ |
|
||||
戻り値 |
|
SubscribeCancelRequest へのレスポンスを待っている間、SubscriptionHandler
は Canceling
状態になります。
終了プロセスが開始されると、SubscriptionHandler
オブジェクトは Terminated
状態になり、OnSubscriptionTerminated
イベントがアプリケーションのイベント ハンドラに配信されます。キャンセルのサポートが有効になっていない場合は、EndSubscription() の呼び出し内でイベント ハンドラが同期的に呼び出されることがあります。
アプリケーションのイベント ハンドラが返された後、SubscriptionHandler
オブジェクトへの追加参照がない場合、オブジェクトは解放されます。
バインディングの取得
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 )
キャンセル中
bool IsCanceling() const
IsEstablishedIdle
bool IsEstablishedIdle()
無料
bool IsFree()
終了
bool IsTerminated()
SetMaxNotificationSize
void SetMaxNotificationSize( const uint32_t aMaxPayload )