ไม่มี:: สาน:: 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 มีให้เพียร์โหนดสานระบุโดยโหนดระบุเพียร์ |
NewContext (const uint64_t & peerNodeId, const IPAddress & peerAddr, void *appState) | สร้างใหม่ ExchangeContext มีให้เพียร์โหนดสานระบุโดยเพียร์โหนดระบุและ IP เพียร์ที่อยู่ |
NewContext (const uint64_t & peerNodeId, const IPAddress & peerAddr, uint16_t peerPort, InterfaceId sendIntfId, void *appState) | สร้างใหม่ ExchangeContext มีให้เพียร์โหนดสานระบุโดยระบุเพียร์โหนดที่อยู่ IP เพียร์และพอร์ตปลายทางบนอินเตอร์เฟซที่ระบุไว้ |
NewContext ( WeaveConnection *con, void *appState) | สร้างใหม่ ExchangeContext กับโหนดเพียร์สานให้มากกว่าที่ระบุ 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 ไม่ได้เริ่มต้น |
คุณลักษณะสาธารณะ
งานสาธารณะ
อนุญาตข้อความที่ไม่พึงประสงค์
void AllowUnsolicitedMessages( WeaveConnection *con )
อนุญาตให้รับข้อความที่ไม่พึงประสงค์ในการเชื่อมต่อที่ระบุ
เมธอดนี้ตั้งค่าตัวจัดการการรับข้อความบนการเชื่อมต่อ Weave ที่กำหนด
รายละเอียด | |||
---|---|---|---|
พารามิเตอร์ |
|
ClearMsgCounterSyncReq
void ClearMsgCounterSyncReq( uint64_t peerNodeId )
ล้างการตั้งค่าสถานะ MsgCounterSyncReq สำหรับข้อความที่รอดำเนินการทั้งหมดไปยังเพียร์นั้น
รายละเอียด | |||
---|---|---|---|
พารามิเตอร์ |
|
ค้นหาบริบท
ExchangeContext * FindContext( uint64_t peerNodeId, WeaveConnection *con, void *appState, bool isInitiator )
ค้นหา ExchangeContext จากสระว่ายน้ำที่ตรงกับชุดที่กำหนดของพารามิเตอร์
รายละเอียด | |||||||||
---|---|---|---|---|---|---|---|---|---|
พารามิเตอร์ |
| ||||||||
คืนสินค้า | ตัวชี้ไปยัง ExchangeContext วัตถุที่ตรงกับพารามิเตอร์ให้ในความสำเร็จในโมฆะไม่มีการแข่งขัน |
ในนั้น
WEAVE_ERROR Init( WeaveMessageLayer *msgLayer )
เริ่มต้น WeaveExchangeManager วัตถุ
ภายในช่วงอายุของอินสแตนซ์นี้ เมธอดนี้จะถูกเรียกใช้หนึ่งครั้งหลังจากการสร้างอ็อบเจ็กต์จนกว่าจะมีการเรียก Shutdown เพื่อยุติอินสแตนซ์
รายละเอียด | |||||
---|---|---|---|---|---|
พารามิเตอร์ |
| ||||
ส่งกลับค่า |
|
ผูกใหม่
Binding * NewBinding( Binding::EventCallback eventCallback, void *appState )
บริบทใหม่
ExchangeContext * NewContext( const uint64_t & peerNodeId, void *appState )
สร้างใหม่ ExchangeContext มีให้เพียร์โหนดสานระบุโดยโหนดระบุเพียร์
รายละเอียด | |||||
---|---|---|---|---|---|
พารามิเตอร์ |
| ||||
คืนสินค้า | ตัวชี้ไปที่สร้าง ExchangeContext วัตถุในความสำเร็จ มิฉะนั้น NULL หากไม่มีวัตถุใดที่สามารถจัดสรรหรือพร้อมใช้งาน |
บริบทใหม่
ExchangeContext * NewContext( const uint64_t & peerNodeId, const IPAddress & peerAddr, void *appState )
สร้างใหม่ ExchangeContext มีให้เพียร์โหนดสานระบุโดยเพียร์โหนดระบุและ IP เพียร์ที่อยู่
รายละเอียด | |||||||
---|---|---|---|---|---|---|---|
พารามิเตอร์ |
| ||||||
คืนสินค้า | ตัวชี้ไปที่สร้าง ExchangeContext วัตถุในความสำเร็จ มิฉะนั้น จะเป็น NULL หากไม่สามารถจัดสรรวัตถุหรือพร้อมใช้งานได้ |
บริบทใหม่
ExchangeContext * NewContext( const uint64_t & peerNodeId, const IPAddress & peerAddr, uint16_t peerPort, InterfaceId sendIntfId, void *appState )
สร้างใหม่ ExchangeContext มีให้เพียร์โหนดสานระบุโดยระบุเพียร์โหนดที่อยู่ IP เพียร์และพอร์ตปลายทางบนอินเตอร์เฟซที่ระบุไว้
รายละเอียด | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
พารามิเตอร์ |
| ||||||||||
คืนสินค้า | ตัวชี้ไปที่สร้าง ExchangeContext วัตถุในความสำเร็จ มิฉะนั้น จะเป็น NULL หากไม่สามารถจัดสรรวัตถุหรือพร้อมใช้งานได้ |
บริบทใหม่
ExchangeContext * NewContext( WeaveConnection *con, void *appState )
สร้างใหม่ ExchangeContext กับโหนดเพียร์สานให้มากกว่าที่ระบุ 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