nl:: Weave:: WeaveMessageLayer
#include <src/lib/core/WeaveMessageLayer.h>
Die Definition der Klasse WeaveMessageLayer, die die Kommunikation mit anderen Weave-Knoten verwaltet.
Zusammenfassung
Dabei wird einer von mehreren InetLayer-Endpunkten verwendet, um einen Kommunikationskanal mit anderen Weave-Knoten einzurichten.
Konstruktoren und Zerstörer |
|
---|---|
WeaveMessageLayer(void)
Der Weave Message-Ebenenkonstruktor.
|
Öffentliche Typen |
|
---|---|
AcceptErrorFunct)(WeaveMessageLayer *msgLayer, WEAVE_ERROR err)
|
typedef.void(*
Diese Funktion ist der Callback auf der höheren Ebene, mit dem bei der Verarbeitung einer eingehenden TCP-Verbindung ein Fehler gemeldet wird. |
CallbackRemovedFunct)(void *listenerState)
|
typedef.void(*
Diese Funktion wird zum Entfernen eines Callbacks aufgerufen. |
ConnectionReceiveFunct)(WeaveMessageLayer *msgLayer, WeaveConnection *con)
|
typedef.void(*
Diese Funktion ist der Callback der höheren Ebene für die Verarbeitung einer eingehenden TCP-Verbindung. |
MessageLayerActivityChangeHandlerFunct)(bool messageLayerIsActive)
|
typedef.void(*
Diese Funktion ist der Anwendungs-Callback zum Melden von Aktivitätsänderungen der Nachrichtenebene. |
MessageReceiveFunct)(WeaveMessageLayer *msgLayer, WeaveMessageInfo *msgInfo, PacketBuffer *payload)
|
typedef.void(*
Diese Funktion ist der Callback auf der höheren Ebene, der beim Empfang einer Weave-Nachricht über UDP aufgerufen wird. |
ReceiveErrorFunct)(WeaveMessageLayer *msgLayer, WEAVE_ERROR err, const IPPacketInfo *pktInfo)
|
typedef.void(*
Diese Funktion ist der Callback der höheren Ebene, der ausgelöst wird, wenn ein Fehler auftritt. |
State{
|
enum Der Status von WeaveMessageLayer. |
TunneledMsgReceiveFunct)(WeaveMessageLayer *msgLayer, PacketBuffer *payload)
|
typedef.void(*
Diese Funktion ist der Callback auf der höheren Ebene, der beim Empfang eines Tunnelpakets über einen lokalen UDP-Tunnel aufgerufen wird. |
Öffentliche Attribute |
|
---|---|
AppState
|
void *
Ein Zeiger auf ein anwendungsspezifisches Statusobjekt.
|
ExchangeMgr
|
[READ ONLY] Das zugehörige WeaveExchangeManager-Objekt.
|
FabricState
|
[READ ONLY] Das zugehörige Objekt WeaveFabricState.
|
IncomingConIdleTimeout
|
uint32_t
Standardzeitlimit bei Inaktivität (in Millisekunden) für eingehende Verbindungen.
|
Inet
|
InetLayer *
[READ ONLY] Das zugehörige InetLayer-Objekt.
|
IsListening
|
bool
[READ ONLY] "True", wenn eingehende Verbindungen/Nachrichten überwacht werden, andernfalls "False".
|
OnAcceptError
|
|
OnConnectionReceived
|
|
OnMessageReceived
|
|
OnReceiveError
|
|
OnUDPTunneledMessageReceived
|
|
SecurityMgr
|
[READ ONLY] Das zugehörige Objekt WeaveSecurityManager.
|
State
|
uint8_t
[READ ONLY] Der Status des Objekts WeaveMessageLayer.
|
SystemLayer
|
|
mDropMessage
|
bool
zur internen Verwendung und zur Fehlerbehebung. Wenn dies festgelegt ist, löscht WeaveMessageLayer die Nachricht und kehrt zurück.
|
Öffentliche Funktionen |
|
---|---|
ClearUnsecuredConnectionListener(ConnectionReceiveFunct oldOnUnsecuredConnectionReceived, CallbackRemovedFunct newOnUnsecuredConnectionCallbacksRemoved)
|
|
CloseEndpoints(void)
|
Schließen Sie alle offenen TCP- und UDP-Endpunkte.
|
CreateTunnel(WeaveConnectionTunnel **tunPtr, WeaveConnection & conOne, WeaveConnection & conTwo, uint32_t inactivityTimeoutMS)
|
Erstellen Sie einen WeaveConnectionTunnel, indem Sie zwei angegebene WeaveConnections miteinander koppeln.
|
DecodeHeader(PacketBuffer *msgBuf, WeaveMessageInfo *msgInfo, uint8_t **payloadStart)
|
Decodieren Sie den Ebenen-Header einer Weave-Nachricht aus einer empfangenen Weave-Nachricht.
|
EncodeMessage(WeaveMessageInfo *msgInfo, PacketBuffer *msgBuf, WeaveConnection *con, uint16_t maxLen, uint16_t reserve)
|
Codieren Sie einen WeaveMessageLayer-Header in einen PacketBuffer.
|
EncodeMessage(const IPAddress & destAddr, uint16_t destPort, InterfaceId sendIntId, WeaveMessageInfo *msgInfo, PacketBuffer *payload)
|
Codieren Sie einen Weave Message-Layer-Header in einen PacketBuffer.
|
EphemeralUDPPortEnabled(void) const
|
bool
Prüfen Sie, ob lokal initiierte Weave-UDP-Austausche von einem sitzungsspezifischen UDP-Quellport gesendet werden sollen.
|
GetConnectionPoolStats(nl::Weave::System::Stats::count_t & aOutInUse) const
|
void
Rufen Sie die Anzahl der verwendeten WeaveConnections und die Größe des Pools ab.
|
IPv4ListenEnabled(void) const
|
bool
Prüfen Sie, ob WeaveMessageLayer so konfiguriert ist, dass eingehende Kommunikation über IPv4 überwacht wird.
|
IPv6ListenEnabled(void) const
|
bool
Prüfen Sie, ob WeaveMessageLayer so konfiguriert ist, dass eingehende Kommunikation über IPv4 überwacht wird.
|
Init(InitContext *context)
|
Initialisieren Sie das Weave Message-Ebenenobjekt.
|
IsBoundToLocalIPv4Address(void) const
|
bool
Prüfen Sie, ob WeaveMessageLayer an eine lokale IPv4-Adresse gebunden ist.
|
IsBoundToLocalIPv6Address(void) const
|
bool
Prüfen Sie, ob WeaveMessageLayer an eine lokale IPv6-Adresse gebunden ist.
|
IsMessageLayerActive(void)
|
bool
|
NewConnection(void)
|
Erstellen Sie ein neues WeaveConnection-Objekt aus einem Pool.
|
NewConnectionTunnel(void)
|
Erstellen Sie ein neues WeaveConnectionTunnel-Objekt aus einem Pool.
|
ReEncodeMessage(PacketBuffer *buf)
|
|
RefreshEndpoints(void)
|
Aktualisieren Sie die InetLayer-Endpunkte basierend auf dem aktuellen Status der Netzwerkschnittstellen des Systems.
|
ResendMessage(WeaveMessageInfo *msgInfo, PacketBuffer *msgBuf)
|
Eine codierte Weave-Nachricht über den zugrunde liegenden Inetlayer-UDP-Endpunkt noch einmal senden.
|
ResendMessage(const IPAddress & destAddr, WeaveMessageInfo *msgInfo, PacketBuffer *msgBuf)
|
Eine codierte Weave-Nachricht über den zugrunde liegenden Inetlayer-UDP-Endpunkt noch einmal senden.
|
ResendMessage(const IPAddress & destAddr, uint16_t destPort, WeaveMessageInfo *msgInfo, PacketBuffer *msgBuf)
|
Eine codierte Weave-Nachricht über den zugrunde liegenden Inetlayer-UDP-Endpunkt noch einmal senden.
|
ResendMessage(const IPAddress & destAddr, uint16_t destPort, InterfaceId interfaceId, WeaveMessageInfo *msgInfo, PacketBuffer *msgBuf)
|
Eine codierte Weave-Nachricht über den zugrunde liegenden Inetlayer-UDP-Endpunkt noch einmal senden.
|
SendMessage(WeaveMessageInfo *msgInfo, PacketBuffer *msgBuf)
|
Senden Sie nach der Codierung eine Weave-Nachricht über den zugrunde liegenden Inetlayer-UDP-Endpunkt.
|
SendMessage(const IPAddress & destAddr, WeaveMessageInfo *msgInfo, PacketBuffer *msgBuf)
|
Senden Sie nach der Codierung eine Weave-Nachricht über den zugrunde liegenden Inetlayer-UDP-Endpunkt.
|
SendMessage(const IPAddress & destAddr, uint16_t destPort, InterfaceId sendIntfId, WeaveMessageInfo *msgInfo, PacketBuffer *msgBuf)
|
Senden Sie nach der Codierung eine Weave-Nachricht über den zugrunde liegenden Inetlayer-UDP-Endpunkt.
|
SendUDPTunneledMessage(const IPAddress & destAddr, WeaveMessageInfo *msgInfo, PacketBuffer *msgBuf)
|
Funktion zum Senden eines Tunnelpakets über einen lokalen UDP-Tunnel.
|
SetSignalMessageLayerActivityChanged(MessageLayerActivityChangeHandlerFunct messageLayerActivityChangeHandler)
|
void
Legen Sie einen Anwendungs-Handler fest, der jedes Mal aufgerufen wird, wenn sich die Aktivität der Nachrichtenebene ändert.
|
SetTCPListenEnabled(bool val)
|
void
Aktivieren oder deaktivieren Sie das Warten auf eingehende TCP-Verbindungen in WeaveMessageLayer.
|
SetUDPListenEnabled(bool val)
|
void
Aktivieren oder deaktivieren Sie das Warten auf eingehende UDP-Nachrichten in WeaveMessageLayer.
|
SetUnsecuredConnectionListener(ConnectionReceiveFunct newOnUnsecuredConnectionReceived, CallbackRemovedFunct newOnUnsecuredConnectionCallbacksRemoved, bool force, void *listenerState)
|
|
Shutdown(void)
|
Fahren Sie WeaveMessageLayer herunter.
|
TCPListenEnabled(void) const
|
bool
Prüfen Sie, ob WeaveMessageLayer so konfiguriert ist, dass eingehende TCP-Verbindungen überwacht werden.
|
UDPListenEnabled(void) const
|
bool
Prüfen Sie, ob WeaveMessageLayer so konfiguriert ist, dass eingehende UDP-Nachrichten abgehört werden.
|
UnsecuredListenEnabled(void) const
|
bool
Aktivieren oder deaktivieren Sie das Initiieren von Weave-UDP-Austauschen über einen sitzungsspezifischen UDP-Quellport.
|
Öffentliche statische Funktionen |
|
---|---|
GetMaxWeavePayloadSize(const PacketBuffer *msgBuf, bool isUDP, uint32_t udpMTU)
|
uint32_t
Ruft die maximale Weave-Nutzlastgröße für eine Nachrichtenkonfiguration und den bereitgestellten PacketBuffer ab.
|
GetPeerDescription(char *buf, size_t bufSize, uint64_t nodeId, const IPAddress *addr, uint16_t port, InterfaceId interfaceId, const WeaveConnection *con)
|
void
Erstellt einen String, der einen Peer-Knoten und die zugehörigen Adress-/Verbindungsinformationen beschreibt.
|
GetPeerDescription(char *buf, size_t bufSize, const WeaveMessageInfo *msgInfo)
|
void
Erstellt einen String, der einen Peer-Knoten anhand der Informationen zu einer vom Peer empfangenen Nachricht beschreibt.
|
Klassen |
|
---|---|
nl:: |
Die Definition der Klasse InitContext. |
Öffentliche Typen
AcceptErrorFunct
void(* AcceptErrorFunct)(WeaveMessageLayer *msgLayer, WEAVE_ERROR err)
Diese Funktion ist der Callback auf der höheren Ebene, mit dem bei der Verarbeitung einer eingehenden TCP-Verbindung ein Fehler gemeldet wird.
Details | |||||
---|---|---|---|---|---|
Parameter |
|
CallbackRemovedFunct
void(* CallbackRemovedFunct)(void *listenerState)
Diese Funktion wird zum Entfernen eines Callbacks aufgerufen.
Details | |||
---|---|---|---|
Parameter |
|
ConnectionReceiveFunct
void(* ConnectionReceiveFunct)(WeaveMessageLayer *msgLayer, WeaveConnection *con)
Diese Funktion ist der Callback der höheren Ebene für die Verarbeitung einer eingehenden TCP-Verbindung.
Details | |||||
---|---|---|---|---|---|
Parameter |
|
MessageLayerActivityChangeHandlerFunct
void(* MessageLayerActivityChangeHandlerFunct)(bool messageLayerIsActive)
Diese Funktion ist der Anwendungs-Callback zum Melden von Aktivitätsänderungen der Nachrichtenebene.
Die Nachrichtenebene gilt als aktiv, wenn es mindestens eine Anfrage für einen offenen Austausch oder eine ausstehende Anfrage zur Synchronisierung von Nachrichtenzählern gibt.
Details | |||
---|---|---|---|
Parameter |
|
MessageReceiveFunct
void(* MessageReceiveFunct)(WeaveMessageLayer *msgLayer, WeaveMessageInfo *msgInfo, PacketBuffer *payload)
Diese Funktion ist der Callback auf der höheren Ebene, der beim Empfang einer Weave-Nachricht über UDP aufgerufen wird.
Details | |||||||
---|---|---|---|---|---|---|---|
Parameter |
|
ReceiveErrorFunct
void(* ReceiveErrorFunct)(WeaveMessageLayer *msgLayer, WEAVE_ERROR err, const IPPacketInfo *pktInfo)
Diese Funktion ist der Callback der höheren Ebene, der ausgelöst wird, wenn ein Fehler auftritt.
Details | |||||||
---|---|---|---|---|---|---|---|
Parameter |
|
Status
State
Der Status von WeaveMessageLayer.
Attribute | |
---|---|
kState_Initialized
|
Status, wenn WeaveMessageLayer initialisiert wird. |
kState_Initializing
|
Status, wenn WeaveMessageLayer gerade initialisiert wird. |
kState_NotInitialized
|
Status, wenn WeaveMessageLayer nicht initialisiert ist. |
TunneledMsgReceiveFunct
void(* TunneledMsgReceiveFunct)(WeaveMessageLayer *msgLayer, PacketBuffer *payload)
Diese Funktion ist der Callback auf der höheren Ebene, der beim Empfang eines Tunnelpakets über einen lokalen UDP-Tunnel aufgerufen wird.
Details | |||||
---|---|---|---|---|---|
Parameter |
|
Öffentliche Attribute
AppState
void * AppState
Ein Zeiger auf ein anwendungsspezifisches Statusobjekt.
ExchangeMgr
WeaveExchangeManager * ExchangeMgr
[READ ONLY] Das zugehörige WeaveExchangeManager-Objekt.
IncomingConIdleTimeout
uint32_t IncomingConIdleTimeout
Standardzeitlimit bei Inaktivität (in Millisekunden) für eingehende Verbindungen.
Inet
InetLayer * Inet
[READ ONLY] Das zugehörige InetLayer-Objekt.
IsListening
bool IsListening
[READ ONLY] "True", wenn eingehende Verbindungen/Nachrichten überwacht werden, andernfalls "False".
OnAcceptError
AcceptErrorFunct OnAcceptError
OnConnectionReceived
ConnectionReceiveFunct OnConnectionReceived
OnMessageReceived
MessageReceiveFunct OnMessageReceived
OnReceiveError
ReceiveErrorFunct OnReceiveError
OnUDPTunneledMessageReceived
TunneledMsgReceiveFunct OnUDPTunneledMessageReceived
SecurityMgr
WeaveSecurityManager * SecurityMgr
[READ ONLY] Das zugehörige Objekt WeaveSecurityManager.
SystemLayer
System::Layer * SystemLayer
mDropMessage
bool mDropMessage
zur internen Verwendung und zur Fehlerbehebung. Wenn dies festgelegt ist, löscht WeaveMessageLayer die Nachricht und kehrt zurück.
Öffentliche Funktionen
ClearUnsecuredConnectionListener
WEAVE_ERROR ClearUnsecuredConnectionListener( ConnectionReceiveFunct oldOnUnsecuredConnectionReceived, CallbackRemovedFunct newOnUnsecuredConnectionCallbacksRemoved )
CloseEndpoints
WEAVE_ERROR CloseEndpoints( void )
Schließen Sie alle offenen TCP- und UDP-Endpunkte.
Brechen Sie dann alle offenen WeaveConnections ab und fahren Sie alle geöffneten WeaveConnectionTunnel-Objekte herunter.
Siehe auch:Herunterfahren().
CreateTunnel
WEAVE_ERROR CreateTunnel( WeaveConnectionTunnel **tunPtr, WeaveConnection & conOne, WeaveConnection & conTwo, uint32_t inactivityTimeoutMS )
Erstellen Sie einen WeaveConnectionTunnel, indem Sie zwei angegebene WeaveConnections miteinander koppeln.
Nach erfolgreicher Erstellung werden die TCPEndPoints, die der Komponente WeaveConnection entsprechen, an den WeaveConnectionTunnel übergeben. Andernfalls werden die WeaveConnections geschlossen.
Details | |||||||||
---|---|---|---|---|---|---|---|---|---|
Parameter |
|
||||||||
Rückgabewerte |
|
DecodeHeader
WEAVE_ERROR DecodeHeader( PacketBuffer *msgBuf, WeaveMessageInfo *msgInfo, uint8_t **payloadStart )
Decodieren Sie den Ebenen-Header einer Weave-Nachricht aus einer empfangenen Weave-Nachricht.
Details | |||||||
---|---|---|---|---|---|---|---|
Parameter |
|
||||||
Rückgabewerte |
|
EncodeMessage
WEAVE_ERROR EncodeMessage( WeaveMessageInfo *msgInfo, PacketBuffer *msgBuf, WeaveConnection *con, uint16_t maxLen, uint16_t reserve )
Codieren Sie einen WeaveMessageLayer-Header in einen PacketBuffer.
Details | |||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Parameter |
|
||||||||||||||
Rückgabewerte |
|
EncodeMessage
WEAVE_ERROR EncodeMessage( const IPAddress & destAddr, uint16_t destPort, InterfaceId sendIntId, WeaveMessageInfo *msgInfo, PacketBuffer *payload )
Codieren Sie einen Weave Message-Layer-Header in einen PacketBuffer.
Details | |||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Parameter |
|
||||||||||||||
Rückgabewerte |
|
EphemeralUDPPortEnabled
bool EphemeralUDPPortEnabled( void ) const
Prüfen Sie, ob lokal initiierte Weave-UDP-Austausche von einem sitzungsspezifischen UDP-Quellport gesendet werden sollen.
GetConnectionPoolStats
void GetConnectionPoolStats( nl::Weave::System::Stats::count_t & aOutInUse ) const
Rufen Sie die Anzahl der verwendeten WeaveConnections und die Größe des Pools ab.
Details | |||
---|---|---|---|
Parameter |
|
IPv4ListenEnabled
bool IPv4ListenEnabled( void ) const
Prüfen Sie, ob WeaveMessageLayer so konfiguriert ist, dass eingehende Kommunikation über IPv4 überwacht wird.
IPv6ListenEnabled
bool IPv6ListenEnabled( void ) const
Prüfen Sie, ob WeaveMessageLayer so konfiguriert ist, dass eingehende Kommunikation über IPv4 überwacht wird.
Init
WEAVE_ERROR Init( InitContext *context )
Initialisieren Sie das Weave Message-Ebenenobjekt.
Details | |||||||||
---|---|---|---|---|---|---|---|---|---|
Parameter |
|
||||||||
Rückgabewerte |
|
IsBoundToLocalIPv4Address
bool IsBoundToLocalIPv4Address( void ) const
Prüfen Sie, ob WeaveMessageLayer an eine lokale IPv4-Adresse gebunden ist.
IsBoundToLocalIPv6Address
bool IsBoundToLocalIPv6Address( void ) const
Prüfen Sie, ob WeaveMessageLayer an eine lokale IPv6-Adresse gebunden ist.
IsMessageLayerActive
bool IsMessageLayerActive( void )
NewConnection
WeaveConnection * NewConnection( void )
Erstellen Sie ein neues WeaveConnection-Objekt aus einem Pool.
Details | |
---|---|
Rückgabe |
Einen Zeiger auf das neu erstellte WeaveConnection-Objekt, falls erfolgreich, andernfalls NULL.
|
NewConnectionTunnel
WeaveConnectionTunnel * NewConnectionTunnel( void )
Erstellen Sie ein neues WeaveConnectionTunnel-Objekt aus einem Pool.
Details | |
---|---|
Rückgabe |
Einen Zeiger auf das neu erstellte Objekt WeaveConnectionTunnel, falls erfolgreich, andernfalls NULL.
|
ReEncodeMessage
WEAVE_ERROR ReEncodeMessage( PacketBuffer *buf )
RefreshEndpoints
WEAVE_ERROR RefreshEndpoints( void )
Aktualisieren Sie die InetLayer-Endpunkte basierend auf dem aktuellen Status der Netzwerkschnittstellen des Systems.
Details | |||||
---|---|---|---|---|---|
Rückgabewerte |
|
ResendMessage
WEAVE_ERROR ResendMessage( WeaveMessageInfo *msgInfo, PacketBuffer *msgBuf )
Eine codierte Weave-Nachricht über den zugrunde liegenden Inetlayer-UDP-Endpunkt noch einmal senden.
Details | |||||
---|---|---|---|---|---|
Parameter |
|
||||
Rückgabewerte |
|
ResendMessage
WEAVE_ERROR ResendMessage( const IPAddress & destAddr, WeaveMessageInfo *msgInfo, PacketBuffer *msgBuf )
Eine codierte Weave-Nachricht über den zugrunde liegenden Inetlayer-UDP-Endpunkt noch einmal senden.
Details | |||||||
---|---|---|---|---|---|---|---|
Parameter |
|
||||||
Rückgabewerte |
|
ResendMessage
WEAVE_ERROR ResendMessage( const IPAddress & destAddr, uint16_t destPort, WeaveMessageInfo *msgInfo, PacketBuffer *msgBuf )
Eine codierte Weave-Nachricht über den zugrunde liegenden Inetlayer-UDP-Endpunkt noch einmal senden.
Details | |||||||||
---|---|---|---|---|---|---|---|---|---|
Parameter |
|
||||||||
Rückgabewerte |
|
ResendMessage
WEAVE_ERROR ResendMessage( const IPAddress & destAddr, uint16_t destPort, InterfaceId interfaceId, WeaveMessageInfo *msgInfo, PacketBuffer *msgBuf )
Eine codierte Weave-Nachricht über den zugrunde liegenden Inetlayer-UDP-Endpunkt noch einmal senden.
Hinweis:Wenn die Zieladresse nicht angegeben wurde, versuchen Sie, sie anhand der Knotenkennung im Nachrichtenheader zu ermitteln. Schlägt fehl, wenn dies nicht möglich ist. – Wenn die Zieladresse eine Strukturadresse für die lokale Struktur ist und der Aufrufer die ID des Zielknotens nicht angegeben hat, extrahieren Sie sie aus der Zieladresse.
Details | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Parameter |
|
||||||||||
Rückgabewerte |
|
SendMessage
WEAVE_ERROR SendMessage( WeaveMessageInfo *msgInfo, PacketBuffer *msgBuf )
Senden Sie nach der Codierung eine Weave-Nachricht über den zugrunde liegenden Inetlayer-UDP-Endpunkt.
Details | |||||
---|---|---|---|---|---|
Parameter |
|
||||
Rückgabewerte |
|
SendMessage
WEAVE_ERROR SendMessage( const IPAddress & destAddr, WeaveMessageInfo *msgInfo, PacketBuffer *msgBuf )
Senden Sie nach der Codierung eine Weave-Nachricht über den zugrunde liegenden Inetlayer-UDP-Endpunkt.
Hinweis:Der verwendete Zielport ist WEAVE_PORT. - Wenn die Zieladresse nicht angegeben wurde, versuchen Sie, sie anhand der Knoten-ID im Nachrichten-Header zu ermitteln. Schlägt fehl, wenn dies nicht möglich ist.
– Wenn die Zieladresse eine Strukturadresse für die lokale Struktur ist und der Aufrufer die ID des Zielknotens nicht angegeben hat, extrahieren Sie sie aus der Zieladresse.
Details | |||||||
---|---|---|---|---|---|---|---|
Parameter |
|
||||||
Rückgabewerte |
|
SendMessage
WEAVE_ERROR SendMessage( const IPAddress & destAddr, uint16_t destPort, InterfaceId sendIntfId, WeaveMessageInfo *msgInfo, PacketBuffer *msgBuf )
Senden Sie nach der Codierung eine Weave-Nachricht über den zugrunde liegenden Inetlayer-UDP-Endpunkt.
Hinweis:Wenn die Zieladresse nicht angegeben wurde, versuchen Sie, sie anhand der Knotenkennung im Nachrichtenheader zu ermitteln. Schlägt fehl, wenn dies nicht möglich ist. – Wenn die Zieladresse eine Strukturadresse für die lokale Struktur ist und der Aufrufer die ID des Zielknotens nicht angegeben hat, extrahieren Sie sie aus der Zieladresse.
Details | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Parameter |
|
||||||||||
Rückgabewerte |
|
SendUDPTunneledMessage
WEAVE_ERROR SendUDPTunneledMessage( const IPAddress & destAddr, WeaveMessageInfo *msgInfo, PacketBuffer *msgBuf )
Funktion zum Senden eines Tunnelpakets über einen lokalen UDP-Tunnel.
Eine getunnelte IPv6-Datennachricht über UDP senden.
Details | |||||||
---|---|---|---|---|---|---|---|
Parameter |
|
||||||
Rückgabewerte |
|
SetSignalMessageLayerActivityChanged
void SetSignalMessageLayerActivityChanged( MessageLayerActivityChangeHandlerFunct messageLayerActivityChangeHandler )
Legen Sie einen Anwendungs-Handler fest, der jedes Mal aufgerufen wird, wenn sich die Aktivität der Nachrichtenebene ändert.
Insbesondere wird der Antrag jedes Mal benachrichtigt, wenn
- die Anzahl der geöffneten Auktionsplattformen ändert.
- Die Anzahl der Anfragen zur Synchronisierung ausstehender Nachrichten ändert sich von null auf mindestens eins und wieder zurück auf null. Der Handler dient als allgemeines Signal, das angibt, ob laufende Weave-Unterhaltungen oder ausstehende Antworten vorhanden sind. Der Handler muss festgelegt werden, nachdem WeaveMessageLayer initialisiert wurde. Durch Herunterfahren von WeaveMessageLayer wird der aktuelle Handler gelöscht.
Details | |||
---|---|---|---|
Parameter |
|
||
Rückgabewerte |
|
SetTCPListenEnabled
void SetTCPListenEnabled( bool val )
Aktivieren oder deaktivieren Sie das Warten auf eingehende TCP-Verbindungen in WeaveMessageLayer.
HINWEIS: RefreshEndpoints()
muss aufgerufen werden, nachdem der TCP-Überwachungsstatus geändert wurde.
SetUDPListenEnabled
void SetUDPListenEnabled( bool val )
Aktivieren oder deaktivieren Sie das Warten auf eingehende UDP-Nachrichten in WeaveMessageLayer.
HINWEIS: RefreshEndpoints()
muss aufgerufen werden, nachdem der UDP-Überwachungsstatus geändert wurde.
SetUnsecuredConnectionListener
WEAVE_ERROR SetUnsecuredConnectionListener( ConnectionReceiveFunct newOnUnsecuredConnectionReceived, CallbackRemovedFunct newOnUnsecuredConnectionCallbacksRemoved, bool force, void *listenerState )
Herunterfahren
WEAVE_ERROR Shutdown( void )
Fahren Sie WeaveMessageLayer herunter.
Schließen Sie alle geöffneten Endpunkte der Inet-Ebene und setzen Sie alle Callbacks, Member-Variablen und Objekte auf höheren Ebenen zurück. Ein Aufruf von Shutdown() beendet das WeaveMessageLayer-Objekt.
TCPListenEnabled
bool TCPListenEnabled( void ) const
Prüfen Sie, ob WeaveMessageLayer so konfiguriert ist, dass eingehende TCP-Verbindungen überwacht werden.
UDPListenEnabled
bool UDPListenEnabled( void ) const
Prüfen Sie, ob WeaveMessageLayer so konfiguriert ist, dass eingehende UDP-Nachrichten abgehört werden.
UnsecuredListenEnabled
bool UnsecuredListenEnabled( void ) const
Aktivieren oder deaktivieren Sie das Initiieren von Weave-UDP-Austauschen über einen sitzungsspezifischen UDP-Quellport.
HINWEIS: RefreshEndpoints()
muss aufgerufen werden, nachdem der sitzungsspezifische Portstatus geändert wurde. Prüfen Sie, ob die ungesicherte Wiedergabe aktiviert ist.
WeaveMessageLayer
WeaveMessageLayer( void )
Der Weave Message-Ebenenkonstruktor.
Öffentliche statische Funktionen
GetMaxWeavePayloadSize
uint32_t GetMaxWeavePayloadSize( const PacketBuffer *msgBuf, bool isUDP, uint32_t udpMTU )
Ruft die maximale Weave-Nutzlastgröße für eine Nachrichtenkonfiguration und den bereitgestellten PacketBuffer ab.
Die maximale zurückgegebene Nutzlastgröße überschreitet nicht den verfügbaren Speicherplatz für eine Nutzlast im bereitgestellten PacketBuffer.
Wenn die Nachricht UDP ist, führt die zurückgegebene maximale Nutzlastgröße nicht zu einer Weave-Nachricht, die nicht die angegebene UDP-MTU überläuft.
Schließlich führt die zurückgegebene maximale Nutzlastgröße nicht zu einer Weave-Nachricht, die die maximale Weave-Nachrichtengröße überläuft.
Details | |||||||
---|---|---|---|---|---|---|---|
Parameter |
|
||||||
Rückgabe |
die maximale Weave-Nutzlastgröße.
|
GetPeerDescription
void GetPeerDescription( char *buf, size_t bufSize, uint64_t nodeId, const IPAddress *addr, uint16_t port, InterfaceId interfaceId, const WeaveConnection *con )
Erstellt einen String, der einen Peer-Knoten und die zugehörigen Adress-/Verbindungsinformationen beschreibt.
Der generierte String hat das folgende Format:
([ ]: % , con )
Details | |||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Parameter |
|
GetPeerDescription
void GetPeerDescription( char *buf, size_t bufSize, const WeaveMessageInfo *msgInfo )
Erstellt einen String, der einen Peer-Knoten anhand der Informationen zu einer vom Peer empfangenen Nachricht beschreibt.
Details | |||||||
---|---|---|---|---|---|---|---|
Parameter |
|