nl :: Dệt :: WeaveMessageLayer
#include <src/lib/core/WeaveMessageLayer.h>
Định nghĩa của lớp WeaveMessageLayer , quản lý giao tiếp với các nút Weave khác.
Tóm lược
Nó sử dụng một trong một số điểm cuối InetLayer để thiết lập kênh giao tiếp với các nút Weave khác.
Người xây dựng và Người phá hủy | |
---|---|
WeaveMessageLayer (void) Phương thức khởi tạo của lớp Thông điệp Weave. |
Các loại công khai | |
---|---|
AcceptErrorFunct )(WeaveMessageLayer *msgLayer, WEAVE_ERROR err) | typedefvoid(* Hàm này là lệnh gọi lại lớp cao hơn để báo cáo lỗi trong quá trình xử lý kết nối TCP đến. |
CallbackRemovedFunct )(void *listenerState) | typedefvoid(* Hàm này được gọi để loại bỏ một lệnh gọi lại. |
ConnectionReceiveFunct )(WeaveMessageLayer *msgLayer, WeaveConnection *con) | typedefvoid(* Hàm này là lệnh gọi lại lớp cao hơn để xử lý kết nối TCP đến. |
MessageLayerActivityChangeHandlerFunct )(bool messageLayerIsActive) | typedefvoid(* Chức năng này là ứng dụng gọi lại để báo cáo sự thay đổi hoạt động của lớp thông báo. |
MessageReceiveFunct )(WeaveMessageLayer *msgLayer, WeaveMessageInfo *msgInfo, PacketBuffer *payload) | typedefvoid(* Hàm này là lệnh gọi lại lớp cao hơn được gọi khi nhận được thông báo Weave qua UDP. |
ReceiveErrorFunct )(WeaveMessageLayer *msgLayer, WEAVE_ERROR err, const IPPacketInfo *pktInfo) | typedefvoid(* Hàm này là lệnh gọi lại lớp cao hơn được gọi khi gặp lỗi. |
State { | enum Trạng thái của WeaveMessageLayer . |
TunneledMsgReceiveFunct )(WeaveMessageLayer *msgLayer, PacketBuffer *payload) | typedefvoid(* Hàm này là lệnh gọi lại lớp cao hơn được gọi khi nhận được gói Tunneled qua đường hầm UDP cục bộ. |
Thuộc tính công cộng | |
---|---|
AppState | void * Một con trỏ đến một đối tượng trạng thái dành riêng cho ứng dụng. |
ExchangeMgr | [CHỈ ĐỌC] Đối tượng WeaveExchangeManager được liên kết. |
FabricState | [CHỈ ĐỌC] Đối tượng WeaveFnaiState được liên kết. |
IncomingConIdleTimeout | uint32_t Thời gian chờ không hoạt động mặc định (tính bằng mili giây) cho các kết nối đến. |
Inet | InetLayer * [CHỈ ĐỌC] Đối tượng InetLayer được liên kết. |
IsListening | bool [CHỈ ĐỌC] Đúng nếu lắng nghe kết nối / tin nhắn đến, nếu không thì sai. |
OnAcceptError | |
OnConnectionReceived | |
OnMessageReceived | |
OnReceiveError | |
OnUDPTunneledMessageReceived | |
SecurityMgr | [CHỈ ĐỌC] Đối tượng WeaveSecurityManager được liên kết. |
State | uint8_t [CHỈ ĐỌC] Trạng thái của đối tượng WeaveMessageLayer . |
SystemLayer | |
mDropMessage | bool Nội bộ và chỉ để gỡ lỗi; Khi được đặt, WeaveMessageLayer sẽ bỏ tin nhắn và trả về. |
Chức năng công cộng | |
---|---|
ClearUnsecuredConnectionListener ( ConnectionReceiveFunct oldOnUnsecuredConnectionReceived, CallbackRemovedFunct newOnUnsecuredConnectionCallbacksRemoved) | |
CloseEndpoints (void) | Đóng tất cả các điểm cuối TCP và UDP đang mở. |
CreateTunnel ( WeaveConnectionTunnel **tunPtr, WeaveConnection & conOne, WeaveConnection & conTwo, uint32_t inactivityTimeoutMS) | Tạo WeaveConnectionTunnel bằng cách ghép hai WeaveConnections được chỉ định với nhau. |
DecodeHeader ( PacketBuffer *msgBuf, WeaveMessageInfo *msgInfo, uint8_t **payloadStart) | Giải mã tiêu đề lớp Thông báo Weave từ thông báo Weave đã nhận. |
EncodeMessage ( WeaveMessageInfo *msgInfo, PacketBuffer *msgBuf, WeaveConnection *con, uint16_t maxLen, uint16_t reserve) | Mã hóa tiêu đề WeaveMessageLayer thành PacketBuffer. |
EncodeMessage (const IPAddress & destAddr, uint16_t destPort, InterfaceId sendIntId, WeaveMessageInfo *msgInfo, PacketBuffer *payload) | Mã hóa tiêu đề lớp Thông báo Weave thành Bộ đệm gói. |
EphemeralUDPPortEnabled (void) const | bool Kiểm tra xem các trao đổi UDP Weave được khởi tạo cục bộ có được gửi từ một cổng nguồn UDP tạm thời hay không. |
GetConnectionPoolStats (nl::Weave::System::Stats::count_t & aOutInUse) const | void Nhận số lượng WeaveConnections đang sử dụng và kích thước của hồ bơi. |
IPv4ListenEnabled (void) const | bool Kiểm tra xem WeaveMessageLayer có được định cấu hình để lắng nghe các liên lạc đến qua IPv4 hay không. |
IPv6ListenEnabled (void) const | bool Kiểm tra xem WeaveMessageLayer có được định cấu hình để lắng nghe các liên lạc đến qua IPv4 hay không. |
Init ( InitContext *context) | Khởi tạo đối tượng lớp Weave Message. |
IsBoundToLocalIPv4Address (void) const | bool Kiểm tra xem WeaveMessageLayer có liên kết với địa chỉ IPv4 cục bộ hay không. |
IsBoundToLocalIPv6Address (void) const | bool Kiểm tra xem WeaveMessageLayer có được liên kết với địa chỉ IPv6 cục bộ hay không. |
IsMessageLayerActive (void) | bool |
NewConnection (void) | Tạo một đối tượng WeaveConnection mới từ một nhóm. |
NewConnectionTunnel (void) | Tạo một đối tượng WeaveConnectionTunnel mới từ một nhóm. |
ReEncodeMessage ( PacketBuffer *buf) | |
RefreshEndpoints (void) | Làm mới các điểm cuối InetLayer dựa trên trạng thái hiện tại của các giao diện mạng của hệ thống. |
ResendMessage ( WeaveMessageInfo *msgInfo, PacketBuffer *msgBuf) | Gửi lại tin nhắn Weave được mã hóa bằng cách sử dụng điểm cuối Inetlayer UDP bên dưới. |
ResendMessage (const IPAddress & destAddr, WeaveMessageInfo *msgInfo, PacketBuffer *msgBuf) | Gửi lại tin nhắn Weave được mã hóa bằng cách sử dụng điểm cuối Inetlayer UDP bên dưới. |
ResendMessage (const IPAddress & destAddr, uint16_t destPort, WeaveMessageInfo *msgInfo, PacketBuffer *msgBuf) | Gửi lại tin nhắn Weave được mã hóa bằng cách sử dụng điểm cuối Inetlayer UDP bên dưới. |
ResendMessage (const IPAddress & destAddr, uint16_t destPort, InterfaceId interfaceId, WeaveMessageInfo *msgInfo, PacketBuffer *msgBuf) | Gửi lại tin nhắn Weave được mã hóa bằng cách sử dụng điểm cuối Inetlayer UDP bên dưới. |
SendMessage ( WeaveMessageInfo *msgInfo, PacketBuffer *msgBuf) | Gửi tin nhắn Weave bằng điểm cuối Inetlayer UDP bên dưới sau khi mã hóa nó. |
SendMessage (const IPAddress & destAddr, WeaveMessageInfo *msgInfo, PacketBuffer *msgBuf) | Gửi tin nhắn Weave bằng điểm cuối Inetlayer UDP bên dưới sau khi mã hóa nó. |
SendMessage (const IPAddress & destAddr, uint16_t destPort, InterfaceId sendIntfId, WeaveMessageInfo *msgInfo, PacketBuffer *msgBuf) | Gửi tin nhắn Weave bằng điểm cuối Inetlayer UDP bên dưới sau khi mã hóa nó. |
SendUDPTunneledMessage (const IPAddress & destAddr, WeaveMessageInfo *msgInfo, PacketBuffer *msgBuf) | Chức năng gửi một gói Tunneled qua một đường hầm UDP cục bộ. |
SetSignalMessageLayerActivityChanged ( MessageLayerActivityChangeHandlerFunct messageLayerActivityChangeHandler) | void Đặt một trình xử lý ứng dụng sẽ được gọi mỗi khi hoạt động của lớp thông báo thay đổi. |
SetTCPListenEnabled (bool val) | void Bật hoặc tắt tính năng nghe các kết nối TCP gửi đến trong WeaveMessageLayer . |
SetUDPListenEnabled (bool val) | void Bật hoặc tắt tính năng nghe các tin nhắn UDP gửi đến trong WeaveMessageLayer . |
SetUnsecuredConnectionListener ( ConnectionReceiveFunct newOnUnsecuredConnectionReceived, CallbackRemovedFunct newOnUnsecuredConnectionCallbacksRemoved, bool force, void *listenerState) | |
Shutdown (void) | Tắt WeaveMessageLayer . |
TCPListenEnabled (void) const | bool Kiểm tra xem WeaveMessageLayer có được định cấu hình để lắng nghe các kết nối TCP gửi đến hay không. |
UDPListenEnabled (void) const | bool Kiểm tra xem WeaveMessageLayer có được định cấu hình để lắng nghe các thông báo UDP đến hay không. |
UnsecuredListenEnabled (void) const | bool Bật hoặc tắt việc bắt đầu trao đổi Weave UDP từ một cổng nguồn UDP tạm thời. |
Chức năng tĩnh công khai | |
---|---|
GetMaxWeavePayloadSize (const PacketBuffer *msgBuf, bool isUDP, uint32_t udpMTU) | uint32_t Nhận kích thước tải trọng Weave tối đa cho cấu hình tin nhắn và PacketBuffer được cung cấp. |
GetPeerDescription (char *buf, size_t bufSize, uint64_t nodeId, const IPAddress *addr, uint16_t port, InterfaceId interfaceId, const WeaveConnection *con) | void Xây dựng một chuỗi mô tả một nút ngang hàng và thông tin địa chỉ / kết nối liên quan của nó. |
GetPeerDescription (char *buf, size_t bufSize, const WeaveMessageInfo *msgInfo) | void Xây dựng một chuỗi mô tả một nút ngang hàng dựa trên thông tin được liên kết với một thông báo nhận được từ nút ngang hàng. |
Các lớp học | |
---|---|
nl :: Weave :: WeaveMessageLayer :: InitContext | Định nghĩa của lớp InitContext . |
Các loại công khai
AcceptErrorFunct
void(* AcceptErrorFunct)(WeaveMessageLayer *msgLayer, WEAVE_ERROR err)
Hàm này là hàm gọi lại lớp cao hơn để báo cáo lỗi trong quá trình xử lý kết nối TCP đến.
Chi tiết | |||||
---|---|---|---|---|---|
Thông số |
|
Gọi lại Đã xóa
void(* CallbackRemovedFunct)(void *listenerState)
Hàm này được gọi để loại bỏ một lệnh gọi lại.
Chi tiết | |||
---|---|---|---|
Thông số |
|
ConnectionReceiveFunct
void(* ConnectionReceiveFunct)(WeaveMessageLayer *msgLayer, WeaveConnection *con)
Hàm này là lệnh gọi lại lớp cao hơn để xử lý kết nối TCP đến.
Chi tiết | |||||
---|---|---|---|---|---|
Thông số |
|
MessageLayerActivityChangeHandlerFunct
void(* MessageLayerActivityChangeHandlerFunct)(bool messageLayerIsActive)
Chức năng này là ứng dụng gọi lại để báo cáo sự thay đổi hoạt động của lớp thông báo.
Lớp thông báo được coi là đang hoạt động nếu có ít nhất một yêu cầu đồng bộ hóa bộ đếm thông báo đang mở hoặc đang chờ xử lý.
Chi tiết | |||
---|---|---|---|
Thông số |
|
MessageReceiveFunct
void(* MessageReceiveFunct)(WeaveMessageLayer *msgLayer, WeaveMessageInfo *msgInfo, PacketBuffer *payload)
Hàm này là lệnh gọi lại lớp cao hơn được gọi khi nhận được thông báo Weave qua UDP.
Chi tiết | |||||||
---|---|---|---|---|---|---|---|
Thông số |
|
GetErrorFunct
void(* ReceiveErrorFunct)(WeaveMessageLayer *msgLayer, WEAVE_ERROR err, const IPPacketInfo *pktInfo)
Hàm này là lệnh gọi lại lớp cao hơn được gọi khi gặp lỗi.
Chi tiết | |||||||
---|---|---|---|---|---|---|---|
Thông số |
|
Tiểu bang
State
Trạng thái của WeaveMessageLayer .
Tính chất | |
---|---|
kState_Initialized | Trạng thái khi WeaveMessageLayer được khởi tạo. |
kState_Initializing | Trạng thái khi WeaveMessageLayer đang trong quá trình khởi tạo. |
kState_NotInitialized | Trạng thái khi WeaveMessageLayer không được khởi tạo. |
TunneledMsgReceiveFunct
void(* TunneledMsgReceiveFunct)(WeaveMessageLayer *msgLayer, PacketBuffer *payload)
Hàm này là lệnh gọi lại lớp cao hơn được gọi khi nhận được gói Tunneled qua đường hầm UDP cục bộ.
Chi tiết | |||||
---|---|---|---|---|---|
Thông số |
|
Thuộc tính công cộng
AppState
void * AppState
Một con trỏ đến một đối tượng trạng thái dành riêng cho ứng dụng.
ExchangeMgr
WeaveExchangeManager * ExchangeMgr
[CHỈ ĐỌC] Đối tượng WeaveExchangeManager được liên kết.
IncomingConIdleTimeout
uint32_t IncomingConIdleTimeout
Thời gian chờ không hoạt động mặc định (tính bằng mili giây) cho các kết nối đến.
Inet
InetLayer * Inet
[CHỈ ĐỌC] Đối tượng InetLayer được liên kết.
Đang nghe
bool IsListening
[CHỈ ĐỌC] Đúng nếu lắng nghe kết nối / tin nhắn đến, nếu không thì sai.
OnAcceptError
AcceptErrorFunct OnAcceptError
OnConnectionRenition
ConnectionReceiveFunct OnConnectionReceived
OnMessageReceive
MessageReceiveFunct OnMessageReceived
OnReceiveError
ReceiveErrorFunct OnReceiveError
OnUDPTunneledMessageReceive
TunneledMsgReceiveFunct OnUDPTunneledMessageReceived
SecurityMgr
WeaveSecurityManager * SecurityMgr
[CHỈ ĐỌC] Đối tượng WeaveSecurityManager được liên kết.
SystemLayer
System::Layer * SystemLayer
mDropMessage
bool mDropMessage
Nội bộ và chỉ để gỡ lỗi; Khi được đặt, WeaveMessageLayer sẽ bỏ tin nhắn và trả về.
Chức năng công cộng
ClearUnsecuredConnectionListener
WEAVE_ERROR ClearUnsecuredConnectionListener( ConnectionReceiveFunct oldOnUnsecuredConnectionReceived, CallbackRemovedFunct newOnUnsecuredConnectionCallbacksRemoved )
CloseEndpoints
WEAVE_ERROR CloseEndpoints( void )
Đóng tất cả các điểm cuối TCP và UDP đang mở.
Sau đó hủy mọi WeaveConnections đang mở và tắt mọi đối tượng WeaveConnectionTunnel đang mở.
Xem thêm:Tắt máy () .
CreateTunnel
WEAVE_ERROR CreateTunnel( WeaveConnectionTunnel **tunPtr, WeaveConnection & conOne, WeaveConnection & conTwo, uint32_t inactivityTimeoutMS )
Tạo WeaveConnectionTunnel bằng cách ghép hai WeaveConnections được chỉ định với nhau.
Khi tạo thành công, các TCPEndPoint tương ứng với các đối tượng thành phần WeaveConnection sẽ được chuyển giao cho WeaveConnectionTunnel , nếu không WeaveConnections sẽ bị đóng.
Chi tiết | |||||||||
---|---|---|---|---|---|---|---|---|---|
Thông số |
| ||||||||
Giá trị trả lại |
|
DecodeHeader
WEAVE_ERROR DecodeHeader( PacketBuffer *msgBuf, WeaveMessageInfo *msgInfo, uint8_t **payloadStart )
Giải mã tiêu đề lớp Thông báo Weave từ thông báo Weave đã nhận.
Chi tiết | |||||||
---|---|---|---|---|---|---|---|
Thông số |
| ||||||
Giá trị trả lại |
|
EncodeMessage
WEAVE_ERROR EncodeMessage( WeaveMessageInfo *msgInfo, PacketBuffer *msgBuf, WeaveConnection *con, uint16_t maxLen, uint16_t reserve )
Mã hóa tiêu đề WeaveMessageLayer thành PacketBuffer.
Chi tiết | |||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Thông số |
| ||||||||||||||
Giá trị trả lại |
|
EncodeMessage
WEAVE_ERROR EncodeMessage( const IPAddress & destAddr, uint16_t destPort, InterfaceId sendIntId, WeaveMessageInfo *msgInfo, PacketBuffer *payload )
Mã hóa tiêu đề lớp Thông báo Weave thành Bộ đệm gói.
Chi tiết | |||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Thông số |
| ||||||||||||||
Giá trị trả lại |
|
EphemeralUDPPortEnabled
bool EphemeralUDPPortEnabled( void ) const
Kiểm tra xem trao đổi Weave UDP được khởi tạo cục bộ có được gửi từ một cổng nguồn UDP tạm thời hay không.
GetConnectionPoolStats
void GetConnectionPoolStats( nl::Weave::System::Stats::count_t & aOutInUse ) const
Nhận số lượng WeaveConnections đang sử dụng và kích thước của hồ bơi.
Chi tiết | |||
---|---|---|---|
Thông số |
|
IPv4ListenEnabled
bool IPv4ListenEnabled( void ) const
Kiểm tra xem WeaveMessageLayer có được định cấu hình để lắng nghe các liên lạc đến qua IPv4 hay không.
IPv6ListenEnabled
bool IPv6ListenEnabled( void ) const
Kiểm tra xem WeaveMessageLayer có được định cấu hình để lắng nghe các liên lạc đến qua IPv4 hay không.
Trong đó
WEAVE_ERROR Init( InitContext *context )
Khởi tạo đối tượng lớp Weave Message.
Chi tiết | |||||||||
---|---|---|---|---|---|---|---|---|---|
Thông số |
| ||||||||
Giá trị trả lại |
|
IsBoundToLocalIPv4Address
bool IsBoundToLocalIPv4Address( void ) const
Kiểm tra xem WeaveMessageLayer có liên kết với địa chỉ IPv4 cục bộ hay không.
IsBoundToLocalIPv6Address
bool IsBoundToLocalIPv6Address( void ) const
Kiểm tra xem WeaveMessageLayer có được liên kết với địa chỉ IPv6 cục bộ hay không.
IsMessageLayerActive
bool IsMessageLayerActive( void )
Kết nối mới
WeaveConnection * NewConnection( void )
Tạo một đối tượng WeaveConnection mới từ một nhóm.
Chi tiết | |
---|---|
Lợi nhuận | một con trỏ đến đối tượng WeaveConnection mới được tạo nếu thành công, nếu không thì NULL. |
NewConnectionTunnel
WeaveConnectionTunnel * NewConnectionTunnel( void )
Tạo một đối tượng WeaveConnectionTunnel mới từ một nhóm.
Chi tiết | |
---|---|
Lợi nhuận | một con trỏ đến đối tượng WeaveConnectionTunnel mới được tạo nếu thành công, nếu không thì NULL. |
ReEncodeMessage
WEAVE_ERROR ReEncodeMessage( PacketBuffer *buf )
RefreshEndpoints
WEAVE_ERROR RefreshEndpoints( void )
Làm mới các điểm cuối InetLayer dựa trên trạng thái hiện tại của các giao diện mạng của hệ thống.
Chi tiết | |||||
---|---|---|---|---|---|
Giá trị trả lại |
|
Gửi lại tin nhắn
WEAVE_ERROR ResendMessage( WeaveMessageInfo *msgInfo, PacketBuffer *msgBuf )
Gửi lại tin nhắn Weave được mã hóa bằng cách sử dụng điểm cuối Inetlayer UDP bên dưới.
Chi tiết | |||||
---|---|---|---|---|---|
Thông số |
| ||||
Giá trị trả lại |
|
Gửi lại tin nhắn
WEAVE_ERROR ResendMessage( const IPAddress & destAddr, WeaveMessageInfo *msgInfo, PacketBuffer *msgBuf )
Gửi lại tin nhắn Weave được mã hóa bằng cách sử dụng điểm cuối Inetlayer UDP bên dưới.
Chi tiết | |||||||
---|---|---|---|---|---|---|---|
Thông số |
| ||||||
Giá trị trả lại |
|
Gửi lại tin nhắn
WEAVE_ERROR ResendMessage( const IPAddress & destAddr, uint16_t destPort, WeaveMessageInfo *msgInfo, PacketBuffer *msgBuf )
Gửi lại tin nhắn Weave được mã hóa bằng cách sử dụng điểm cuối Inetlayer UDP bên dưới.
Chi tiết | |||||||||
---|---|---|---|---|---|---|---|---|---|
Thông số |
| ||||||||
Giá trị trả lại |
|
Gửi lại tin nhắn
WEAVE_ERROR ResendMessage( const IPAddress & destAddr, uint16_t destPort, InterfaceId interfaceId, WeaveMessageInfo *msgInfo, PacketBuffer *msgBuf )
Gửi lại tin nhắn Weave được mã hóa bằng cách sử dụng điểm cuối Inetlayer UDP bên dưới.
Lưu ý: -Nếu địa chỉ đích chưa được cung cấp, hãy cố gắng xác định nó từ mã định danh nút trong tiêu đề thư. Thất bại nếu điều này không thể được thực hiện. -Nếu địa chỉ đích là địa chỉ vải cho cấu trúc cục bộ và người gọi không chỉ định id nút đích, hãy trích xuất nó từ địa chỉ đích.
Chi tiết | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Thông số |
| ||||||||||
Giá trị trả lại |
|
Gửi tin nhắn
WEAVE_ERROR SendMessage( WeaveMessageInfo *msgInfo, PacketBuffer *msgBuf )
Gửi tin nhắn Weave bằng điểm cuối Inetlayer UDP bên dưới sau khi mã hóa nó.
Chi tiết | |||||
---|---|---|---|---|---|
Thông số |
| ||||
Giá trị trả lại |
|
Gửi tin nhắn
WEAVE_ERROR SendMessage( const IPAddress & destAddr, WeaveMessageInfo *msgInfo, PacketBuffer *msgBuf )
Gửi tin nhắn Weave bằng điểm cuối Inetlayer UDP bên dưới sau khi mã hóa nó.
Lưu ý: -Cổng đích được sử dụng là WEAVE_PORT . -Nếu địa chỉ đích chưa được cung cấp, hãy cố gắng xác định nó từ định danh nút trong tiêu đề thư. Không thành công nếu điều này không thể được thực hiện.
-Nếu địa chỉ đích là địa chỉ vải cho cấu trúc cục bộ và người gọi không chỉ định id nút đích, hãy trích xuất nó từ địa chỉ đích.
Chi tiết | |||||||
---|---|---|---|---|---|---|---|
Thông số |
| ||||||
Giá trị trả lại |
|
Gửi tin nhắn
WEAVE_ERROR SendMessage( const IPAddress & destAddr, uint16_t destPort, InterfaceId sendIntfId, WeaveMessageInfo *msgInfo, PacketBuffer *msgBuf )
Gửi tin nhắn Weave bằng điểm cuối Inetlayer UDP bên dưới sau khi mã hóa nó.
Lưu ý: -Nếu địa chỉ đích chưa được cung cấp, hãy cố gắng xác định nó từ mã định danh nút trong tiêu đề thư. Không thành công nếu không thể thực hiện được. -Nếu địa chỉ đích là địa chỉ vải cho cấu trúc cục bộ và người gọi không chỉ định id nút đích, hãy trích xuất nó từ địa chỉ đích.
Chi tiết | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Thông số |
| ||||||||||
Giá trị trả lại |
|
SendUDPTunneledMessage
WEAVE_ERROR SendUDPTunneledMessage( const IPAddress & destAddr, WeaveMessageInfo *msgInfo, PacketBuffer *msgBuf )
Chức năng gửi một gói Tunneled qua một đường hầm UDP cục bộ.
Gửi tin nhắn dữ liệu IPv6 đường hầm qua UDP.
Chi tiết | |||||||
---|---|---|---|---|---|---|---|
Thông số |
| ||||||
Giá trị trả lại |
|
SetSignalMessageLayerActivityChanged
void SetSignalMessageLayerActivityChanged( MessageLayerActivityChangeHandlerFunct messageLayerActivityChangeHandler )
Đặt một trình xử lý ứng dụng sẽ được gọi mỗi khi hoạt động của lớp thông báo thay đổi.
Cụ thể, ứng dụng sẽ được thông báo mọi lúc:
- số lượng các sàn giao dịch đã mở thay đổi.
- số lượng yêu cầu đồng bộ hóa bộ đếm tin nhắn đang chờ xử lý thay đổi từ 0 thành ít nhất một và trở lại 0. Trình xử lý được coi là tín hiệu chung cho biết có bất kỳ cuộc hội thoại nào đang diễn ra trên Weave hoặc phản hồi đang chờ xử lý hay không. Trình xử lý phải được đặt sau khi WeaveMessageLayer đã được khởi tạo; tắt WeaveMessageLayer sẽ xóa trình xử lý hiện tại.
Chi tiết | |||
---|---|---|---|
Thông số |
| ||
Giá trị trả lại |
|
SetTCPListenEnabled
void SetTCPListenEnabled( bool val )
Bật hoặc tắt tính năng nghe các kết nối TCP gửi đến trong WeaveMessageLayer .
LƯU Ý: RefreshEndpoints()
phải được gọi sau khi trạng thái lắng nghe TCP được thay đổi.
SetUDPListenEnabled
void SetUDPListenEnabled( bool val )
Bật hoặc tắt tính năng nghe các tin nhắn UDP gửi đến trong WeaveMessageLayer .
LƯU Ý: RefreshEndpoints()
phải được gọi sau khi trạng thái lắng nghe UDP được thay đổi.
SetUnsecuredConnectionListener
WEAVE_ERROR SetUnsecuredConnectionListener( ConnectionReceiveFunct newOnUnsecuredConnectionReceived, CallbackRemovedFunct newOnUnsecuredConnectionCallbacksRemoved, bool force, void *listenerState )
Tắt
WEAVE_ERROR Shutdown( void )
Tắt WeaveMessageLayer .
Đóng tất cả các điểm cuối lớp Inet đang mở, đặt lại tất cả các lệnh gọi lại lớp cao hơn, các biến thành viên và các đối tượng. Một lệnh gọi đến Shutdown () sẽ kết thúc đối tượng WeaveMessageLayer .
TCPListenEnabled
bool TCPListenEnabled( void ) const
Kiểm tra xem WeaveMessageLayer có được định cấu hình để lắng nghe các kết nối TCP gửi đến hay không.
UDPListenEnabled
bool UDPListenEnabled( void ) const
Kiểm tra xem WeaveMessageLayer có được định cấu hình để nghe tin nhắn UDP gửi đến hay không.
UnsecuredListenEnabled
bool UnsecuredListenEnabled( void ) const
Bật hoặc tắt việc bắt đầu trao đổi Weave UDP từ một cổng nguồn UDP tạm thời.
LƯU Ý: RefreshEndpoints()
phải được gọi sau khi trạng thái cổng tạm thời được thay đổi. Kiểm tra xem tính năng nghe không an toàn đã được bật chưa.
WeaveMessageLayer
WeaveMessageLayer( void )
Phương thức khởi tạo của lớp Thông điệp Weave.
Chức năng tĩnh công khai
GetMaxWeavePayloadSize
uint32_t GetMaxWeavePayloadSize( const PacketBuffer *msgBuf, bool isUDP, uint32_t udpMTU )
Nhận kích thước tải trọng Weave tối đa cho cấu hình tin nhắn và PacketBuffer được cung cấp.
Kích thước tải trọng tối đa được trả về sẽ không vượt quá dung lượng khả dụng cho tải trọng bên trong PacketBuffer được cung cấp.
Nếu thông báo là UDP, kích thước trọng tải tối đa được trả về sẽ không dẫn đến thông báo Weave sẽ không làm tràn UDP MTU được chỉ định.
Cuối cùng, kích thước tải trọng tối đa được trả về sẽ không dẫn đến thông báo Weave sẽ làm tràn kích thước thông báo Weave tối đa.
Chi tiết | |||||||
---|---|---|---|---|---|---|---|
Thông số |
| ||||||
Lợi nhuận | kích thước tải trọng tối đa của Weave. |
GetPeerDescription
void GetPeerDescription( char *buf, size_t bufSize, uint64_t nodeId, const IPAddress *addr, uint16_t port, InterfaceId interfaceId, const WeaveConnection *con )
Xây dựng một chuỗi mô tả một nút ngang hàng và thông tin địa chỉ / kết nối liên quan của nó.
Chuỗi được tạo có định dạng sau:
([ ]: % , con )
Chi tiết | |||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Thông số |
|
GetPeerDescription
void GetPeerDescription( char *buf, size_t bufSize, const WeaveMessageInfo *msgInfo )
Xây dựng một chuỗi mô tả một nút ngang hàng dựa trên thông tin được liên kết với một thông báo nhận được từ nút ngang hàng.
Chi tiết | |||||||
---|---|---|---|---|---|---|---|
Thông số |
|