nl::Weave::System

Résumé

Énumérations
@18{
  kTimerFactor_micro_per_milli = 1000,
  kTimerFactor_milli_per_unit = 1000,
  kTimerFactor_nano_per_milli = 1000000,
  kTimerFactor_micro_per_unit = 1000000
} 		énum
@19{
  kEvent_ReleaseObj = _WEAVE_SYSTEM_CONFIG_LWIP_EVENT(0),
  kEvent_ScheduleWork = _WEAVE_SYSTEM_CONFIG_LWIP_EVENT(1)
} 		énum
Définitions des types d'événements de la couche Inet
LayerState{
  kLayerState_NotInitialized = 0,
  kLayerState_Initialized = 1
} 		énum
État d'un objet Layer.

Typedefs
Event nl::Weave::System::Event
Objet de base pour tous les événements InetLayer.
EventType nl::Weave::System::EventType
Type de base pour tous les événements InetLayer.
LwIPEventHandlerFunction)(Object &aTarget, EventType aEventType, uintptr_t aArgument) typedef
Error(*

Fonctions
DescribeErrorLwIP(Error aError)
NL_DLL_EXPORT const char *
Ce code implémente une fonction qui renvoie une chaîne C descriptive spécifique à LwIP se terminant par NULL et associée à l'erreur LwIP mappée spécifiée.
DescribeErrorPOSIX(Error aError)
NL_DLL_EXPORT const char *
Ce code implémente une fonction qui renvoie une chaîne C descriptive spécifique au système d'exploitation arrêtée par la valeur NULL, associée à l'erreur d'OS spécifiée et mappée.
FormatLwIPError(char *buf, uint16_t bufSize, int32_t err)
bool
Pour une erreur LwIP, renvoie une chaîne C qui se termine par une valeur NULL et qui décrit l'erreur dans un format lisible.
FormatPOSIXError(char *buf, uint16_t bufSize, int32_t err)
bool
Pour une erreur POSIX, cette fonction renvoie une chaîne C qui se termine par une valeur NULL et qui décrit l'erreur dans un format lisible.
FormatSystemLayerError(char *buf, uint16_t bufSize, int32_t err)
bool
En cas d'erreur système de Layer, renvoie une chaîne C qui se termine par une valeur NULL et qui décrit l'erreur dans un format lisible.
IsErrorLwIP(Error aError)
NL_DLL_EXPORT bool
Cela implémente une fonction d'introspection pour les erreurs de couche du système Weave, qui permet à l'appelant de déterminer si l'erreur spécifiée est une erreur LwIP interne sous-jacente.
IsErrorPOSIX(Error aError)
NL_DLL_EXPORT bool
Cela implémente une fonction d'introspection pour les erreurs de couche du système Weave, qui permet à l'appelant de déterminer si l'erreur spécifiée est une erreur interne du système d'exploitation sous-jacente.
IsEventOfType(EventType aType)
bool
Vérifiez si un EventType est valide.
MapErrorLwIP(err_t aError)
NL_DLL_EXPORT Error
Cela implémente une fonction de mappage pour les erreurs de couche du système Weave, qui permet de mapper les erreurs de pile réseau LwIP sous-jacentes dans une plage spécifique à une plate-forme ou un système.
MapErrorPOSIX(int aError)
NL_DLL_EXPORT Error
Cela implémente une fonction de mappage pour les erreurs de couche du système Weave, qui permet de mapper les entiers dans l'espace numérique du réseau POSIX sous-jacent et les erreurs de pile de l'OS dans une plage spécifique à la plate-forme ou au système.
RegisterLwIPErrorFormatter(void)
void
Enregistrer un outil de mise en forme des erreurs de texte pour les erreurs LwIP
RegisterPOSIXErrorFormatter(void)
void
Enregistrer un outil de mise en forme des erreurs textuelles pour les erreurs POSIX
RegisterSystemLayerErrorFormatter(void)
void
Enregistre un outil de mise en forme des erreurs textuelles pour les erreurs de calque système.

Classes
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

Représente un objet compté par les références alloué depuis l'espace contenu dans un objet ObjectPool<t, n=""> . &lt;/t,&gt;
nl::Weave::System::PacketBuffer

La classe de tampon de paquets est la structure de base utilisée pour manipuler les paquets de données sérialisées par des octets, généralement dans le contexte d'un réseau de communication de données, tel que le Bluetooth ou le protocole Internet.

nl::Weave::System::Timer

Il s'agit d'une classe interne au Layer du système Weave, utilisée pour représenter un minuteur one-shot en cours.

Structs
nl::Weave::System::LwIPEvent

Union
nl::Weave::System::ObjectArena 

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

Espaces de noms
nl::Weave::System::Platform
nl::Weave::System::Stats

Énumérations

@18

 @18
Propriétés
kTimerFactor_micro_per_milli

Nombre de nanosecondes en microseconde.

kTimerFactor_micro_per_unit

Nombre de nanosecondes en milliseconde.

kTimerFactor_milli_per_unit

Nombre de microsecondes dans une milliseconde.

kTimerFactor_nano_per_milli

Nombre de millisecondes dans une seconde.

@19

 @19

Définitions des types d'événements de la couche Inet

Propriétés
kEvent_ReleaseObj

Événement lié à la suppression d'un objet SystemLayer.

kEvent_ScheduleWork

Événement de planification de la tâche sur le thread du calque système.

LayerState

 LayerState

État d'un objet Layer.

Propriétés
kLayerState_Initialized

État initialisé.

kLayerState_NotInitialized

État non initialisé.

Typedefs

Événement

WEAVE_SYSTEM_CONFIG_LWIP_EVENT_OBJECT_TYPE Event

Objet de base pour tous les événements InetLayer.

Il s'agit d'un type spécifique à la plate-forme ou au système.

EventType

WEAVE_SYSTEM_CONFIG_LWIP_EVENT_TYPE EventType

Type de base pour tous les événements InetLayer.

Il s'agit d'un type spécifique à la plate-forme ou au système.

LwIPEventHandlerFunction

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

Fonctions

DescribeErrorLwIP

NL_DLL_EXPORT const char * DescribeErrorLwIP(
  Error aError
)

Ce code implémente une fonction qui renvoie une chaîne C descriptive spécifique à LwIP se terminant par NULL et associée à l'erreur LwIP mappée spécifiée.

Détails
Paramètres
[in] err
Erreur spécifique à LwIP mappée à décrire.
Renvoie
Chaîne C descriptive spécifique à LwIP et se terminant par NULL qui décrit l'erreur.

DescribeErrorPOSIX

NL_DLL_EXPORT const char * DescribeErrorPOSIX(
  Error aError
)

Ce code implémente une fonction qui renvoie une chaîne C descriptive spécifique au système d'exploitation arrêtée par la valeur NULL, associée à l'erreur d'OS spécifiée et mappée.

Détails
Paramètres
[in] err
Erreur spécifique au système d'exploitation mappée à décrire.
Renvoie
Chaîne C descriptive se terminant par une valeur NULL et spécifique au système d'exploitation décrivant l'erreur.

FormatLwIPError

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

Pour une erreur LwIP, cette fonction renvoie une chaîne C qui se termine par une valeur NULL et qui décrit l'erreur dans un format lisible.

Détails
Paramètres
[in] buf
Tampon dans lequel la chaîne d'erreur sera placée.
[in] bufSize
Taille du tampon fourni en octets.
[in] err
Erreur à décrire.
Renvoie
"true" si une chaîne de description a été écrite dans le tampon fourni.
Renvoie
"false" si l'erreur fournie n'était pas une erreur LwIP.

FormatPOSIXError

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

Pour une erreur POSIX, cette fonction renvoie une chaîne C qui se termine par une valeur NULL et qui décrit l'erreur dans un format lisible.

Détails
Paramètres
[in] buf
Tampon dans lequel la chaîne d'erreur sera placée.
[in] bufSize
Taille du tampon fourni en octets.
[in] err
Erreur à décrire.
Renvoie
"true" si une chaîne de description a été écrite dans le tampon fourni.
Renvoie
"false" si l'erreur fournie n'était pas une erreur POSIX.

FormatSystemLayerError

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

En cas d'erreur système de Layer, renvoie une chaîne C qui se termine par une valeur NULL et qui décrit l'erreur dans un format lisible.

Détails
Paramètres
[in] buf
Tampon dans lequel la chaîne d'erreur sera placée.
[in] bufSize
Taille du tampon fourni en octets.
[in] err
Erreur à décrire.
Renvoie
"true" si une chaîne de description a été écrite dans le tampon fourni.
Renvoie
"false" si l'erreur fournie n'était pas une erreur de la couche système.

IsErrorLwIP

NL_DLL_EXPORT bool IsErrorLwIP(
  Error aError
)

Cela implémente une fonction d'introspection pour les erreurs de couche du système Weave, qui permet à l'appelant de déterminer si l'erreur spécifiée est une erreur LwIP interne sous-jacente.

Détails
Paramètres
[in] err
Erreur mappée pour déterminer s'il s'agit d'une erreur LwIP.
Renvoie
"True" si l'erreur spécifiée est une erreur LwIP. sinon, "false".

IsErrorPOSIX

NL_DLL_EXPORT bool IsErrorPOSIX(
  Error aError
)

Cela implémente une fonction d'introspection pour les erreurs de couche du système Weave, qui permet à l'appelant de déterminer si l'erreur spécifiée est une erreur interne du système d'exploitation sous-jacente.

Détails
Paramètres
[in] err
Erreur mappée pour déterminer s'il s'agit d'une erreur du système d'exploitation.
Renvoie
"True" si l'erreur spécifiée est une erreur du système d'exploitation. sinon, "false".

IsEventOfType

bool IsEventOfType(
  EventType aType
)

Vérifiez si un EventType est valide.

Détails
Paramètres
[in] aEventType
Type d'événement Layer du système Weave.
Renvoie
"true" si la valeur est comprise dans la plage énumérée ; sinon, "false".

MapErrorLwIP

NL_DLL_EXPORT Error MapErrorLwIP(
  err_t aError
)

Cela implémente une fonction de mappage pour les erreurs de couche du système Weave, qui permet de mapper les erreurs de pile réseau LwIP sous-jacentes dans une plage spécifique à une plate-forme ou un système.

Détails
Paramètres
[in] e
Erreur LwIP à mapper.
Renvoie
Erreur de réseau ou de système d'exploitation LwIP mappée.

MapErrorPOSIX

NL_DLL_EXPORT Error MapErrorPOSIX(
  int aError
)

Cela implémente une fonction de mappage pour les erreurs de couche du système Weave, qui permet de mapper les entiers dans l'espace numérique du réseau POSIX sous-jacent et les erreurs de pile de l'OS dans une plage spécifique à la plate-forme ou au système.

Les codes d'erreur autres que ceux actuellement définis par POSIX ou les normes ISO C/C++ sont mappés de la même manière que les codes standards.

Détails
Paramètres
[in] e
Erreur de réseau POSIX ou de système d'exploitation à mapper.
Renvoie
Erreur de réseau ou de système d'exploitation POSIX mappée.

RegisterLwIPErrorFormatter

void RegisterLwIPErrorFormatter(
  void
)

Enregistrer un outil de mise en forme des erreurs de texte pour les erreurs LwIP

RegisterPOSIXErrorFormatter

void RegisterPOSIXErrorFormatter(
  void
)

Enregistrer un outil de mise en forme des erreurs textuelles pour les erreurs POSIX

RegisterSystemLayerErrorFormatter

void RegisterSystemLayerErrorFormatter(
  void
)

Enregistre un outil de mise en forme des erreurs textuelles pour les erreurs de calque système.