nl:: Weave:: Profiles:: DataManagement_Current:: SubscriptionHandler
概要
パブリック タイプ |
|
---|---|
@142
|
enum |
EventCallback)(void *const aAppState, EventID aEvent, const InEventParam &aInParam, OutEventParam &aOutParam)
|
typedefvoid(*
|
EventID
|
enum |
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
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() と同様の方法で定期購入は直ちに終了します。相互サブスクリプションが存在する場合、ニュース メディアからクライアントへのカウンタ サブスクリプションも終了します。
詳細 | |||||
---|---|---|---|---|---|
パラメータ |
|
||||
戻り値 |
|
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 )