nl::Weave::Warm::Platform

Résumé

Fonctions
AddRemoveHostAddress(InterfaceType inInterfaceType, const Inet::IPAddress & inAddress, uint8_t inPrefixLength, bool inAdd)
Une API de plate-forme appelée Chaud qui ajoute ou supprime une adresse IP d'hôte dans l'interface spécifiée sur la pile TCP/IP de l'hôte
AddRemoveHostRoute(InterfaceType inInterfaceType, const Inet::IPPrefix & inPrefix, RoutePriority inPriority, bool inAdd)
Une API de plate-forme appelée Chaud qui ajoute ou supprime une route IP pour l'interface spécifiée sur la pile TCP/IP de l'hôte
AddRemoveThreadAddress(InterfaceType inInterfaceType, const Inet::IPAddress & inAddress, bool inAdd)
Une API de plate-forme Warm appelle pour ajouter ou supprimer une adresse IP à l'interface spécifiée sur la pile TCP/IP du thread.
AddRemoveThreadRoute(InterfaceType inInterfaceType, const Inet::IPPrefix & inPrefix, RoutePriority inPriority, bool inAdd)
Une API de plate-forme Warm appelle pour ajouter ou supprimer une route IP pour l'interface spécifiée sur la pile TCP/IP du thread.
CriticalSectionEnter(void)
void
API de plate-forme appelée Warm pour protéger l'accès à l'état interne.
CriticalSectionExit(void)
void
Une API de plate-forme que l'option Chaleur appellera pour libérer l'accès protégé à l'état interne.
Init(WarmFabricStateDelegate *inFabricStateDelegate)
API de plate-forme que l'option Warm appellera dans le cadre de l'exécution nl::Warm::Init.
RequestInvokeActions(void)
void
Une API de plate-forme que la méthode Warm appelle pour annoncer que la plate-forme doit appeler CallActions.
SetThreadRoutePriority(InterfaceType inInterfaceType, const Inet::IPPrefix & inPrefix, RoutePriority inPriority)
API de plate-forme Warm appelée pour modifier la priorité d'une route IP existante pour l'interface spécifiée sur la pile TCP/IP du thread.
StartStopThreadAdvertisement(InterfaceType inInterfaceType, const Inet::IPPrefix & inPrefix, bool inStart)
Une API de plate-forme appelée Warm pour démarrer ou arrêter l'annonce d'un préfixe IP sur l'interface Thread

Fonctions

AddRemoveHostAddress

PlatformResult AddRemoveHostAddress(
  InterfaceType inInterfaceType,
  const Inet::IPAddress & inAddress,
  uint8_t inPrefixLength,
  bool inAdd
)

Une API de plate-forme appelée Chaud qui ajoute ou supprime une adresse IP d'hôte dans l'interface spécifiée sur la pile TCP/IP de l'hôte

Une fois l'opération terminée, la plate-forme doit appeler ReportActionComplete avec le résultat final.

Détails
Paramètres
[in] inInterfaceType
Interface à modifier.
[in] inAddress
Adresse IP à ajouter/supprimer.
[in] inPrefixLength
Longueur du préfixe du champ inAddress.
[in] inAdd
"true" pour ajouter l'adresse, "false" pour la supprimer.
Valeurs renvoyées
kPlatformResultSuccess
L'opération a bien été effectuée.
kPlatformResultFailure
Échec de l'opération.
kPlatformResultInProgress
L'opération sera terminée de manière asynchrone.

AddRemoveHostRoute

PlatformResult AddRemoveHostRoute(
  InterfaceType inInterfaceType,
  const Inet::IPPrefix & inPrefix,
  RoutePriority inPriority,
  bool inAdd
)

Une API de plate-forme appelée Chaud qui ajoute ou supprime une route IP pour l'interface spécifiée sur la pile TCP/IP de l'hôte

Une fois l'opération terminée, la plate-forme doit appeler ReportActionComplete avec le résultat final.

Détails
Paramètres
[in] inInterfaceType
Interface à modifier.
[in] inPrefix
Préfixe IP à ajouter ou à supprimer.
[in] inPriority
Priorité à utiliser lorsque la route est attribuée.
[in] inAdd
"true" pour ajouter le préfixe en tant que route, "false" pour supprimer le préfixe en tant que route.
Valeurs renvoyées
kPlatformResultSuccess
L'opération a bien été effectuée.
kPlatformResultFailure
Échec de l'opération.
kPlatformResultInProgress
L'opération sera terminée de manière asynchrone.

AddRemoveThreadAddress

PlatformResult AddRemoveThreadAddress(
  InterfaceType inInterfaceType,
  const Inet::IPAddress & inAddress,
  bool inAdd
)

Une API de plate-forme Warm appelle pour ajouter ou supprimer une adresse IP à l'interface spécifiée sur la pile TCP/IP du thread.

Une fois l'opération terminée, la plate-forme doit appeler ReportActionComplete avec le résultat final.

Détails
Paramètres
[in] inInterfaceType
Interface à modifier.
[in] inAddress
Adresse IP à ajouter/supprimer.
[in] inAdd
"true" pour ajouter l'adresse, "false" pour la supprimer.
Valeurs renvoyées
kPlatformResultSuccess
L'opération a bien été effectuée.
kPlatformResultFailure
Échec de l'opération.
kPlatformResultInProgress
L'opération sera terminée de manière asynchrone.

AddRemoveThreadRoute

PlatformResult AddRemoveThreadRoute(
  InterfaceType inInterfaceType,
  const Inet::IPPrefix & inPrefix,
  RoutePriority inPriority,
  bool inAdd
)

Une API de plate-forme Warm appelle pour ajouter ou supprimer une route IP pour l'interface spécifiée sur la pile TCP/IP du thread.

Une fois l'opération terminée, la plate-forme doit appeler ReportActionComplete avec le résultat final.

Détails
Paramètres
[in] inInterfaceType
Interface à modifier.
[in] inPrefix
Préfixe IP à attribuer ou à supprimer.
[in] inPriority
Priorité à utiliser lorsque la route est attribuée.
[in] inAdd
"true" pour ajouter le préfixe en tant que route, "false" pour supprimer le préfixe en tant que route.
Valeurs renvoyées
kPlatformResultSuccess
L'opération a bien été effectuée.
kPlatformResultFailure
Échec de l'opération.
kPlatformResultInProgress
L'opération sera terminée de manière asynchrone.

CriticalSectionEnter

void CriticalSectionEnter(
  void
)

API de plate-forme appelée Warm pour protéger l'accès à l'état interne.

CriticalSectionExit

void CriticalSectionExit(
  void
)

API de plate-forme appelée Warm pour libérer l'accès protégé à l'état interne.

Init

WEAVE_ERROR Init(
  WarmFabricStateDelegate *inFabricStateDelegate
)

API de plate-forme que l'option Warm appellera dans le cadre de l'exécution nl::Warm::Init.

Détails
Paramètres
[in] inFabricStateDelegate
Un pointeur vers l'objet fabricStateDelegate utilisé par la fonction Warm pour recevoir les mises à jour de l'état de la structure.
Renvoie
WEAVE_NO_ERROR en cas de réussite, code d'erreur dans le cas contraire.

RequestInvokeActions

void RequestInvokeActions(
  void
)

Une API de plate-forme que Warm appelle pour annoncer que la plate-forme doit appeler CallActions.

SetThreadRoutePriority

PlatformResult SetThreadRoutePriority(
  InterfaceType inInterfaceType,
  const Inet::IPPrefix & inPrefix,
  RoutePriority inPriority
)

API de plate-forme Warm qui appelle pour modifier la priorité d'une route IP existante pour l'interface spécifiée sur la pile TCP/IP du thread.

Une fois l'opération terminée, la plate-forme doit appeler ReportActionComplete avec le résultat final.

Détails
Paramètres
[in] inInterfaceType
Interface à modifier.
[in] inPrefix
Préfixe IP à modifier.
[in] inPriority
Nouvelle priorité à appliquer à la route.
Valeurs renvoyées
kPlatformResultSuccess
L'opération a bien été effectuée.
kPlatformResultFailure
Échec de l'opération.
kPlatformResultInProgress
L'opération sera terminée de manière asynchrone.

StartStopThreadAdvertisement

PlatformResult StartStopThreadAdvertisement(
  InterfaceType inInterfaceType,
  const Inet::IPPrefix & inPrefix,
  bool inStart
)

Une API de plate-forme appelée Warm pour démarrer ou arrêter l'annonce d'un préfixe IP sur l'interface Thread

Une fois l'opération terminée, la plate-forme doit appeler ReportActionComplete avec le résultat final.

Détails
Paramètres
[in] inInterfaceType
Interface à modifier.
[in] inPrefix
Préfixe IP pour lequel la publicité doit être lancée ou arrêtée.
[in] inStart
"true" pour diffuser des annonces, "false" pour arrêter de diffuser des annonces.
Valeurs renvoyées
kPlatformResultSuccess
L'opération a bien été effectuée.
kPlatformResultFailure
Échec de l'opération.
kPlatformResultInProgress
L'opération sera terminée de manière asynchrone.