nl:: Weave:: WeaveExchangeManager
#include <src/lib/core/WeaveExchangeMgr.h>
คลาสนี้ใช้เพื่อจัดการ ExchangeContexts กับโหนด Weave อื่นๆ
สรุป
บริการนี้จะทำงานในนามของเลเยอร์ที่สูงกว่า ซึ่งก็คือการสร้าง ExchangeContexts และจัดการการลงทะเบียน/การยกเลิกการลงทะเบียนตัวแฮนเดิลข้อความที่ไม่พึงประสงค์
ผู้ผลิตและผู้ทำลาย |
|
---|---|
WeaveExchangeManager(void)
เครื่องมือสร้างสำหรับคลาส WeaveExchangeManager
|
ประเภทสาธารณะ |
|
---|---|
State{
|
enum |
แอตทริบิวต์สาธารณะ |
|
---|---|
FabricState
|
[อ่านอย่างเดียว] ออบเจ็กต์ FabricState ที่เชื่อมโยง
|
MessageLayer
|
[อ่านอย่างเดียว] ออบเจ็กต์ WeaveMessageLayer ที่เกี่ยวข้อง
|
State
|
uint8_t
[อ่านอย่างเดียว] สถานะของออบเจ็กต์ WeaveExchangeManager
|
ฟังก์ชันสาธารณะ |
|
---|---|
AllowUnsolicitedMessages(WeaveConnection *con)
|
void
อนุญาตให้รับข้อความที่ไม่พึงประสงค์ในการเชื่อมต่อที่ระบุ
|
ClearMsgCounterSyncReq(uint64_t peerNodeId)
|
void
ล้างแฟล็ก MsgCounterSyncReq สำหรับข้อความที่รอดำเนินการทั้งหมดที่ส่งถึงเพียร์ดังกล่าว
|
FindContext(uint64_t peerNodeId, WeaveConnection *con, void *appState, bool isInitiator)
|
ค้นหา ExchangeContext จากพูลที่ตรงกับชุดพารามิเตอร์ที่ระบุ
|
Init(WeaveMessageLayer *msgLayer)
|
เริ่มต้นออบเจ็กต์ WeaveExchangeManager
|
NewBinding(Binding::EventCallback eventCallback, void *appState)
|
Binding *
จัดสรรการเชื่อมโยงใหม่ด้วยอาร์กิวเมนต์ที่ให้มา
|
NewContext(const uint64_t & peerNodeId, void *appState)
|
สร้าง ExchangeContext ใหม่ด้วยโหนดเพียร์ Weave ที่ระบุโดยตัวระบุโหนดเพียร์
|
NewContext(const uint64_t & peerNodeId, const IPAddress & peerAddr, void *appState)
|
สร้าง ExchangeContext ใหม่ด้วยโหนด Peer Weave ที่กำหนดโดยตัวระบุโหนดเพียร์และที่อยู่ IP การเพียร์
|
NewContext(const uint64_t & peerNodeId, const IPAddress & peerAddr, uint16_t peerPort, InterfaceId sendIntfId, void *appState)
|
สร้าง ExchangeContext ใหม่ด้วยโหนดเพียร์ Weave ที่ระบุโดยตัวระบุโหนดเพียร์, ที่อยู่ IP การเพียร์ และพอร์ตปลายทางในอินเทอร์เฟซที่ระบุ
|
NewContext(WeaveConnection *con, void *appState)
|
สร้าง ExchangeContext ใหม่ด้วยโหนด Peer Weave ที่กำหนดผ่าน WeaveConnection ที่ระบุ
|
RegisterUnsolicitedMessageHandler(uint32_t profileId, ExchangeContext::MessageReceiveFunct handler, void *appState)
|
ลงทะเบียนเครื่องจัดการข้อความที่ไม่พึงประสงค์สำหรับตัวระบุโปรไฟล์ที่ระบุ
|
RegisterUnsolicitedMessageHandler(uint32_t profileId, ExchangeContext::MessageReceiveFunct handler, bool allowDups, void *appState)
|
ลงทะเบียนเครื่องจัดการข้อความที่ไม่พึงประสงค์สำหรับตัวระบุโปรไฟล์ที่ระบุ
|
RegisterUnsolicitedMessageHandler(uint32_t profileId, uint8_t msgType, ExchangeContext::MessageReceiveFunct handler, void *appState)
|
ลงทะเบียนเครื่องจัดการข้อความที่ไม่พึงประสงค์สำหรับตัวระบุโปรไฟล์และประเภทข้อความที่ระบุ
|
RegisterUnsolicitedMessageHandler(uint32_t profileId, uint8_t msgType, ExchangeContext::MessageReceiveFunct handler, bool allowDups, void *appState)
|
ลงทะเบียนเครื่องจัดการข้อความที่ไม่พึงประสงค์สำหรับตัวระบุโปรไฟล์และประเภทข้อความที่ระบุ
|
RegisterUnsolicitedMessageHandler(uint32_t profileId, uint8_t msgType, WeaveConnection *con, ExchangeContext::MessageReceiveFunct handler, void *appState)
|
ลงทะเบียนเครื่องจัดการข้อความที่ไม่พึงประสงค์สำหรับตัวระบุโปรไฟล์ที่ระบุ ซึ่งเป็นประเภทข้อความในการเชื่อมต่อ Weave ที่ระบุ
|
RegisterUnsolicitedMessageHandler(uint32_t profileId, uint8_t msgType, WeaveConnection *con, ExchangeContext::MessageReceiveFunct handler, bool allowDups, void *appState)
|
ลงทะเบียนเครื่องจัดการข้อความที่ไม่พึงประสงค์สำหรับตัวระบุโปรไฟล์ที่ระบุ ซึ่งเป็นประเภทข้อความในการเชื่อมต่อ Weave ที่ระบุ
|
Shutdown(void)
|
|
UnregisterUnsolicitedMessageHandler(uint32_t profileId)
|
ยกเลิกการลงทะเบียนเครื่องจัดการข้อความที่ไม่พึงประสงค์สำหรับตัวระบุโปรไฟล์ที่ระบุ
|
UnregisterUnsolicitedMessageHandler(uint32_t profileId, uint8_t msgType)
|
ยกเลิกการลงทะเบียนเครื่องจัดการข้อความที่ไม่พึงประสงค์สำหรับตัวระบุโปรไฟล์และประเภทข้อความที่ระบุ
|
UnregisterUnsolicitedMessageHandler(uint32_t profileId, uint8_t msgType, WeaveConnection *con)
|
ยกเลิกการลงทะเบียนเครื่องจัดการข้อความที่ไม่พึงประสงค์สำหรับตัวระบุโปรไฟล์ ประเภทข้อความ และการเชื่อมต่อ Weave ที่ระบุ
|
ประเภทสาธารณะ
รัฐ
State
พร็อพเพอร์ตี้ | |
---|---|
kState_Initialized
|
ใช้เพื่อระบุว่า WeaveExchangeManager ได้เริ่มต้นแล้ว |
kState_NotInitialized
|
ใช้เพื่อระบุว่า WeaveExchangeManager ไม่ได้เริ่มต้น |
แอตทริบิวต์สาธารณะ
MessageLayer
WeaveMessageLayer * MessageLayer
[อ่านอย่างเดียว] ออบเจ็กต์ WeaveMessageLayer ที่เกี่ยวข้อง
ฟังก์ชันสาธารณะ
AllowUnsolicitedMessages
void AllowUnsolicitedMessages( WeaveConnection *con )
อนุญาตให้รับข้อความที่ไม่พึงประสงค์ในการเชื่อมต่อที่ระบุ
เมธอดนี้ตั้งค่าเครื่องจัดการข้อความบนการเชื่อมต่อ Weave ที่กำหนด
รายละเอียด | |||
---|---|---|---|
พารามิเตอร์ |
|
ClearMsgCounterSyncReq
void ClearMsgCounterSyncReq( uint64_t peerNodeId )
ล้างแฟล็ก MsgCounterSyncReq สำหรับข้อความที่รอดำเนินการทั้งหมดที่ส่งถึงเพียร์ดังกล่าว
รายละเอียด | |||
---|---|---|---|
พารามิเตอร์ |
|
FindContext
ExchangeContext * FindContext( uint64_t peerNodeId, WeaveConnection *con, void *appState, bool isInitiator )
ค้นหา ExchangeContext จากพูลที่ตรงกับชุดพารามิเตอร์ที่ระบุ
รายละเอียด | |||||||||
---|---|---|---|---|---|---|---|---|---|
พารามิเตอร์ |
|
||||||||
การส่งคืน |
ตัวชี้ไปยังออบเจ็กต์ ExchangeContext ที่ตรงกับพารามิเตอร์ที่ระบุ "เมื่อสำเร็จ" มีค่า NULL เมื่อไม่ตรงกัน
|
เริ่มต้น
WEAVE_ERROR Init( WeaveMessageLayer *msgLayer )
เริ่มต้นออบเจ็กต์ WeaveExchangeManager
ภายในอายุการใช้งานของอินสแตนซ์นี้จะมีการเรียกใช้เมธอดนี้ 1 ครั้งหลังจากการสร้างออบเจ็กต์จนกว่าจะมีการเรียกใช้การปิดการทำงานเพื่อสิ้นสุดอินสแตนซ์
รายละเอียด | |||||
---|---|---|---|---|---|
พารามิเตอร์ |
|
||||
แสดงผลค่า |
|
NewBinding
Binding * NewBinding( Binding::EventCallback eventCallback, void *appState )
จัดสรรการเชื่อมโยงใหม่ด้วยอาร์กิวเมนต์ที่ให้มา
รายละเอียด | |||||
---|---|---|---|---|---|
พารามิเตอร์ |
|
||||
การส่งคืน |
ตัวชี้ไปยัง การเชื่อมโยง ที่จัดสรรใหม่ หรือ NULL หากพูลหมดแล้ว
|
NewContext
ExchangeContext * NewContext( const uint64_t & peerNodeId, void *appState )
สร้าง ExchangeContext ใหม่ด้วยโหนดเพียร์ Weave ที่ระบุโดยตัวระบุโหนดเพียร์
รายละเอียด | |||||
---|---|---|---|---|---|
พารามิเตอร์ |
|
||||
การส่งคืน |
ตัวชี้ไปยังออบเจ็กต์ ExchangeContext ที่สร้างขึ้นสำเร็จ ไม่เช่นนั้นจะเป็นค่า Null หากไม่มีออบเจ็กต์ที่สามารถจัดสรรหรือพร้อมใช้งาน
|
NewContext
ExchangeContext * NewContext( const uint64_t & peerNodeId, const IPAddress & peerAddr, void *appState )
สร้าง ExchangeContext ใหม่ด้วยโหนด Peer Weave ที่กำหนดโดยตัวระบุโหนดเพียร์และที่อยู่ IP การเพียร์
รายละเอียด | |||||||
---|---|---|---|---|---|---|---|
พารามิเตอร์ |
|
||||||
การส่งคืน |
ตัวชี้ไปยังออบเจ็กต์ ExchangeContext ที่สร้างขึ้นสำเร็จ มิเช่นนั้น จะเป็น NULL ถ้าไม่มีการจัดสรรออบเจ็กต์หรือพร้อมใช้งาน
|
NewContext
ExchangeContext * NewContext( const uint64_t & peerNodeId, const IPAddress & peerAddr, uint16_t peerPort, InterfaceId sendIntfId, void *appState )
สร้าง ExchangeContext ใหม่ด้วยโหนดเพียร์ Weave ที่ระบุโดยตัวระบุโหนดเพียร์, ที่อยู่ IP การเพียร์ และพอร์ตปลายทางในอินเทอร์เฟซที่ระบุ
รายละเอียด | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
พารามิเตอร์ |
|
||||||||||
การส่งคืน |
ตัวชี้ไปยังออบเจ็กต์ ExchangeContext ที่สร้างขึ้นสำเร็จ มิเช่นนั้น จะเป็น NULL ถ้าไม่มีการจัดสรรออบเจ็กต์หรือพร้อมใช้งาน
|
NewContext
ExchangeContext * NewContext( WeaveConnection *con, void *appState )
สร้าง ExchangeContext ใหม่ด้วยโหนด Peer Weave ที่กำหนดผ่าน WeaveConnection ที่ระบุ
รายละเอียด | |||||
---|---|---|---|---|---|
พารามิเตอร์ |
|
||||
การส่งคืน |
ตัวชี้ไปยังออบเจ็กต์ ExchangeContext ที่สร้างขึ้นสำเร็จ มิเช่นนั้น จะเป็น NULL ถ้าไม่มีการจัดสรรออบเจ็กต์หรือพร้อมใช้งาน
|
RegisterUnsolicitedMessageHandler
WEAVE_ERROR RegisterUnsolicitedMessageHandler( uint32_t profileId, ExchangeContext::MessageReceiveFunct handler, void *appState )
ลงทะเบียนเครื่องจัดการข้อความที่ไม่พึงประสงค์สำหรับตัวระบุโปรไฟล์ที่ระบุ
ระบบจะเรียกใช้เครื่องจัดการนี้สำหรับทุกข้อความของโปรไฟล์ที่ระบุ
รายละเอียด | |||||||
---|---|---|---|---|---|---|---|
พารามิเตอร์ |
|
||||||
แสดงผลค่า |
|
RegisterUnsolicitedMessageHandler
WEAVE_ERROR RegisterUnsolicitedMessageHandler( uint32_t profileId, ExchangeContext::MessageReceiveFunct handler, bool allowDups, void *appState )
ลงทะเบียนเครื่องจัดการข้อความที่ไม่พึงประสงค์สำหรับตัวระบุโปรไฟล์ที่ระบุ
ระบบจะเรียกใช้เครื่องจัดการนี้สำหรับทุกข้อความของโปรไฟล์ที่ระบุ
รายละเอียด | |||||||||
---|---|---|---|---|---|---|---|---|---|
พารามิเตอร์ |
|
||||||||
แสดงผลค่า |
|
RegisterUnsolicitedMessageHandler
WEAVE_ERROR RegisterUnsolicitedMessageHandler( uint32_t profileId, uint8_t msgType, ExchangeContext::MessageReceiveFunct handler, void *appState )
ลงทะเบียนเครื่องจัดการข้อความที่ไม่พึงประสงค์สำหรับตัวระบุโปรไฟล์และประเภทข้อความที่ระบุ
รายละเอียด | |||||||||
---|---|---|---|---|---|---|---|---|---|
พารามิเตอร์ |
|
||||||||
แสดงผลค่า |
|
RegisterUnsolicitedMessageHandler
WEAVE_ERROR RegisterUnsolicitedMessageHandler( uint32_t profileId, uint8_t msgType, ExchangeContext::MessageReceiveFunct handler, bool allowDups, void *appState )
ลงทะเบียนเครื่องจัดการข้อความที่ไม่พึงประสงค์สำหรับตัวระบุโปรไฟล์และประเภทข้อความที่ระบุ
รายละเอียด | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
พารามิเตอร์ |
|
||||||||||
แสดงผลค่า |
|
RegisterUnsolicitedMessageHandler
WEAVE_ERROR RegisterUnsolicitedMessageHandler( uint32_t profileId, uint8_t msgType, WeaveConnection *con, ExchangeContext::MessageReceiveFunct handler, void *appState )
ลงทะเบียนเครื่องจัดการข้อความที่ไม่พึงประสงค์สำหรับตัวระบุโปรไฟล์ที่ระบุ ซึ่งเป็นประเภทข้อความในการเชื่อมต่อ Weave ที่ระบุ
รายละเอียด | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
พารามิเตอร์ |
|
||||||||||
แสดงผลค่า |
|
RegisterUnsolicitedMessageHandler
WEAVE_ERROR RegisterUnsolicitedMessageHandler( uint32_t profileId, uint8_t msgType, WeaveConnection *con, ExchangeContext::MessageReceiveFunct handler, bool allowDups, void *appState )
ลงทะเบียนเครื่องจัดการข้อความที่ไม่พึงประสงค์สำหรับตัวระบุโปรไฟล์ที่ระบุ ซึ่งเป็นประเภทข้อความในการเชื่อมต่อ Weave ที่ระบุ
รายละเอียด | |||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
พารามิเตอร์ |
|
||||||||||||
แสดงผลค่า |
|
ปิดการทำงาน
WEAVE_ERROR Shutdown( void )
การดำเนินการนี้จะหยุดอินสแตนซ์ของออบเจ็กต์นี้และปล่อยทรัพยากรที่ถูกระงับทั้งหมด
รายละเอียด | |
---|---|
การส่งคืน |
WEAVE_NO_ERROR อย่างไม่มีเงื่อนไข
|
UnregisterUnsolicitedMessageHandler
WEAVE_ERROR UnregisterUnsolicitedMessageHandler( uint32_t profileId )
ยกเลิกการลงทะเบียนเครื่องจัดการข้อความที่ไม่พึงประสงค์สำหรับตัวระบุโปรไฟล์ที่ระบุ
รายละเอียด | |||||
---|---|---|---|---|---|
พารามิเตอร์ |
|
||||
แสดงผลค่า |
|
UnregisterUnsolicitedMessageHandler
WEAVE_ERROR UnregisterUnsolicitedMessageHandler( uint32_t profileId, uint8_t msgType )
ยกเลิกการลงทะเบียนเครื่องจัดการข้อความที่ไม่พึงประสงค์สำหรับตัวระบุโปรไฟล์และประเภทข้อความที่ระบุ
รายละเอียด | |||||
---|---|---|---|---|---|
พารามิเตอร์ |
|
||||
แสดงผลค่า |
|
UnregisterUnsolicitedMessageHandler
WEAVE_ERROR UnregisterUnsolicitedMessageHandler( uint32_t profileId, uint8_t msgType, WeaveConnection *con )
ยกเลิกการลงทะเบียนเครื่องจัดการข้อความที่ไม่พึงประสงค์สำหรับตัวระบุโปรไฟล์ ประเภทข้อความ และการเชื่อมต่อ Weave ที่ระบุ
รายละเอียด | |||||||
---|---|---|---|---|---|---|---|
พารามิเตอร์ |
|
||||||
แสดงผลค่า |
|
WeaveExchangeManager
WeaveExchangeManager( void )
เครื่องมือสร้างสำหรับคลาส WeaveExchangeManager
โดยจะกำหนดสถานะเป็น kState_NotInitialized