nl::Weave::Warm::Platform

Résumé

distantes

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

distantes

AddRemoveHostAddress

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

Une API de plate-forme que Warm appelle pour ajouter ou supprimer une adresse IP d'hôte à l'interface spécifiée dans 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 de l'inAddress.
[in] inAdd
"true" pour ajouter l'adresse et "false" pour supprimer l'adresse.
Valeurs de retour
kPlatformResultSuccess
L'opération a bien été effectuée.
kPlatformResultFailure
Échec de l'opération.
kPlatformResultInProgress
L'opération s'effectue de manière asynchrone.

AddRemoveHostRoute

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

Une API de plate-forme que Warm appelle afin d'ajouter ou de supprimer une route IP pour l'interface spécifiée dans 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 de retour
kPlatformResultSuccess
L'opération a bien été effectuée.
kPlatformResultFailure
Échec de l'opération.
kPlatformResultInProgress
L'opération s'effectue de manière asynchrone.

AddRemoveThreadAddress

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

Une API de plate-forme que Warm appelle pour ajouter ou supprimer une adresse IP à l'interface spécifiée dans la pile TCP/IP 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 et "false" pour supprimer l'adresse.
Valeurs de retour
kPlatformResultSuccess
L'opération a bien été effectuée.
kPlatformResultFailure
Échec de l'opération.
kPlatformResultInProgress
L'opération s'effectue de manière asynchrone.

AddRemoveThreadRoute

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

Une API de plate-forme que Warm appelle afin d'ajouter ou de supprimer une route IP pour l'interface spécifiée dans la pile TCP/IP 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 / 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 de retour
kPlatformResultSuccess
L'opération a bien été effectuée.
kPlatformResultFailure
Échec de l'opération.
kPlatformResultInProgress
L'opération s'effectue de manière asynchrone.

CriticalSectionEnter

void CriticalSectionEnter(
  void
)

Une API de plate-forme que Warm appelle pour protéger l'accès à l'état interne.

CriticalSectionExit

void CriticalSectionExit(
  void
)

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

Init

WEAVE_ERROR Init(
  WarmFabricStateDelegate *inFabricStateDelegate
)

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

Détails
Paramètres
[in] inFabricStateDelegate
Pointeur vers l'objet fabricStateDeélégation utilisé par Warm pour recevoir des mises à jour de l'état de la fabric.
Renvoie
WEAVE_NO_ERROR en cas de réussite, sinon, code d'erreur.

RequestInvokeActions

void RequestInvokeActions(
  void
)

Une API de plate-forme que Warm appellera pour annoncer que la plate-forme doit appeler AppelerActions.

SetThreadRoutePriority

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

Une API de plate-forme que Warm appelle pour modifier la priorité d'une route IP existante pour l'interface spécifiée dans la pile TCP/IP 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 de retour
kPlatformResultSuccess
L'opération a bien été effectuée.
kPlatformResultFailure
Échec de l'opération.
kPlatformResultInProgress
L'opération s'effectue de manière asynchrone.

StartStopThreadAdvertisement

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

Une API de plate-forme que Warm appelle pour démarrer / 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 / arrêtée.
[in] inStart
"true" pour commencer à diffuser des annonces, "false" pour arrêter de diffuser des annonces.
Valeurs de retour
kPlatformResultSuccess
L'opération a bien été effectuée.
kPlatformResultFailure
Échec de l'opération.
kPlatformResultInProgress
L'opération s'effectue de manière asynchrone.