nl :: Dệt :: WeaveExchangeManager
#include <src/lib/core/WeaveExchangeMgr.h>
Lớp này được sử dụng để quản lý ExchangeContexts với các nút Weave khác.
Tóm lược
Nó hoạt động thay mặt cho các lớp cao hơn, tạo ExchangeContexts và xử lý việc đăng ký / hủy đăng ký các trình xử lý thư không được yêu cầu.
Người xây dựng và Người phá hủy | |
---|---|
WeaveExchangeManager (void) |
Các loại công khai | |
---|---|
State { | enum |
Thuộc tính công cộng | |
---|---|
FabricState | [CHỈ ĐỌC] Đối tượng FabricState được liên kết. |
MessageLayer | [CHỈ ĐỌC] Đối tượng WeaveMessageLayer được liên kết. |
State | uint8_t [CHỈ ĐỌC] Trạng thái của đối tượng WeaveExchangeManager . |
Chức năng công cộng | |
---|---|
AllowUnsolicitedMessages ( WeaveConnection *con) | void Cho phép nhận các tin nhắn không mong muốn trên kết nối được chỉ định. |
ClearMsgCounterSyncReq (uint64_t peerNodeId) | void Xóa cờ MsgCounterSyncReq cho tất cả các thư đang chờ xử lý đến đồng đẳng đó. |
FindContext (uint64_t peerNodeId, WeaveConnection *con, void *appState, bool isInitiator) | Tìm ExchangeContext từ một nhóm khớp với một bộ tham số nhất định. |
Init ( WeaveMessageLayer *msgLayer) | Khởi tạo đối tượng WeaveExchangeManager . |
NewBinding (Binding::EventCallback eventCallback, void *appState) | Binding * Phân bổ một Liên kết mới với các đối số được cung cấp. |
NewContext (const uint64_t & peerNodeId, void *appState) | Tạo một ExchangeContext mới với một nút Weave ngang hàng nhất định được chỉ định bởi định danh nút ngang hàng. |
NewContext (const uint64_t & peerNodeId, const IPAddress & peerAddr, void *appState) | Tạo một ExchangeContext mới với một nút Weave ngang hàng nhất định được chỉ định bởi số nhận dạng nút ngang hàng và địa chỉ IP ngang hàng. |
NewContext (const uint64_t & peerNodeId, const IPAddress & peerAddr, uint16_t peerPort, InterfaceId sendIntfId, void *appState) | Tạo một ExchangeContext mới với một nút Weave ngang hàng nhất định được chỉ định bởi số nhận dạng nút ngang hàng, địa chỉ IP ngang hàng và cổng đích trên một giao diện được chỉ định. |
NewContext ( WeaveConnection *con, void *appState) | Tạo một ExchangeContext mới với một nút Weave ngang hàng nhất định trên một WeaveConnection được chỉ định. |
RegisterUnsolicitedMessageHandler (uint32_t profileId, ExchangeContext::MessageReceiveFunct handler, void *appState) | Đăng ký một trình xử lý thư không được yêu cầu cho một số nhận dạng hồ sơ nhất định. |
RegisterUnsolicitedMessageHandler (uint32_t profileId, ExchangeContext::MessageReceiveFunct handler, bool allowDups, void *appState) | Đăng ký một trình xử lý thư không được yêu cầu cho một số nhận dạng hồ sơ nhất định. |
RegisterUnsolicitedMessageHandler (uint32_t profileId, uint8_t msgType, ExchangeContext::MessageReceiveFunct handler, void *appState) | Đăng ký một trình xử lý tin nhắn không được yêu cầu cho một số nhận dạng hồ sơ nhất định và loại tin nhắn. |
RegisterUnsolicitedMessageHandler (uint32_t profileId, uint8_t msgType, ExchangeContext::MessageReceiveFunct handler, bool allowDups, void *appState) | Đăng ký một trình xử lý thư không được yêu cầu cho một số nhận dạng hồ sơ nhất định và loại thư. |
RegisterUnsolicitedMessageHandler (uint32_t profileId, uint8_t msgType, WeaveConnection *con, ExchangeContext::MessageReceiveFunct handler, void *appState) | Đăng ký một trình xử lý tin nhắn không mong muốn cho một số nhận dạng hồ sơ nhất định, loại tin nhắn trên một kết nối Weave được chỉ định. |
RegisterUnsolicitedMessageHandler (uint32_t profileId, uint8_t msgType, WeaveConnection *con, ExchangeContext::MessageReceiveFunct handler, bool allowDups, void *appState) | Đăng ký trình xử lý tin nhắn không được yêu cầu cho một số nhận dạng hồ sơ nhất định, loại tin nhắn trên kết nối Weave được chỉ định. |
Shutdown (void) | Tắt WeaveExchangeManager . |
UnregisterUnsolicitedMessageHandler (uint32_t profileId) | Hủy đăng ký trình xử lý thư không được yêu cầu cho một số nhận dạng hồ sơ nhất định. |
UnregisterUnsolicitedMessageHandler (uint32_t profileId, uint8_t msgType) | Hủy đăng ký một trình xử lý thư không được yêu cầu cho một số nhận dạng tiểu sử và loại thư nhất định. |
UnregisterUnsolicitedMessageHandler (uint32_t profileId, uint8_t msgType, WeaveConnection *con) | Hủy đăng ký một trình xử lý thư không được yêu cầu cho một số nhận dạng cấu hình, loại thư và kết nối Weave nhất định. |
Các loại công khai
Tiểu bang
State
Tính chất | |
---|---|
kState_Initialized | Được sử dụng để chỉ ra rằng WeaveExchangeManager được khởi tạo. |
kState_NotInitialized | Được sử dụng để chỉ ra rằng WeaveExchangeManager không được khởi tạo. |
Thuộc tính công cộng
Chức năng công cộng
AllowUnsolicitedMessages
void AllowUnsolicitedMessages( WeaveConnection *con )
Cho phép nhận các tin nhắn không mong muốn trên kết nối được chỉ định.
Phương thức này đặt trình xử lý nhận tin nhắn trên kết nối Weave đã cho.
Chi tiết | |||
---|---|---|---|
Thông số |
|
ClearMsgCounterSyncReq
void ClearMsgCounterSyncReq( uint64_t peerNodeId )
Xóa cờ MsgCounterSyncReq cho tất cả các thư đang chờ xử lý đến đồng đẳng đó.
Chi tiết | |||
---|---|---|---|
Thông số |
|
FindContext
ExchangeContext * FindContext( uint64_t peerNodeId, WeaveConnection *con, void *appState, bool isInitiator )
Tìm ExchangeContext từ một nhóm khớp với một bộ tham số nhất định.
Chi tiết | |||||||||
---|---|---|---|---|---|---|---|---|---|
Thông số |
| ||||||||
Lợi nhuận | Một con trỏ đến đối tượng ExchangeContext khớp với các tham số được cung cấp Khi thành công, NULL nếu không khớp. |
Trong đó
WEAVE_ERROR Init( WeaveMessageLayer *msgLayer )
Khởi tạo đối tượng WeaveExchangeManager .
Trong vòng đời của cá thể này, phương thức này được gọi một lần sau khi xây dựng đối tượng cho đến khi một lệnh gọi Tắt máy được thực hiện để kết thúc phiên bản.
Chi tiết | |||||
---|---|---|---|---|---|
Thông số |
| ||||
Giá trị trả lại |
|
NewBinding
Binding * NewBinding( Binding::EventCallback eventCallback, void *appState )
Phân bổ một Liên kết mới với các đối số được cung cấp.
Chi tiết | |||||
---|---|---|---|---|---|
Thông số |
| ||||
Lợi nhuận | Một con trỏ đến Ràng buộc mới được cấp phát hoặc NULL nếu nhóm đã cạn kiệt |
NewContext
ExchangeContext * NewContext( const uint64_t & peerNodeId, void *appState )
Tạo một ExchangeContext mới với một nút Weave ngang hàng nhất định được chỉ định bởi định danh nút ngang hàng.
Chi tiết | |||||
---|---|---|---|---|---|
Thông số |
| ||||
Lợi nhuận | Một con trỏ đến đối tượng ExchangeContext đã tạo Khi thành công. Ngược lại NULL nếu không có đối tượng nào có thể được cấp phát hoặc có sẵn. |
NewContext
ExchangeContext * NewContext( const uint64_t & peerNodeId, const IPAddress & peerAddr, void *appState )
Tạo một ExchangeContext mới với một nút Weave ngang hàng nhất định được chỉ định bởi định danh nút ngang hàng và địa chỉ IP ngang hàng.
Chi tiết | |||||||
---|---|---|---|---|---|---|---|
Thông số |
| ||||||
Lợi nhuận | Một con trỏ đến đối tượng ExchangeContext đã tạo Khi thành công. Ngược lại, NULL nếu không có đối tượng nào có thể được cấp phát hoặc có sẵn. |
NewContext
ExchangeContext * NewContext( const uint64_t & peerNodeId, const IPAddress & peerAddr, uint16_t peerPort, InterfaceId sendIntfId, void *appState )
Tạo một ExchangeContext mới với một nút Weave ngang hàng nhất định được chỉ định bởi mã định danh nút ngang hàng, địa chỉ IP ngang hàng và cổng đích trên một giao diện được chỉ định.
Chi tiết | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Thông số |
| ||||||||||
Lợi nhuận | Một con trỏ đến đối tượng ExchangeContext đã tạo Khi thành công. Ngược lại, NULL nếu không có đối tượng nào có thể được cấp phát hoặc có sẵn. |
NewContext
ExchangeContext * NewContext( WeaveConnection *con, void *appState )
Tạo một ExchangeContext mới với một nút Weave ngang hàng nhất định trên một WeaveConnection được chỉ định.
Chi tiết | |||||
---|---|---|---|---|---|
Thông số |
| ||||
Lợi nhuận | Một con trỏ đến đối tượng ExchangeContext đã tạo Khi thành công. Ngược lại, NULL nếu không có đối tượng nào có thể được cấp phát hoặc có sẵn. |
RegisterUnsolicitedMessageHandler
WEAVE_ERROR RegisterUnsolicitedMessageHandler( uint32_t profileId, ExchangeContext::MessageReceiveFunct handler, void *appState )
Đăng ký một trình xử lý thư không được yêu cầu cho một số nhận dạng hồ sơ nhất định.
Trình xử lý này sẽ được gọi cho tất cả các thư của cấu hình đã cho.
Chi tiết | |||||||
---|---|---|---|---|---|---|---|
Thông số |
| ||||||
Giá trị trả lại |
|
RegisterUnsolicitedMessageHandler
WEAVE_ERROR RegisterUnsolicitedMessageHandler( uint32_t profileId, ExchangeContext::MessageReceiveFunct handler, bool allowDups, void *appState )
Đăng ký một trình xử lý thư không được yêu cầu cho một số nhận dạng hồ sơ nhất định.
Trình xử lý này sẽ được gọi cho tất cả các thư của cấu hình đã cho.
Chi tiết | |||||||||
---|---|---|---|---|---|---|---|---|---|
Thông số |
| ||||||||
Giá trị trả lại |
|
RegisterUnsolicitedMessageHandler
WEAVE_ERROR RegisterUnsolicitedMessageHandler( uint32_t profileId, uint8_t msgType, ExchangeContext::MessageReceiveFunct handler, void *appState )
Đăng ký một trình xử lý thư không được yêu cầu cho một số nhận dạng hồ sơ nhất định và loại thư.
Chi tiết | |||||||||
---|---|---|---|---|---|---|---|---|---|
Thông số |
| ||||||||
Giá trị trả lại |
|
RegisterUnsolicitedMessageHandler
WEAVE_ERROR RegisterUnsolicitedMessageHandler( uint32_t profileId, uint8_t msgType, ExchangeContext::MessageReceiveFunct handler, bool allowDups, void *appState )
Đăng ký một trình xử lý thư không được yêu cầu cho một số nhận dạng hồ sơ nhất định và loại thư.
Chi tiết | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Thông số |
| ||||||||||
Giá trị trả lại |
|
RegisterUnsolicitedMessageHandler
WEAVE_ERROR RegisterUnsolicitedMessageHandler( uint32_t profileId, uint8_t msgType, WeaveConnection *con, ExchangeContext::MessageReceiveFunct handler, void *appState )
Đăng ký một trình xử lý tin nhắn không mong muốn cho một số nhận dạng hồ sơ nhất định, loại tin nhắn trên một kết nối Weave được chỉ định.
Chi tiết | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Thông số |
| ||||||||||
Giá trị trả lại |
|
RegisterUnsolicitedMessageHandler
WEAVE_ERROR RegisterUnsolicitedMessageHandler( uint32_t profileId, uint8_t msgType, WeaveConnection *con, ExchangeContext::MessageReceiveFunct handler, bool allowDups, void *appState )
Đăng ký trình xử lý tin nhắn không được yêu cầu cho một số nhận dạng hồ sơ nhất định, loại tin nhắn trên kết nối Weave được chỉ định.
Chi tiết | |||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Thông số |
| ||||||||||||
Giá trị trả lại |
|
Tắt
WEAVE_ERROR Shutdown( void )
Tắt WeaveExchangeManager .
Điều này kết thúc phiên bản này của đối tượng và giải phóng tất cả các tài nguyên được giữ.
Chi tiết | |
---|---|
Lợi nhuận | WEAVE_NO_ERROR vô điều kiện. |
UnregisterUnsolicitedMessageHandler
WEAVE_ERROR UnregisterUnsolicitedMessageHandler( uint32_t profileId )
Hủy đăng ký trình xử lý thư không được yêu cầu cho một số nhận dạng hồ sơ nhất định.
Chi tiết | |||||
---|---|---|---|---|---|
Thông số |
| ||||
Giá trị trả lại |
|
UnregisterUnsolicitedMessageHandler
WEAVE_ERROR UnregisterUnsolicitedMessageHandler( uint32_t profileId, uint8_t msgType )
Hủy đăng ký một trình xử lý thư không được yêu cầu cho một số nhận dạng tiểu sử và loại thư nhất định.
Chi tiết | |||||
---|---|---|---|---|---|
Thông số |
| ||||
Giá trị trả lại |
|
UnregisterUnsolicitedMessageHandler
WEAVE_ERROR UnregisterUnsolicitedMessageHandler( uint32_t profileId, uint8_t msgType, WeaveConnection *con )
Hủy đăng ký một trình xử lý thư không được yêu cầu cho một số nhận dạng cấu hình, loại thư và kết nối Weave nhất định.
Chi tiết | |||||||
---|---|---|---|---|---|---|---|
Thông số |
| ||||||
Giá trị trả lại |
|
WeaveExchangeManager
WeaveExchangeManager( void )
Hàm tạo cho lớp WeaveExchangeManager .
Nó đặt trạng thái thành kState_NotInitialized.