nl:: Weave:: WeaveExchangeManager
#include <src/lib/core/WeaveExchangeMgr.h>
Lớp này dùng để quản lý ExchangeContexts với các nút Weave khác.
Tóm tắt
Nền tảng này hoạt động thay mặt cho các lớp cao hơn, tạo ra ExchangeContexts và xử lý việc đăng ký/huỷ đăng ký trình xử lý tin nhắn không mong muốn.
Hàm khởi tạo và phá huỷ |
|
---|---|
WeaveExchangeManager(void)
Hàm khởi tạo cho lớp WeaveExchangeManager.
|
Loại công khai |
|
---|---|
State{
|
enum |
Các thuộc tính công khai |
|
---|---|
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.
|
Hàm công khai |
|
---|---|
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 đã chỉ định.
|
ClearMsgCounterSyncReq(uint64_t peerNodeId)
|
void
Xoá cờ MESSAGECounterSyncReq cho tất cả các tin nhắn đang chờ xử lý gửi đến ứng dụng ngang hà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 tập hợp các tham số nhất định.
|
Init(WeaveMessageLayer *msgLayer)
|
Khởi động đố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ố đã cung cấp.
|
NewContext(const uint64_t & peerNodeId, void *appState)
|
Tạo một ExchangeContext mới bằng một nút Weave ngang hàng nhất định do giá trị nhận dạng nút ngang hàng chỉ định.
|
NewContext(const uint64_t & peerNodeId, const IPAddress & peerAddr, void *appState)
|
Tạo một ExchangeContext mới bằng một nút Weave ngang hàng nhất định được chỉ định theo giá trị 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 bằng một nút Weave ngang hàng nhất định được chỉ định theo giá trị 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 có một nút Weave ngang hàng nhất định qua một WeaveConnection được chỉ định.
|
RegisterUnsolicitedMessageHandler(uint32_t profileId, ExchangeContext::MessageReceiveFunct handler, void *appState)
|
Đăng ký một trình xử lý thông báo không mong muốn cho một giá trị nhận dạng hồ sơ cụ thể.
|
RegisterUnsolicitedMessageHandler(uint32_t profileId, ExchangeContext::MessageReceiveFunct handler, bool allowDups, void *appState)
|
Đăng ký một trình xử lý thông báo không mong muốn cho một giá trị nhận dạng hồ sơ cụ thể.
|
RegisterUnsolicitedMessageHandler(uint32_t profileId, uint8_t msgType, ExchangeContext::MessageReceiveFunct handler, void *appState)
|
Đăng ký một trình xử lý thông báo không mong muốn cho một giá trị nhận dạng hồ sơ và loại thông báo nhất định.
|
RegisterUnsolicitedMessageHandler(uint32_t profileId, uint8_t msgType, ExchangeContext::MessageReceiveFunct handler, bool allowDups, void *appState)
|
Đăng ký một trình xử lý thông báo không mong muốn cho một giá trị nhận dạng hồ sơ và loại thông báo nhất định.
|
RegisterUnsolicitedMessageHandler(uint32_t profileId, uint8_t msgType, WeaveConnection *con, ExchangeContext::MessageReceiveFunct handler, void *appState)
|
Đăng ký một trình xử lý thông báo không mong muốn cho một giá trị nhận dạng hồ sơ nhất định, loại thông báo 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ý một trình xử lý thông báo không mong muốn cho một giá trị nhận dạng hồ sơ nhất định, loại thông báo trên một kết nối Weave được chỉ định.
|
Shutdown(void)
|
Tắt WeaveExchangeManager.
|
UnregisterUnsolicitedMessageHandler(uint32_t profileId)
|
Huỷ đăng ký trình xử lý thông báo không mong muốn cho một giá trị nhận dạng hồ sơ nhất định.
|
UnregisterUnsolicitedMessageHandler(uint32_t profileId, uint8_t msgType)
|
Huỷ đăng ký trình xử lý thông báo không mong muốn cho một giá trị nhận dạng hồ sơ và loại thông báo nhất định.
|
UnregisterUnsolicitedMessageHandler(uint32_t profileId, uint8_t msgType, WeaveConnection *con)
|
Huỷ đăng ký trình xử lý thông báo không mong muốn cho một giá trị nhận dạng hồ sơ, loại thông báo và kết nối Weave nhất định.
|
Loại công khai
Tiểu bang
State
Thuộc tính | |
---|---|
kState_Initialized
|
Dùng để cho biết rằng WeaveExchangeManager được khởi động. |
kState_NotInitialized
|
Dùng để cho biết rằng WeaveExchangeManager không được khởi chạy. |
Các thuộc tính công khai
Hàm công khai
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 đã chỉ định.
Phương thức này sẽ thiết lập trình xử lý tiếp nhận thông báo trên kết nối Weave đã cho.
Chi tiết | |||
---|---|---|---|
Tham số |
|
ClearMsgCounterSyncReq
void ClearMsgCounterSyncReq( uint64_t peerNodeId )
Xoá cờ MESSAGECounterSyncReq cho tất cả các tin nhắn đang chờ xử lý gửi đến ứng dụng ngang hàng đó.
Chi tiết | |||
---|---|---|---|
Tham 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 tập hợp các tham số nhất định.
Chi tiết | |||||||||
---|---|---|---|---|---|---|---|---|---|
Tham số |
|
||||||||
Trả về |
Con trỏ trỏ đến đối tượng ExchangeContext khớp với các tham số được cung cấp Khi thành công, NULL không khớp với bất kỳ giá trị nào.
|
Init
WEAVE_ERROR Init( WeaveMessageLayer *msgLayer )
Khởi động đối tượng WeaveExchangeManager.
Trong vòng đời của thực thể này, phương thức này được gọi một lần sau khi tạo đối tượng cho đến khi có lệnh gọi đến Tắt máy để chấm dứt thực thể.
Chi tiết | |||||
---|---|---|---|---|---|
Tham số |
|
||||
Giá trị trả về |
|
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ố đã cung cấp.
Chi tiết | |||||
---|---|---|---|---|---|
Tham số |
|
||||
Trả về |
Con trỏ trỏ đến Binding mới được phân bổ hoặc NULL nếu nhóm đã hết
|
NewContext
ExchangeContext * NewContext( const uint64_t & peerNodeId, void *appState )
Tạo một ExchangeContext mới bằng một nút Weave ngang hàng nhất định do giá trị nhận dạng nút ngang hàng chỉ định.
Chi tiết | |||||
---|---|---|---|---|---|
Tham số |
|
||||
Trả về |
Con trỏ trỏ đến đối tượng ExchangeContext đã tạo Khi thành công. Nếu không, giá trị sẽ là NULL (Rỗng) nếu không có đối tượng nào có thể được phân bổ hoặc có sẵn.
|
NewContext
ExchangeContext * NewContext( const uint64_t & peerNodeId, const IPAddress & peerAddr, void *appState )
Tạo một ExchangeContext mới bằng một nút Weave ngang hàng nhất định được chỉ định theo giá trị nhận dạng nút ngang hàng và địa chỉ IP ngang hàng.
Chi tiết | |||||||
---|---|---|---|---|---|---|---|
Tham số |
|
||||||
Trả về |
Con trỏ trỏ đến đối tượng ExchangeContext đã tạo Khi thành công. Nếu không, giá trị này sẽ là giá trị NULL nếu không thể phân bổ hoặc có sẵn đối tượng nào.
|
NewContext
ExchangeContext * NewContext( const uint64_t & peerNodeId, const IPAddress & peerAddr, uint16_t peerPort, InterfaceId sendIntfId, void *appState )
Tạo một ExchangeContext mới bằng một nút Weave ngang hàng nhất định được chỉ định theo giá trị 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.
Chi tiết | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Tham số |
|
||||||||||
Trả về |
Con trỏ trỏ đến đối tượng ExchangeContext đã tạo Khi thành công. Nếu không, giá trị này sẽ là giá trị NULL nếu không thể phân bổ hoặc có sẵn đối tượng nào.
|
NewContext
ExchangeContext * NewContext( WeaveConnection *con, void *appState )
Tạo một ExchangeContext mới có một nút Weave ngang hàng nhất định qua một WeaveConnection được chỉ định.
Chi tiết | |||||
---|---|---|---|---|---|
Tham số |
|
||||
Trả về |
Con trỏ trỏ đến đối tượng ExchangeContext đã tạo Khi thành công. Nếu không, giá trị này sẽ là giá trị NULL nếu không thể phân bổ hoặc có sẵn đối tượng nào.
|
RegisterUnsolicitedMessageHandler
WEAVE_ERROR RegisterUnsolicitedMessageHandler( uint32_t profileId, ExchangeContext::MessageReceiveFunct handler, void *appState )
Đăng ký một trình xử lý thông báo không mong muốn cho một giá trị nhận dạng hồ sơ cụ thể.
Trình xử lý này sẽ được gọi cho tất cả thông báo của hồ sơ nhất định.
Chi tiết | |||||||
---|---|---|---|---|---|---|---|
Tham số |
|
||||||
Giá trị trả về |
|
RegisterUnsolicitedMessageHandler
WEAVE_ERROR RegisterUnsolicitedMessageHandler( uint32_t profileId, ExchangeContext::MessageReceiveFunct handler, bool allowDups, void *appState )
Đăng ký một trình xử lý thông báo không mong muốn cho một giá trị nhận dạng hồ sơ cụ thể.
Trình xử lý này sẽ được gọi cho tất cả thông báo của hồ sơ nhất định.
Chi tiết | |||||||||
---|---|---|---|---|---|---|---|---|---|
Tham số |
|
||||||||
Giá trị trả về |
|
RegisterUnsolicitedMessageHandler
WEAVE_ERROR RegisterUnsolicitedMessageHandler( uint32_t profileId, uint8_t msgType, ExchangeContext::MessageReceiveFunct handler, void *appState )
Đăng ký một trình xử lý thông báo không mong muốn cho một giá trị nhận dạng hồ sơ và loại thông báo nhất định.
Chi tiết | |||||||||
---|---|---|---|---|---|---|---|---|---|
Tham số |
|
||||||||
Giá trị trả về |
|
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ông báo không mong muốn cho một giá trị nhận dạng hồ sơ và loại thông báo nhất định.
Chi tiết | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Tham số |
|
||||||||||
Giá trị trả về |
|
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ý thông báo không mong muốn cho một giá trị nhận dạng hồ sơ nhất định, loại thông báo trên một kết nối Weave được chỉ định.
Chi tiết | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Tham số |
|
||||||||||
Giá trị trả về |
|
RegisterUnsolicitedMessageHandler
WEAVE_ERROR RegisterUnsolicitedMessageHandler( uint32_t profileId, uint8_t msgType, WeaveConnection *con, ExchangeContext::MessageReceiveFunct handler, bool allowDups, void *appState )
Đăng ký một trình xử lý thông báo không mong muốn cho một giá trị nhận dạng hồ sơ nhất định, loại thông báo trên một kết nối Weave được chỉ định.
Chi tiết | |||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Tham số |
|
||||||||||||
Giá trị trả về |
|
Tắt
WEAVE_ERROR Shutdown( void )
Tắt WeaveExchangeManager.
Thao tác này sẽ chấm dứt thực thể này của đối tượng và giải phóng tất cả tài nguyên được giữ lại.
Chi tiết | |
---|---|
Trả về |
WEAVE_NO_ERROR một cách vô điều kiện.
|
UnregisterUnsolicitedMessageHandler
WEAVE_ERROR UnregisterUnsolicitedMessageHandler( uint32_t profileId )
Huỷ đăng ký trình xử lý thông báo không mong muốn cho một giá trị nhận dạng hồ sơ nhất định.
Chi tiết | |||||
---|---|---|---|---|---|
Tham số |
|
||||
Giá trị trả về |
|
UnregisterUnsolicitedMessageHandler
WEAVE_ERROR UnregisterUnsolicitedMessageHandler( uint32_t profileId, uint8_t msgType )
Huỷ đăng ký trình xử lý thông báo không mong muốn cho một giá trị nhận dạng hồ sơ và loại thông báo nhất định.
Chi tiết | |||||
---|---|---|---|---|---|
Tham số |
|
||||
Giá trị trả về |
|
UnregisterUnsolicitedMessageHandler
WEAVE_ERROR UnregisterUnsolicitedMessageHandler( uint32_t profileId, uint8_t msgType, WeaveConnection *con )
Huỷ đăng ký trình xử lý thông báo không mong muốn cho một giá trị nhận dạng hồ sơ, loại thông báo và kết nối Weave nhất định.
Chi tiết | |||||||
---|---|---|---|---|---|---|---|
Tham số |
|
||||||
Giá trị trả về |
|
WeaveExchangeManager
WeaveExchangeManager( void )
Hàm khởi tạo cho lớp WeaveExchangeManager.
Đoạn mã này đặt trạng thái thành kState_NotInitialized.