nl:: Weave:: Profil:: DataManagement_Current:: SubscriptionHandler
Ringkasan
Jenis publik |
|
---|---|
@142
|
enum |
EventCallback)(void *const aAppState, EventID aEvent, const InEventParam &aInParam, OutEventParam &aOutParam)
|
typedefvoid(*
|
EventID
|
enum |
HandlerId
|
typedefuint8_t
|
Fungsi statis publik |
|
---|---|
DefaultEventHandler(EventID aEvent, const InEventParam & aInParam, OutEventParam & aOutParam)
|
void
|
Fungsi publik |
|
---|---|
AbortSubscription(void)
|
void
Fungsi ini segera menghentikan langganan - ini adalah panggilan sinkron.
|
AcceptSubscribeRequest(const uint32_t aLivenessTimeoutSec)
|
|
EndSubscription(const uint32_t aReasonProfileId, const uint16_t aReasonStatusCode)
|
Fungsi ini memulai penutupan langganan yang rapi dan pembersihan objek pengendali.
|
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
|
Struct |
|
---|---|
nl:: |
Serikat |
|
---|---|
nl:: |
|
nl:: |
Jenis publik
@142
@142
Callback Peristiwa
void(* EventCallback)(void *const aAppState, EventID aEvent, const InEventParam &aInParam, OutEventParam &aOutParam)
ID acara
EventID
ID Pengendali
uint8_t HandlerId
Fungsi statis publik
PengendaliPeristiwaDefault
void DefaultEventHandler( EventID aEvent, const InEventParam & aInParam, OutEventParam & aOutParam )
Fungsi publik
Batalkan Langganan
void AbortSubscription( void )
Fungsi ini segera menghentikan langganan - ini adalah panggilan sinkron.
Membatalkan langganan penayang.
Tidak ada upaya yang dilakukan untuk memberi tahu klien tentang penghentian tersebut, dan konteks pertukaran yang mendasarinya jika ada, langsung dibatalkan. Setelah panggilan ini, aplikasi tidak akan diberi tahu tentang aktivitas lebih lanjut pada objek ini. Selain itu, aplikasi tidak diizinkan berinteraksi dengan objek ini setelahnya melalui salah satu metodenya.
Menghentikan akhir langganan langganan, tanpa memberi tahu klien langganan dan tanpa mengirimkan peristiwa OnSubscriptionTerminated
ke pengendali peristiwa aplikasi. Jika ada langganan bersama, langganan penghitung dari penayang yang kembali ke klien juga akan dihentikan.
Setelah memanggil AbortSubscription(), objek SubscriptionHandler
akan memasuki status Terminated
. Jika tidak ada referensi tambahan ke objek saat proses penghentian selesai, objek SubscriptionHandler
akan dibebaskan.
SetujuiPermintaan
WEAVE_ERROR AcceptSubscribeRequest( const uint32_t aLivenessTimeoutSec )
Akhiri Langganan
WEAVE_ERROR EndSubscription( const uint32_t aReasonProfileId, const uint16_t aReasonStatusCode )
Fungsi ini memulai penutupan langganan yang rapi dan pembersihan objek pengendali.
Mengakhiri langganan penayang dengan baik.
Ini adalah panggilan asinkron dan akan memberi tahu klien tentang penghentian yang akan datang melalui pesan SubscriptionsCancel/StatusReport jika relevan.
Secara khusus, hal ini melepaskan keterlibatan aplikasi dalam langganan ini. Setelah panggilan ini, aplikasi tidak akan diberi tahu tentang aktivitas lebih lanjut pada objek ini. Selain itu, aplikasi tidak diizinkan berinteraksi dengan objek ini setelahnya melalui salah satu metodenya.
Mengakhiri penghentian langganan dengan lancar. Jika dukungan pembatalan langganan diaktifkan, pesan BerlanggananCancelRequest dikirim ke klien langganan dan sistem menunggu balasan sebelum menghentikan langganan; jika tidak, langganan akan segera dihentikan dengan cara yang sama seperti AbortSubscription(). Jika ada langganan bersama, langganan penghitung dari penayang kembali ke klien juga akan dihentikan.
Detail | |||||
---|---|---|---|---|---|
Parameter |
|
||||
Nilai yang Ditampilkan |
|
Sambil menunggu respons terhadap SubscriptionsCancelRequest, SubscriptionHandler
memasuki status Canceling
.
Setelah proses penghentian dimulai, objek SubscriptionHandler
memasuki status Terminated
dan peristiwa OnSubscriptionTerminated
dikirim ke pengendali peristiwa aplikasi. Perhatikan bahwa, jika dukungan batal tidak diaktifkan, pengendali peristiwa dapat dipanggil secara sinkron dalam panggilan ke EndSubscription().
Setelah pengendali peristiwa aplikasi ditampilkan, jika tidak ada referensi tambahan ke objek SubscriptionHandler
, objek akan dibebaskan.
GetBinding
Binding * GetBinding( void ) const
GetMaxNotificationSize
uint32_t GetMaxNotificationSize( void ) const
GetPeerNodeId
uint64_t GetPeerNodeId( void ) const
ID Berlangganan
WEAVE_ERROR GetSubscriptionId( uint64_t *const apSubscriptionId )
IsActive
bool IsActive( void )
Membatalkan
bool IsCanceling() const
DitetapkanDenganIdle
bool IsEstablishedIdle()
Bebas
bool IsFree()
Dihentikan
bool IsTerminated()
SetMaxNotificationSize
void SetMaxNotificationSize( const uint32_t aMaxPayload )