Mit Sammlungen den Überblick behalten Sie können Inhalte basierend auf Ihren Einstellungen speichern und kategorisieren.

nl::Weave::Profile::NetworkProvisioning::NetworkInfo

#include <src/lib/profiles/network-provisioning/NetworkInfo.h>

Eine Dienstprogrammklasse zum Serialisieren und Entfernen der Nutzlasten, die über das NetworkProvisioning-Profil kommuniziert werden: Sie enthält Informationen, die zur Erkennung und Konfiguration von Netzwerken gehören.

Zusammenfassung

Die Klasse nutzt die Zwischenspeicherung von Informationen zur Netzwerkbereitstellung (zwischen der endgültigen Speicherung der Informationen und der Netzwerknutzlast) und verwendet die dynamische Arbeitsspeicherverwaltung, um das resultierende Objekt flexibel bereitzustellen. Daher ist diese Klasse für die am stärksten eingeschränkten Umgebungen nicht geeignet, kann aber auf größeren Systemen verwendet werden.

Konstruktoren und Zerstörer

NetworkInfo()
~NetworkInfo()

Öffentliche Typen

@210 enum
@211 enum

Öffentliche Attribute

Hidden
bool
Gibt an, ob das Netzwerk verborgen ist.
NetworkId
int64_t
Die Netzwerk-ID, die dem Gerät vom Gerät zugewiesen wurde – -1, wenn nicht angegeben.
NetworkType
Der Typ des Netzwerks.
ThreadChannel
uint8_t
Der aktuelle Kanal, auf dem das Thread-Netzwerk läuft (derzeit [11..26]), oder kThreadChannel_Notspecified.
ThreadExtendedPANId
uint8_t *
Die erweiterte PAN-ID für den Thread.
ThreadNetworkKey
uint8_t *
Der Thread-Master-Netzwerkschlüssel oder NULL , wenn nicht angegeben.
ThreadNetworkName
char *
Der Name des Thread-Netzwerks oder NULL, wenn nicht angegeben.
ThreadPANId
uint32_t
Die 16-Bit-Thread-PAN oder kThreadPANId_Notspecified.
ThreadPSKc
uint8_t *
Vorinstallierter Threadschlüssel für Provision, oder NULL, wenn nicht angegeben.
WiFiKey
uint8_t *
Der WLAN-Schlüssel oder NULL, wenn nicht angegeben.
WiFiKeyLen
uint32_t
Die Länge des WLAN-Schlüssels in Byte.
WiFiMode
Der Betriebsmodus des WLAN.
WiFiRole
Die Rolle, die das Gerät im WLAN spielt.
WiFiSSID
char *
Die WLAN-SSID oder NULL, wenn nicht angegeben.
WiFiSecurityType
Der WLAN-Sicherheitstyp.
WirelessSignalStrength
int16_t
Die Signalstärke des Netzwerks oder INT16_MIN, wenn nicht verfügbar oder anwendbar.

Öffentliche Funktionen

Clear(void)
void
Auf Standard zurücksetzen und alle Werte innerhalb dieses NetworkInfo-Objekts freigeben.
CopyTo(NetworkInfo & dest)
Ersetzen Sie den Inhalt dieses NetworkInfo-Objekts durch den tiefgreifenden Text des Arguments.
Decode(nl::Weave::TLV::TLVReader & reader)
DeInhalte des Objekts NetworkInfo aus seiner TLV-Darstellung deserialisieren
Encode(nl::Weave::TLV::TLVWriter & writer, uint8_t encodeFlags) const
Serialisieren Sie den Inhalt dieses NetworkInfo-Objekts in seiner TLV-Darstellung.
MergeTo(NetworkInfo & dest)
Führen Sie den Inhalt dieses NetworkInfo-Objekts mit dem detaillierten Text des Arguments zusammen.

Öffentliche statische Funktionen

DecodeList(nl::Weave::TLV::TLVReader & reader, uint16_t & elemCount, NetworkInfo *& elemArray)
Liste aus NetworkInfo-Elementen aus ihrer TLV-Darstellung deserialisieren
EncodeList(nl::Weave::TLV::TLVWriter & writer, uint16_t elemCount, const NetworkInfo *elemArray, uint8_t encodeFlags)
Ein Array mit NetworkInfo-Objekten wird in die TLV-Darstellung serialisiert.
EncodeList(nl::Weave::TLV::TLVWriter & writer, uint16_t arrayLen, const NetworkInfo *elemArray, ::nl::Weave::Profiles::NetworkProvisioning::NetworkType networkType, uint8_t encodeFlags, uint16_t & encodedElemCount)
Ein Array mit NetworkInfo-Objekten wird in die TLV-Darstellung serialisiert, wobei nur Netzwerke eines bestimmten Typs ausgewählt werden.

Öffentliche Typen

@210

 @210

@211

 @211

Öffentliche Attribute

Ausgeblendet

bool Hidden

Gibt an, ob das Netzwerk verborgen ist.

Netzwerk-ID

int64_t NetworkId

Die Netzwerk-ID, die dem Gerät vom Gerät zugewiesen wurde – -1, wenn nicht angegeben.

NetworkType

::nl::Weave::Profiles::NetworkProvisioning::NetworkType NetworkType

Der Typ des Netzwerks.

Thread-Kanal

uint8_t ThreadChannel

Der aktuelle Kanal, auf dem das Thread-Netzwerk läuft (derzeit [11..26]), oder kThreadChannel_Notspecified.

UnterhaltungserweitertePAN-ID

uint8_t * ThreadExtendedPANId

Die erweiterte PAN-ID für den Thread.

Es ist ein dynamisch zugewiesenes Array mit 8 Oktekten, das der Klasse der Klasse gehört. Zerstört durch eine Bedingung, die Clear() für das Objekt aufruft.

ThreadNetzwerkschlüssel

uint8_t * ThreadNetworkKey

Der Thread-Master-Netzwerkschlüssel oder NULL , wenn nicht angegeben.

Es handelt sich um ein dynamisch zugeordnetes Array willkürlicher Oktetten, die der Klasse"Destryed"unter jeder Bedingung zugeordnet sind, mit der für das Objekt Clear() aufgerufen wird.

Unterhaltungsnetzwerkname

char * ThreadNetworkName

Der Name des Thread-Netzwerks oder NULL, wenn nicht angegeben.

Es handelt sich um einen NUL-terminierten, dynamisch zugewiesenen C-String, der der Klasse gehört. Zerstört durch eine Bedingung, die Clear() für das Objekt aufruft.

ThreadPAN-ID

uint32_t ThreadPANId

Die 16-Bit-Thread-PAN oder kThreadPANId_Notspecified.

ThreadPSKC (auf Englisch)

uint8_t * ThreadPSKc

Vorinstallierter Threadschlüssel für Provision, oder NULL, wenn nicht angegeben.

Es handelt sich um ein dynamisch zugeordnetes Array willkürlicher Oktetten, die der Klasse"Destryed"unter jeder Bedingung zugeordnet sind, mit der für das Objekt Clear() aufgerufen wird.

WLAN-Schlüssel

uint8_t * WiFiKey

Der WLAN-Schlüssel oder NULL, wenn nicht angegeben.

Es handelt sich um ein dynamisch zugewiesenes Array mit willkürlichen Oktetten, die der Klasse gehören und deren Länge durch WiFiKeyLen angegeben wird. Zerstört durch eine Bedingung, die Clear() für das Objekt aufruft.

WLAN-Schlüssel-Len

uint32_t WiFiKeyLen

Die Länge des WLAN-Schlüssels in Byte.

WLAN-Modus

::nl::Weave::Profiles::NetworkProvisioning::WiFiMode WiFiMode

Der Betriebsmodus des WLAN.

WLAN-Rolle

::nl::Weave::Profiles::NetworkProvisioning::WiFiRole WiFiRole

Die Rolle, die das Gerät im WLAN spielt.

WLAN-SSID

char * WiFiSSID

Die WLAN-SSID oder NULL, wenn nicht angegeben.

Es handelt sich um einen NUL-terminierten, dynamisch zugewiesenen C-String, der der Klasse gehört. Zerstört durch eine Bedingung, die Clear() für das Objekt aufruft.

Sicherheitstyp WLAN

::nl::Weave::Profiles::NetworkProvisioning::WiFiSecurityType WiFiSecurityType

Der WLAN-Sicherheitstyp.

WLAN-Signalstärke

int16_t WirelessSignalStrength

Die Signalstärke des Netzwerks oder INT16_MIN, wenn nicht verfügbar oder anwendbar.

Öffentliche Funktionen

Löschen

void Clear(
  void
)

Auf Standard zurücksetzen und alle Werte innerhalb dieses NetworkInfo-Objekts freigeben.

Kopieren in

WEAVE_ERROR CopyTo(
  NetworkInfo & dest
)

Ersetzen Sie den Inhalt dieses NetworkInfo-Objekts durch den tiefgreifenden Text des Arguments.

Details
Parameter
[in] dest
NetworkInfo-Objekt mit Informationen, die in dieses Objekt kopiert werden sollen.
Rückgabewerte
WEAVE_NO_ERROR
Bei Erfolg.
WEAVE_ERROR_NOT_IMPLEMENTED
Die Plattform unterstützt weder Malloc noch kostenlos.
WEAVE_ERROR_NO_MEMORY
Bei Fehlern bei der Arbeitsspeicherzuweisung.

Decodieren

WEAVE_ERROR Decode(
  nl::Weave::TLV::TLVReader & reader
)

DeInhalte des Objekts NetworkInfo aus seiner TLV-Darstellung deserialisieren

Details
Parameter
[in] reader
TLVReader wurde im Strukturelement mit den Netzwerkinformationen positioniert.
Rückgabe
WEAVE_NO_ERROR Bei Erfolg weist WEAVE_ERROR_INVALID_TLV_ELEMENT auf einem Element, das nicht dem Profil für die Netzwerkbereitstellung entspricht, einer der TLV-Lesefehler auf, wenn Elemente falsch decodiert werden.

Codieren

WEAVE_ERROR Encode(
  nl::Weave::TLV::TLVWriter & writer,
  uint8_t encodeFlags
) const 

Serialisieren Sie den Inhalt dieses NetworkInfo-Objekts in seiner TLV-Darstellung.

Details
Parameter
[in] writer
TLVWriter, positioniert an der Stelle, an der das Objekt serialisiert wird. Die Funktion gibt ein anonymes Tag für dieses Objekt aus, wenn dieses Objekt Teil eines Arrays von Elementen oder ein Profil-Tag für kTag_NetworkInformation ist, wenn es als eigenständiges Element ausgegeben wird.
[in] encodeFlags
Flags, mit denen gesteuert wird, ob die Anmeldedaten von NetworkInfo serialisiert werden sollen.
Rückgabe
WEAVE_NO_ERROR Bei Erfolg weist WEAVE_ERROR_INVALID_TLV_ELEMENT auf einem Element, das nicht dem Profil für die Netzwerkbereitstellung entspricht, einer der TLV-Lesefehler auf, wenn Elemente falsch decodiert werden.

Zusammenführung auf

WEAVE_ERROR MergeTo(
  NetworkInfo & dest
)

Führen Sie den Inhalt dieses NetworkInfo-Objekts mit dem detaillierten Text des Arguments zusammen.

Alle nicht standardmäßigen Werte des Argumentobjekts ersetzen die Werte in diesem Objekt.

Details
Parameter
[in] dest
NetworkInfo-Objekt mit Informationen, die in dieses Objekt kopiert werden sollen.
Rückgabewerte
WEAVE_NO_ERROR
Bei Erfolg.
WEAVE_ERROR_NOT_IMPLEMENTED
Die Plattform unterstützt weder Malloc noch kostenlos.
WEAVE_ERROR_NO_MEMORY
Bei Fehlern bei der Arbeitsspeicherzuweisung.

NetworkInfo

 NetworkInfo()

~Netzwerkinfo

 ~NetworkInfo()

Öffentliche statische Funktionen

Decodierungsliste

WEAVE_ERROR DecodeList(
  nl::Weave::TLV::TLVReader & reader,
  uint16_t & elemCount,
  NetworkInfo *& elemArray
)

Liste aus NetworkInfo-Elementen aus ihrer TLV-Darstellung deserialisieren

Details
Parameter
[in] reader
TLVReader auf Positionierung des Arrays. Bei erfolgreicher Rückgabe wird der Autor nach dem Ende des Arrays positioniert.
[in,out] elemCount
Bei Eingabe die maximale Anzahl der Elemente, die aus dem TLVReader de serialisiert werden sollen. Bei der Ausgabe wird die Anzahl der Elemente aus dem Stream de serialisiert.
[in,out] elemArray
Ein Verweis auf das Array der NetworkInfo-Elemente, das die de serialisierten NetworkInfo-Objekte enthält. Wenn das Array NULL ist, wird es von der folgenden Funktion intern zugewiesen. Andernfalls wird davon ausgegangen, dass das extern zugeordnete Array mindestens elemCount-Objekte enthält.
Rückgabewerte
WEAVE_NO_ERROR
Bei Erfolg.
WEAVE_ERROR_NOT_IMPLEMENTED
auf Plattformen, die die dynamische Arbeitsspeicherverwaltung nicht unterstützen.
other
Von der Funktion Decode() zurückgegebene Fehler.

Encoderliste

WEAVE_ERROR EncodeList(
  nl::Weave::TLV::TLVWriter & writer,
  uint16_t elemCount,
  const NetworkInfo *elemArray,
  uint8_t encodeFlags
)

Ein Array mit NetworkInfo-Objekten wird in die TLV-Darstellung serialisiert.

Das Array ist in der TLV-Darstellung ein anonymes Element.

Details
Parameter
[in] writer
Geeignete Position für TLVWriter
[in] elemCount
Anzahl der Elemente in elemArray.
[in] elemArray
Das Array der NetworkInfo-Objekte, die serialisiert werden sollen.
[in] encodeFlags
Flags, mit denen gesteuert wird, ob die Anmeldedaten von NetworkInfo serialisiert werden sollen.
Rückgabewerte
WEAVE_NO_ERROR
Bei Erfolg.
Other
Von der Funktion Encode() zurückgegebene Fehler.

Encoderliste

WEAVE_ERROR EncodeList(
  nl::Weave::TLV::TLVWriter & writer,
  uint16_t arrayLen,
  const NetworkInfo *elemArray,
  ::nl::Weave::Profiles::NetworkProvisioning::NetworkType networkType,
  uint8_t encodeFlags,
  uint16_t & encodedElemCount
)

Ein Array mit NetworkInfo-Objekten wird in die TLV-Darstellung serialisiert, wobei nur Netzwerke eines bestimmten Typs ausgewählt werden.

Details
Parameter
[in] writer
Geeignete Position für TLVWriter
[in] arrayLen
Anzahl der Elemente in elemArray.
[in] elemArray
Das Array der NetworkInfo-Objekte, die serialisiert werden sollen.
[in] networkType
Der Typ der NetworkInfo-Objekte, die serialisiert werden sollen
[in] encodeFlags
Flags, mit denen gesteuert wird, ob die Anmeldedaten von NetworkInfo serialisiert werden sollen.
[out] encodedElemCount
Die Anzahl der Elemente, die tatsächlich serialisiert sind.
Rückgabewerte
WEAVE_NO_ERROR
Bei Erfolg.
Other
Von der Funktion Encode() zurückgegebene Fehler.