nl::Weave::System

Zusammenfassung

Aufzählungen

@18{
  kTimerFactor_micro_per_milli = 1000,
  kTimerFactor_milli_per_unit = 1000,
  kTimerFactor_nano_per_milli = 1000000,
  kTimerFactor_micro_per_unit = 1000000
}
enum
@19{
  kEvent_ReleaseObj = _WEAVE_SYSTEM_CONFIG_LWIP_EVENT(0),
  kEvent_ScheduleWork = _WEAVE_SYSTEM_CONFIG_LWIP_EVENT(1)
}
enum
Die Ereignistypdefinitionen der Inet-Ebene.
LayerState{
  kLayerState_NotInitialized = 0,
  kLayerState_Initialized = 1
}
enum
Der Status eines Layer-Objekts.

Typedefs

Event nl::Weave::System::Event
Das Basisobjekt für alle InetLayer-Ereignisse.
EventType nl::Weave::System::EventType
Der Basistyp für alle InetLayer-Ereignisse.
LwIPEventHandlerFunction)(Object &aTarget, EventType aEventType, uintptr_t aArgument) typedef.
Error(*

Funktionen

DescribeErrorLwIP(Error aError)
NL_DLL_EXPORT const char *
Hiermit wird eine Funktion implementiert, die einen NULL-terminierten LwIP-spezifischen, beschreibenden C-String zurückgibt, der dem angegebenen, zugeordneten LwIP-Fehler zugeordnet ist.
DescribeErrorPOSIX(Error aError)
NL_DLL_EXPORT const char *
Hiermit wird eine Funktion implementiert, die einen NULL-terminierten betriebssystemspezifischen beschreibenden C-String zurückgibt, der dem angegebenen zugeordneten Betriebssystemfehler zugeordnet ist.
FormatLwIPError(char *buf, uint16_t bufSize, int32_t err)
bool
Bei einem LwIP-Fehler wird ein für Menschen lesbarer NULL-terminierter C-String zurückgegeben, der den Fehler beschreibt.
FormatPOSIXError(char *buf, uint16_t bufSize, int32_t err)
bool
Bei einem POSIX-Fehler wird ein für Menschen lesbarer NULL-terminierter C-String zurückgegeben, der den Fehler beschreibt.
FormatSystemLayerError(char *buf, uint16_t bufSize, int32_t err)
bool
Bei einem System Layer-Fehler wird ein menschenlesbarer NULL-terminierter C-String zurückgegeben, der den Fehler beschreibt.
IsErrorLwIP(Error aError)
NL_DLL_EXPORT bool
Hiermit wird eine Selbstprüfungsfunktion für Weave-System-Layer-Fehler implementiert, mit der der Aufrufer feststellen kann, ob der angegebene Fehler ein interner, zugrunde liegender LwIP-Fehler ist.
IsErrorPOSIX(Error aError)
NL_DLL_EXPORT bool
Hiermit wird eine Selbstprüfungsfunktion für Weave-System-Layer-Fehler implementiert, mit der der Aufrufer feststellen kann, ob der angegebene Fehler ein interner, zugrunde liegender Betriebssystemfehler ist.
IsEventOfType(EventType aType)
bool
Prüfen Sie, ob ein EventType gültig ist.
MapErrorLwIP(err_t aError)
NL_DLL_EXPORT Error
Hiermit wird eine Zuordnungsfunktion für Layer-Fehler von Weave System implementiert, mit denen zugrunde liegende LwIP-Netzwerkstack-Fehler einem plattform- oder systemspezifischen Bereich zugeordnet werden.
MapErrorPOSIX(int aError)
NL_DLL_EXPORT Error
Hiermit wird eine Zuordnungsfunktion für Weave-System-Layer-Fehler implementiert, mit der Ganzzahlen im Nummernbereich des zugrunde liegenden POSIX-Netzwerks und Betriebssystem-Stack-Fehler einem plattform- oder systemspezifischen Bereich zugeordnet werden.
RegisterLwIPErrorFormatter(void)
void
Registrieren Sie einen Textfehlerformatierer für LwIP-Fehler.
RegisterPOSIXErrorFormatter(void)
void
Registrieren Sie einen Textfehlerformatierer für POSIX-Fehler.
RegisterSystemLayerErrorFormatter(void)
void
Registriert einen Textfehlerformatierer für System-Layer-Fehler.

Klassen

nl::Weave::System::Layer

This provides access to timers according to the configured event handling model.

nl::Weave::System::LwIPEventHandlerDelegate
nl::Weave::System::Mutex

This class represents a simple mutual exclusion lock used on platforms with preemptively scheduled multi-threaded
programming environments, for example, POSIX threads and FreeRTOS.

nl::Weave::System::Object

Dies stellt ein Objekt mit gezählter Referenz dar, das aus dem Bereich zugewiesen ist, der in einem ObjectPool enthalten ist<t, n=""> -Objekt enthält. &lt;/t,&gt;

nl::Weave::System::PacketBuffer

Die Paketpufferklasse ist die Kernstruktur, die zur Manipulation von Paketen mit Oktett-serialisierten Daten verwendet wird, normalerweise im Zusammenhang mit einem Datenkommunikationsnetzwerk wie Bluetooth oder dem Internetprotokoll.

nl::Weave::System::Timer

Das ist eine interne Klasse der Weave-System-Layer, die einen laufenden One-Shot-Timer darstellt.

Strukturen

nl::Weave::System::LwIPEvent

Gewerkschaften

nl::Weave::System::ObjectArena

A union template used for representing a well-aligned block of memory.

Namespaces

nl::Weave::System::Platform
nl::Weave::System::Stats

Aufzählungen

@18

 @18
Attribute
kTimerFactor_micro_per_milli

Anzahl der Nanosekunden in einer Mikrosekunde.

kTimerFactor_micro_per_unit

Anzahl der Nanosekunden in einer Millisekunde.

kTimerFactor_milli_per_unit

Anzahl der Mikrosekunden in einer Millisekunde.

kTimerFactor_nano_per_milli

Anzahl der Millisekunden in einer Sekunde.

@19

 @19

Die Ereignistypdefinitionen der Inet-Ebene.

Attribute
kEvent_ReleaseObj

Das Ereignis für das Löschen eines SystemLayer-Objekts.

kEvent_ScheduleWork

Das Ereignis für die Planung funktioniert im System-Layer-Thread.

LayerState

 LayerState

Der Status eines Layer-Objekts.

Attribute
kLayerState_Initialized

Status „Initialisiert“.

kLayerState_NotInitialized

Nicht initialisierter Status.

Typedefs

Ereignis

WEAVE_SYSTEM_CONFIG_LWIP_EVENT_OBJECT_TYPE Event

Das Basisobjekt für alle InetLayer-Ereignisse.

Dies ist für einen plattform- oder systemspezifischen Typ definiert.

EventType

WEAVE_SYSTEM_CONFIG_LWIP_EVENT_TYPE EventType

Der Basistyp für alle InetLayer-Ereignisse.

Dies ist für einen plattform- oder systemspezifischen Typ definiert.

LwIPEventHandlerFunction

Error(* LwIPEventHandlerFunction)(Object &aTarget, EventType aEventType, uintptr_t aArgument)

Funktionen

DescribeErrorLwIP

NL_DLL_EXPORT const char * DescribeErrorLwIP(
  Error aError
)

Hiermit wird eine Funktion implementiert, die einen NULL-terminierten LwIP-spezifischen, beschreibenden C-String zurückgibt, der dem angegebenen, zugeordneten LwIP-Fehler zugeordnet ist.

Details
Parameter
[in] err
Der zugeordnete LwIP-spezifische Fehler, der beschrieben werden soll.
Rückgabe
Ein NULL-terminierter, LwIP-spezifischer, beschreibender C-String, der den Fehler beschreibt.

DescribeErrorPOSIX

NL_DLL_EXPORT const char * DescribeErrorPOSIX(
  Error aError
)

Hiermit wird eine Funktion implementiert, die einen NULL-terminierten betriebssystemspezifischen beschreibenden C-String zurückgibt, der dem angegebenen zugeordneten Betriebssystemfehler zugeordnet ist.

Details
Parameter
[in] err
Der zugeordnete betriebssystemspezifische Fehler, der beschrieben werden soll.
Rückgabe
Ein mit NULL beendeter, betriebssystemspezifischer beschreibender C-String, der den Fehler beschreibt.

FormatLwIPError

bool FormatLwIPError(
  char *buf,
  uint16_t bufSize,
  int32_t err
)

Bei einem LwIP-Fehler wird ein für Menschen lesbarer NULL-terminierter C-String zurückgegeben, der den Fehler beschreibt.

Details
Parameter
[in] buf
Puffer, in den die Fehlerzeichenfolge eingefügt wird.
[in] bufSize
Größe des bereitgestellten Zwischenspeichers in Byte.
[in] err
Der zu beschreibende Fehler.
Rückgabe
"true", wenn eine Zeichenfolge für die Beschreibung in den bereitgestellten Puffer geschrieben wurde.
Rückgabe
false, wenn der angegebene Fehler kein LwIP-Fehler war.

FormatPOSIXError

bool FormatPOSIXError(
  char *buf,
  uint16_t bufSize,
  int32_t err
)

Bei einem POSIX-Fehler wird ein für Menschen lesbarer NULL-terminierter C-String zurückgegeben, der den Fehler beschreibt.

Details
Parameter
[in] buf
Puffer, in den die Fehlerzeichenfolge eingefügt wird.
[in] bufSize
Größe des bereitgestellten Zwischenspeichers in Byte.
[in] err
Der zu beschreibende Fehler.
Rückgabe
"true", wenn eine Zeichenfolge für die Beschreibung in den bereitgestellten Puffer geschrieben wurde.
Rückgabe
false, wenn der angegebene Fehler kein POSIX-Fehler ist.

FormatSystemLayerError

bool FormatSystemLayerError(
  char *buf,
  uint16_t bufSize,
  int32_t err
)

Bei einem System Layer-Fehler wird ein menschenlesbarer NULL-terminierter C-String zurückgegeben, der den Fehler beschreibt.

Details
Parameter
[in] buf
Puffer, in den die Fehlerzeichenfolge eingefügt wird.
[in] bufSize
Größe des bereitgestellten Zwischenspeichers in Byte.
[in] err
Der zu beschreibende Fehler.
Rückgabe
"true", wenn eine Zeichenfolge für die Beschreibung in den bereitgestellten Puffer geschrieben wurde.
Rückgabe
false, wenn der angegebene Fehler kein SystemLayer-Fehler ist.

IsErrorLwIP

NL_DLL_EXPORT bool IsErrorLwIP(
  Error aError
)

Hiermit wird eine Selbstprüfungsfunktion für Weave-System-Layer-Fehler implementiert, mit der der Aufrufer feststellen kann, ob der angegebene Fehler ein interner, zugrunde liegender LwIP-Fehler ist.

Details
Parameter
[in] err
Der zugeordnete Fehler, um festzustellen, ob es sich um einen LwIP-Fehler handelt.
Rückgabe
"True", wenn der angegebene Fehler ein LwIP-Fehler ist; Andernfalls „false“.

IsErrorPOSIX

NL_DLL_EXPORT bool IsErrorPOSIX(
  Error aError
)

Hiermit wird eine Selbstprüfungsfunktion für Weave-System-Layer-Fehler implementiert, mit der der Aufrufer feststellen kann, ob der angegebene Fehler ein interner, zugrunde liegender Betriebssystemfehler ist.

Details
Parameter
[in] err
Der zugeordnete Fehler, um festzustellen, ob es sich um einen Betriebssystemfehler handelt.
Rückgabe
„True“, wenn der angegebene Fehler ein Betriebssystemfehler ist Andernfalls „false“.

IsEventOfType

bool IsEventOfType(
  EventType aType
)

Prüfen Sie, ob ein EventType gültig ist.

Details
Parameter
[in] aEventType
Weave System-Ereignistyp Layer.
Rückgabe
"true", wenn er im Aufzählungsbereich liegt; Andernfalls „false“.

MapErrorLwIP

NL_DLL_EXPORT Error MapErrorLwIP(
  err_t aError
)

Hiermit wird eine Zuordnungsfunktion für Layer-Fehler von Weave System implementiert, mit denen zugrunde liegende LwIP-Netzwerkstack-Fehler einem plattform- oder systemspezifischen Bereich zugeordnet werden.

Details
Parameter
[in] e
Der zu zuordnende LwIP-Fehler.
Rückgabe
Fehler im zugeordneten LwIP-Netzwerk oder Betriebssystem.

MapErrorPOSIX

NL_DLL_EXPORT Error MapErrorPOSIX(
  int aError
)

Hiermit wird eine Zuordnungsfunktion für Weave-System-Layer-Fehler implementiert, mit der Ganzzahlen im Nummernbereich des zugrunde liegenden POSIX-Netzwerks und Betriebssystem-Stack-Fehler einem plattform- oder systemspezifischen Bereich zugeordnet werden.

Neben den derzeit von POSIX oder den ISO C/C++-Standards definierten Fehlercodes werden ähnliche Fehlercodes wie die Standardcodes zugeordnet.

Details
Parameter
[in] e
Der zuzuordnende POSIX-Netzwerk- oder Betriebssystemfehler.
Rückgabe
Der zugeordnete POSIX-Netzwerk- oder Betriebssystemfehler.

RegisterLwIPErrorFormatter

void RegisterLwIPErrorFormatter(
  void
)

Registrieren Sie einen Textfehlerformatierer für LwIP-Fehler.

RegisterPOSIXErrorFormatter

void RegisterPOSIXErrorFormatter(
  void
)

Registrieren Sie einen Textfehlerformatierer für POSIX-Fehler.

RegisterSystemLayerErrorFormatter

void RegisterSystemLayerErrorFormatter(
  void
)

Registriert einen Textfehlerformatierer für System-Layer-Fehler.