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
} 		enum
@19{
  kEvent_ReleaseObj = _WEAVE_SYSTEM_CONFIG_LWIP_EVENT(0),
  kEvent_ScheduleWork = _WEAVE_SYSTEM_CONFIG_LWIP_EVENT(1)
} 		enum
Définitions du type d'événement de la couche Inet.
LayerState{
  kLayerState_NotInitialized = 0,
  kLayerState_Initialized = 1
} 		enum
É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(*

distantes
DescribeErrorLwIP(Error aError)
NL_DLL_EXPORT const char *
Cette commande implémente une fonction pour renvoyer une chaîne C descriptive spécifique à LwIP terminée en valeur NULL, associée à l'erreur LwIP mappée spécifiée.
DescribeErrorPOSIX(Error aError)
NL_DLL_EXPORT const char *
Cette commande implémente une fonction pour renvoyer une chaîne C descriptive spécifique à l'OS terminée par une valeur NULL et associée à l'erreur d'OS mappée spécifiée.
FormatLwIPError(char *buf, uint16_t bufSize, int32_t err)
bool
Pour une erreur LwIP, renvoie une chaîne C lisible par l'humain se terminant par une valeur NULL décrivant l'erreur.
FormatPOSIXError(char *buf, uint16_t bufSize, int32_t err)
bool
Pour une erreur POSIX, renvoie une chaîne C lisible par l'humain se terminant par une valeur NULL décrivant l'erreur.
FormatSystemLayerError(char *buf, uint16_t bufSize, int32_t err)
bool
Pour une erreur de couche système, renvoie une chaîne C lisible par l'humain se terminant par une valeur NULL décrivant l'erreur.
IsErrorLwIP(Error aError)
NL_DLL_EXPORT bool
Ce code 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 d'OS interne sous-jacente.
IsEventOfType(EventType aType)
bool
Vérifiez si un EventType est valide.
MapErrorLwIP(err_t aError)
NL_DLL_EXPORT Error
Cette fonctionnalité 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 à la plate-forme ou au système.
MapErrorPOSIX(int aError)
NL_DLL_EXPORT Error
Cette fonctionnalité implémente une fonction de mappage pour les erreurs de couche du système Weave. Elle permet de mapper les entiers dans l'espace numérique du réseau POSIX sous-jacent et les erreurs de pile du système d'exploitation 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
Enregistrez un outil de mise en forme des erreurs de texte pour les erreurs POSIX.
RegisterSystemLayerErrorFormatter(void)
void
Enregistrer un outil de mise en forme des erreurs de texte pour les erreurs de couche du 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

Celui-ci représente un objet comptabilisé en référence alloué à partir de l'espace contenu dans un objet ObjectPool<t, n="">. </t,>
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 octet, 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 à la couche du système Weave, qui représente un minuteur one-shot en cours.

Structs
nl::Weave::System::LwIPEvent

Unions
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 par microseconde.

kTimerFactor_micro_per_unit

Nombre de nanosecondes par milliseconde

kTimerFactor_milli_per_unit

Nombre de microsecondes par milliseconde.

kTimerFactor_nano_per_milli

Nombre de millisecondes par seconde.

@19

 @19

Définitions du type d'événement de la couche Inet.

Propriétés
kEvent_ReleaseObj

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

kEvent_ScheduleWork

Événement de planification des tâches sur le thread de la couche 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 est défini sur un type spécifique à une plate-forme ou à un système.

EventType

WEAVE_SYSTEM_CONFIG_LWIP_EVENT_TYPE EventType

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

Il est défini sur un type spécifique à une plate-forme ou à un système.

LwIPEventHandlerFunction

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

distantes

DescribeErrorLwIP

NL_DLL_EXPORT const char * DescribeErrorLwIP(
  Error aError
)

Cette commande implémente une fonction pour renvoyer une chaîne C descriptive spécifique à LwIP terminée en valeur NULL, 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 décrivant l'erreur, se terminant par la valeur NULL.

DescribeErrorPOSIX

NL_DLL_EXPORT const char * DescribeErrorPOSIX(
  Error aError
)

Cette commande implémente une fonction pour renvoyer une chaîne C descriptive spécifique à l'OS terminée par une valeur NULL et associée à l'erreur d'OS mappée spécifiée.

Détails
Paramètres
[in] err
Erreur spécifique à l'OS mappée à décrire.
Renvoie
Chaîne C descriptive spécifique à l'OS et terminée en mode NULL, décrivant l'erreur.

FormatLwIPError

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

Pour une erreur LwIP, renvoie une chaîne C lisible par l'humain se terminant par une valeur NULL décrivant l'erreur.

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, renvoie une chaîne C lisible par l'humain se terminant par une valeur NULL décrivant l'erreur.

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
)

Pour une erreur de couche système, renvoie une chaîne C lisible par l'humain se terminant par une valeur NULL décrivant l'erreur.

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 couche du système.

IsErrorLwIP

NL_DLL_EXPORT bool IsErrorLwIP(
  Error aError
)

Ce code 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 permettant de 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 d'OS interne sous-jacente.

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

IsEventOfType

bool IsEventOfType(
  EventType aType
)

Vérifiez si un EventType est valide.

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

MapErrorLwIP

NL_DLL_EXPORT Error MapErrorLwIP(
  err_t aError
)

Cette fonctionnalité 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 à la plate-forme ou au système.

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

MapErrorPOSIX

NL_DLL_EXPORT Error MapErrorPOSIX(
  int aError
)

Cette fonctionnalité implémente une fonction de mappage pour les erreurs de couche du système Weave. Elle permet de mapper les entiers dans l'espace numérique du réseau POSIX sous-jacent et les erreurs de pile du système d'exploitation 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 normes standards.

Détails
Paramètres
[in] e
Erreur de réseau ou d'OS POSIX à mapper.
Renvoie
Erreur de réseau ou d'OS 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
)

Enregistrez un outil de mise en forme des erreurs de texte pour les erreurs POSIX.

RegisterSystemLayerErrorFormatter

void RegisterSystemLayerErrorFormatter(
  void
)

Enregistrer un outil de mise en forme des erreurs de texte pour les erreurs de couche du système.