Cette page a été traduite par l'API Cloud Translation.

nl::Weave::Warm

Cet espace de noms comprend des interfaces pour le module d'adresse et de routage Weave, un module portable permettant de configurer les adresses IP et les routes Weave.

Résumé

Énumérations
ActionType{ kActionTypeWiFiHostAddress = (1 << 0), kActionTypeThreadHostAddress = (1 << 1), kActionTypeThreadThreadAddress = (1 << 2), kActionTypeLegacy6LoWPANHostAddress = (1 << 3), kActionTypeLegacy6LoWPANThreadAddress = (1 << 4), kActionTypeHostRouteThread = (1 << 5), kActionTypeThreadAdvertisement = (1 << 6), kActionTypeThreadRoute = (1 << 7), kActionTypeTunnelHostAddress = (1 << 8), kActionTypeTunnelHostRoute = (1 << 9), kActionTypeThreadRoutePriority = (1 << 10), kActionTypeTunnelServiceRoute = (1 << 11), kActionTypeMax = (1 << 16) }	énum
`InitState{ kInitStateNotInitialized = 0 }`	énum
`InterfaceState`	énum Énumération des valeurs possibles pour l'état de l'interface.
`InterfaceType{ kInterfaceTypeLegacy6LoWPAN = 0, kInterfaceTypeThread, kInterfaceTypeWiFi, kInterfaceTypeTunnel, kInterfaceTypeCellular }`	énum Énumération des types d'interfaces possibles.
`PlatformActionExecution{ kPlatformActionExecutionContinue = false, kPlatformActionExecutionSuspendForAsynchOpCompletion = true }`	énum
`PlatformResult{ kPlatformResultSuccess = 0, kPlatformResultFailure, kPlatformResultInProgress }`	énum Énumération des valeurs renvoyées par l'API de la plate-forme.
`RoutePriority`	énum Énumération des priorités de routes possibles permettant de donner la priorité à une route sur une autre.
`SystemFeatureType{ kSystemFeatureTypeIsFabricMember = (1 << 0), kSystemFeatureTypeWiFiConnected = (1 << 1), kSystemFeatureTypeThreadConnected = (1 << 2), kSystemFeatureTypeThreadRoutingEnabled = (1 << 3), kSystemFeatureTypeBorderRoutingEnabled = (1 << 4), kSystemFeatureTypeTunnelInterfaceEnabled = (1 << 5), kSystemFeatureTypeTunnelState = (1 << 6), kSystemFeatureTypeCellularConnected = (1 << 7), kSystemFeatureTypeMax = (1 << 16) }`	énum

Typedefs
`ActionFunction)(ActionType inAction, bool inActivate, const uint64_t &inGlobalId, const uint64_t &inInterfaceId)`	typedef `PlatformResult(*`
`FlagsType`	typedef `uint16_t`

Variables
`kGlobalULAPrefixLength = 48`	`const uint8_t`
`kLegacy6LoWPANULAAddressPrefixLength = 64`	`const uint8_t`
`kThreadULAAddressPrefixLength = 64`	`const uint8_t`
`kTunnelAddressPrefixLength = 128`	`const uint8_t`
`kWiFiULAAddressPrefixLength = 64`	`const uint8_t`
`sFabricStateDelegate`	`WarmFabricStateDelegate`
`sState`	`ModuleState`

Fonctions
`BorderRouterStateChange(InterfaceState inState)`	`void` API WARM appelée pour annoncer un changement d'état de la fonctionnalité de routeur de bordure.
`CellularInterfaceStateChange(InterfaceState inState)`	`void` Une API WARM appelée pour annoncer un changement d'état de l'interface mobile.
`FabricStateChange(InterfaceState inState)`	`void` Fonction appelée pour annoncer un changement d'état de la fonctionnalité Weave Fabric.
`GetCurrentActionState(ActionType inAction)`	`bool` Fonction statique qui renvoie l'état actuel d'une action spécifiée.
`GetFabricState(const WeaveFabricState *& outFabricState)`	`WEAVE_ERROR` API WARM permettant d'acquérir l'objet FabricState fourni à Warm pendant Init.
`GetSystemFeatureState(SystemFeatureType inSystemFeature)`	`bool` Une fonction statique qui obtient l'état actuel d'une caractéristique système.
`GetULA(InterfaceType inInterfaceType, Inet::IPAddress & outAddress)`	`WEAVE_ERROR` API WARM permettant d'acquérir une ULA pour un type d'interface spécifié.
`Init(WeaveFabricState & inFabricState)`	`WEAVE_ERROR` API WARM permettant d'initialiser des modules une seule fois.
`InvokeActions(void)`	`void` API WARM appelée par une tâche dédiée pour effectuer diverses actions d'API de la plate-forme.
`LegacyHostAddressAction(ActionType inAction, bool inActivate, const uint64_t & inGlobalId, const uint64_t & inInterfaceId)`	`PlatformResult` L'une des méthodes Action.
`LegacyThreadAddressAction(ActionType inAction, bool inActivate, const uint64_t & inGlobalId, const uint64_t & inInterfaceId)`	`PlatformResult` L'une des méthodes Action.
`MakePrefix(const uint64_t & inGlobalID, const uint16_t subnetId, const uint8_t inPrefixLen, Inet::IPPrefix & outPrefix)`	`void` Un utilitaire permettant de construire un préfixe de 48 bits à partir d'un globalID.
`MapAvailabilityToPriority(Profiles::WeaveTunnel::Platform::TunnelAvailabilityMode inAvailability)`	`RoutePriority` Fonction statique qui renvoie un mappage de TunnelAvailability à RoutePriority.
`RecordPlatformResult(PlatformResult inResult, ActionType inAction, bool inActionState)`	`PlatformActionExecution` Fonction statique qui enregistre le résultat d'un appel d'action d'API de plate-forme.
`ReportActionComplete(PlatformResult inResult)`	`void` API WARM appelée pour annoncer la fin d'un appel d'API de plate-forme asynchrone précédent.
`SetCurrentActionState(ActionType inAction, bool inValue)`	`void` Fonction statique qui définit l'état actuel d'une action spécifiée.
`SetSystemFeatureState(SystemFeatureType inSystemFeature, bool inValue)`	`bool` Fonction statique qui définit l'état actuel de la fonctionnalité système.
`ShouldPerformAction(ActionType inAction, FlagsType inNecessarySystemFeatureState, bool & outActivate)`	`bool` Fonction statique qui détermine si l'action spécifiée doit être effectuée.
`SystemFeatureStateChangeHandler(SystemFeatureType inSystemFeatureType, bool inState)`	`void` Fonction statique qui définit l'état des fonctionnalités système et informe la plate-forme que l'état de l'événement a changé.
`TakeActions(void)`	`void` Une fonction statique qui teste l'état de chaque action et effectue un appel d'API de plate-forme pour modifier l'état de l'action si nécessaire.
`ThreadAdvertisementAction(ActionType inAction, bool inActivate, const uint64_t & inGlobalId, const uint64_t & inInterfaceId)`	`PlatformResult` L'une des méthodes Action.
`ThreadHostAddressAction(ActionType inAction, bool inActivate, const uint64_t & inGlobalId, const uint64_t & inInterfaceId)`	`PlatformResult` L'une des méthodes Action.
`ThreadHostRouteAction(ActionType inAction, bool inActivate, const uint64_t & inGlobalId, const uint64_t & inInterfaceId)`	`PlatformResult` L'une des méthodes Action.
`ThreadInterfaceStateChange(InterfaceState inState)`	`void` API WARM appelée pour annoncer un changement d'état de l'interface Thread.
`ThreadRoutePriorityAction(ActionType inAction, bool inActivate, const uint64_t & inGlobalId, const uint64_t & inInterfaceId)`	`PlatformResult` L'une des méthodes Action.
`ThreadRoutingStateChange(InterfaceState inState)`	`void` API WARM appelée pour annoncer un changement d'état de la fonctionnalité de routage de threads.
`ThreadThreadAddressAction(ActionType inAction, bool inActivate, const uint64_t & inGlobalId, const uint64_t & inInterfaceId)`	`PlatformResult` L'une des méthodes Action.
`ThreadThreadRouteAction(ActionType inAction, bool inActivate, const uint64_t & inGlobalId, const uint64_t & inInterfaceId)`	`PlatformResult` L'une des méthodes Action.
`TunnelHostAddressAction(ActionType inAction, bool inActivate, const uint64_t & inGlobalId, const uint64_t & inInterfaceId)`	`PlatformResult` L'une des méthodes Action.
`TunnelHostRouteAction(ActionType inAction, bool inActivate, const uint64_t & inGlobalId, const uint64_t & inInterfaceId)`	`PlatformResult` L'une des méthodes Action.
`TunnelInterfaceStateChange(InterfaceState inState)`	`void` Une API WARM appelée pour annoncer un changement d'état de l'interface Weave Tunnel.
`TunnelPriorityStateChange(nl::Weave::Profiles::WeaveTunnel::Platform::TunnelAvailabilityMode inAvailability)`	`void` Une API WARM appelée pour mettre à jour la priorité du service de tunnel.
`TunnelServiceStateChange(InterfaceState inState, nl::Weave::Profiles::WeaveTunnel::Platform::TunnelAvailabilityMode inAvailability)`	`void` Une API WARM appelée pour annoncer un changement d'état de l'interface Weave Tunnel.
`WiFiHostAddressAction(ActionType inAction, bool inActivate, const uint64_t & inGlobalId, const uint64_t & inInterfaceId)`	`PlatformResult` L'une des méthodes Action.
`WiFiInterfaceStateChange(InterfaceState inState)`	`void` API WARM appelée pour annoncer un changement d'état de l'interface Wi-Fi.

Classes
nl::Weave::Warm::WarmFabricStateDelegate	Il s'agit d'une classe interne à "WarmCore".

Structs
nl::Weave::Warm::ActionEntry
nl::Weave::Warm::ModuleState

Espaces de noms
nl::Weave::Warm::Platform

Énumérations

ActionType

 ActionType

Propriétés
`kActionTypeHostRouteThread`	Ajouter \| Supprimez la route IP de l'interface Thread sur la pile IP de l'hôte.
`kActionTypeLegacy6LoWPANHostAddress`	Ajouter \| Supprimez l'adresse IP de l'ancienne interface 6LowPAN de la pile IP de l'hôte.
`kActionTypeLegacy6LoWPANThreadAddress`	Ajouter \| Supprimez l'adresse IP de l'ancienne interface 6LowPAN sur la pile IP du module Thread.
`kActionTypeMax`	NE PAS DÉPASSER ; réservé pour marquer le nombre maximal de bits disponibles.
`kActionTypeThreadAdvertisement`	Démarrer \| Arrêtez l'annonce de routage par le module Thread.
`kActionTypeThreadHostAddress`	Ajouter \| Supprimez l'adresse IP de l'interface Thread de la pile IP de l'hôte.
`kActionTypeThreadRoute`	Ajouter \| Supprimez la route IP du module Thread pour prendre en charge les routes de bordure.
`kActionTypeThreadRoutePriority`	Modifiez la priorité de la route de thread sur le module Thread.
`kActionTypeThreadThreadAddress`	Ajouter \| Supprimez l'adresse IP de l'interface Thread sur la pile IP du module Thread.
`kActionTypeTunnelHostAddress`	Ajouter \| Supprimez l'adresse IP de l'interface de tunnel de la pile IP de l'hôte.
`kActionTypeTunnelHostRoute`	Ajouter \| Supprimez la route IP de l'interface de tunnel sur la pile IP de l'hôte.
`kActionTypeTunnelServiceRoute`	Ajouter \| Supprimez la route IP 64 bits du sous-réseau de service de la pile IP de l'hôte.
`kActionTypeWiFiHostAddress`	Ajouter \| Supprimez l'adresse IP de l'interface Wi-Fi de la pile IP de l'hôte.

InitState

 InitState

Propriétés
`kInitStateNotInitialized`	Cette valeur doit être 0 pour que la valeur initiale de mInitState soit définie sur kInitStateNotInitialized.

InterfaceState

 InterfaceState

Énumération des valeurs possibles pour l'état de l'interface.

InterfaceType

 InterfaceType

Énumération des types d'interfaces possibles.

Propriétés
`kInterfaceTypeCellular`	Interface mobile.
`kInterfaceTypeLegacy6LoWPAN`	Interface d'alarme Thread.
`kInterfaceTypeThread`	Interface Thread
`kInterfaceTypeTunnel`	Interface du tunnel.
`kInterfaceTypeWiFi`	Interface Wi-Fi.

PlatformActionExecution

 PlatformActionExecution

Propriétés
`kPlatformActionExecutionContinue`	poursuivre l'exécution de l'action.
`kPlatformActionExecutionSuspendForAsynchOpCompletion`	Exécution de l'action de suspension pour l'exécution de l'opération asynchrone.

PlatformResult

 PlatformResult

Énumération des valeurs renvoyées par l'API de la plate-forme.

Propriétés
`kPlatformResultFailure`	Échec de l'exécution de l'API.
`kPlatformResultInProgress`	L'opération est en cours et se terminera de manière asynchrone.
`kPlatformResultSuccess`	L'API a bien été exécutée.

RoutePriority

 RoutePriority

Énumération des priorités de routes possibles permettant de donner la priorité à une route sur une autre.

SystemFeatureType

 SystemFeatureType

Propriétés
`kSystemFeatureTypeBorderRoutingEnabled`	La fonctionnalité d'acheminement frontalier du système est \| N'EST PAS activé.
`kSystemFeatureTypeCellularConnected`	Interface cellulaire du système \| N'EST PAS connecté.
`kSystemFeatureTypeIsFabricMember`	Le module Weave du système IS \| N'EST PAS membre d'un tissu.
`kSystemFeatureTypeMax`	NE PAS DÉPASSER ; réservé pour marquer le nombre maximal de bits disponibles.
`kSystemFeatureTypeThreadConnected`	Interface Thread du système \| N'EST PAS connecté.
`kSystemFeatureTypeThreadRoutingEnabled`	La fonctionnalité de routage Thread du système EST \| N'EST PAS activé.
`kSystemFeatureTypeTunnelInterfaceEnabled`	Interface de tunnel du système \| N'EST PAS activé.
`kSystemFeatureTypeTunnelState`	Le service de tunnels du système est \| N'EST PAS établi.
`kSystemFeatureTypeWiFiConnected`	Interface Wi-Fi du système \| N'EST PAS connecté.

Typedefs

ActionFunction

PlatformResult(* ActionFunction)(ActionType inAction, bool inActivate, const uint64_t &inGlobalId, const uint64_t &inInterfaceId)

FlagsType

uint16_t FlagsType

Variables

kGlobalULAPrefixLength

const uint8_t kGlobalULAPrefixLength = 48

kLegacy6LoWPANULAAddressPrefixLength

const uint8_t kLegacy6LoWPANULAAddressPrefixLength = 64

kThreadULAAddressPrefixLength

const uint8_t kThreadULAAddressPrefixLength = 64

kTunnelAddressPrefixLength

const uint8_t kTunnelAddressPrefixLength = 128

kWiFiULAAddressPrefixLength

const uint8_t kWiFiULAAddressPrefixLength = 64

sFabricStateDelegate

WarmFabricStateDelegate sFabricStateDelegate

sState

ModuleState sState

Fonctions

BorderRouterStateChange

void BorderRouterStateChange(
  InterfaceState inState
)

API WARM appelée pour annoncer un changement d'état de la fonctionnalité de routeur de bordure.

Détails

Paramètres

[in] inState

kInterfaceStateUp si la fonctionnalité Routeur de bordure est activée, kInterfaceStateDown dans le cas contraire.

CellularInterfaceStateChange

void CellularInterfaceStateChange(
  InterfaceState inState
)

Une API WARM appelée pour annoncer un changement d'état de l'interface mobile.

Détails

Paramètres

[in] inState

kInterfaceStateUp si l'interface cellulaire est opérationnelle, kInterfaceStateDown dans le cas contraire.

FabricStateChange

void FabricStateChange(
  InterfaceState inState
)

Fonction appelée pour annoncer un changement d'état de la fonctionnalité Weave Fabric.

Détails

Paramètres

[in] inState

kInterfaceStateUp si le système est membre d'une structure Weave, kInterfaceStateDown dans le cas contraire.

GetCurrentActionState

bool GetCurrentActionState(
  ActionType inAction
)

Fonction statique qui renvoie l'état actuel d'une action spécifiée.

Détails

Paramètres

[in] inAction

Type d'action à interroger.

Renvoie

"true" si l'action est définie sur "Set" ou "false" dans le cas contraire.

GetFabricState

WEAVE_ERROR GetFabricState(
  const WeaveFabricState *& outFabricState
)

API WARM permettant d'acquérir l'objet FabricState fourni à Warm pendant Init.

Détails

Paramètres

[out] outFabricState

Référence de pointeur à un objet fabricState.

Valeurs renvoyées

`WEAVE_NO_ERROR`	En cas de réussite.
`WEAVE_ERROR_INCORRECT_STATE`	Si cette API est appelée avant l'initialisation de WARM

GetSystemFeatureState

bool GetSystemFeatureState(
  SystemFeatureType inSystemFeature
)

Une fonction statique qui obtient l'état actuel d'une caractéristique système.

Détails

Paramètres

[in] inSystemFeature

Fonctionnalité système à interroger.

Renvoie

La valeur est "true" si la fonctionnalité système est activée, et la valeur "false" dans le cas contraire.

GetULA

WEAVE_ERROR GetULA(
  InterfaceType inInterfaceType,
  Inet::IPAddress & outAddress
)

API WARM permettant d'acquérir une ULA pour un type d'interface spécifié.

Détails

Paramètres

`[in] inInterfaceType`	Type d'interface pour lequel une ULA est souhaitée.
`[out] outAddress`	Objet d'adresse utilisé pour contenir l'ULA obtenu.

Valeurs renvoyées

`WEAVE_NO_ERROR`	En cas de réussite.
`WEAVE_ERROR_INCORRECT_STATE`	Si cette API est appelée alors que WARM n'est pas membre d'un Fabric.
`WEAVE_ERROR_INVALID_ARGUMENT`	Si cette API est appelée avec un type d'interface non valide.

Init

WEAVE_ERROR Init(
  WeaveFabricState & inFabricState
)

API WARM permettant d'initialiser des modules une seule fois.

Détails

Paramètres

[in] inFabricState

Référence à un WeaveFabricState valide.

Valeurs renvoyées

`WEAVE_NO_ERROR`	En cas d'initialisation réussie.
`WEAVE_ERROR_INCORRECT_STATE`	Lorsque Init est appelé plusieurs fois.
`other`	Code d'erreur dans les autres cas.

Renvoie

WEAVE_NO_ERROR en cas de réussite, code d'erreur dans le cas contraire.

InvokeActions

void InvokeActions(
  void
)

API WARM appelée par une tâche dédiée pour effectuer diverses actions d'API de la plate-forme.

Il s'agit du point d'entrée permettant d'effectuer les actions nécessaires pour satisfaire à l'état actuel du système. Par exemple, si la pile de threads est passée de "Désactivé" à "Activé", cette fonction effectue les appels de plate-forme nécessaires pour attribuer l'adresse hôte du thread, etc. Cette fonction ne doit être appelée par le code de la plate-forme qu'en réponse à un appel Warm à RequestRequestActions. Le fait d'appeler CallActions entraînera un ou plusieurs appels vers les API nl::Warm::Platform. Par conséquent, les développeurs doivent mettre en œuvre la méthode RequestRequestActions et l'appelant de InvokeActions() de manière appropriée. Il peut être judicieux pour RequestClaimActions de publier un événement dans la tâche, qui appelle InvokeActions(), par exemple. À l'inverse, si le système est monothread, il est possible d'implémenter la méthode RequestRequestActions afin d'appeler directement la méthode InvokeActions().

LegacyHostAddressAction

PlatformResult LegacyHostAddressAction(
  ActionType inAction,
  bool inActivate,
  const uint64_t & inGlobalId,
  const uint64_t & inInterfaceId
)

L'une des méthodes Action.

Définit l'adresse d'hôte de l'ancienne interface.

Détails

Paramètres

`[in] inAction`	Type d'action.
`[in] inActivate`	État souhaité "true" == activer, false == désactiver.
`[in] inGlobalId`	Référence à l'ID Weave Global s'il est nécessaire pour calculer une adresse.
`[in] inInterfaceId`	Référence à l'ID d'interface de l'appareil si celle-ci est nécessaire pour calculer une adresse.

Renvoie

Transfère le résultat à partir de Platform::HostAddress().

LegacyThreadAddressAction

PlatformResult LegacyThreadAddressAction(
  ActionType inAction,
  bool inActivate,
  const uint64_t & inGlobalId,
  const uint64_t & inInterfaceId
)

L'une des méthodes Action.

Définit l'adresse de thread pour l'ancienne interface 6LoWPAN.

Détails

Paramètres

`[in] inAction`	Type d'action.
`[in] inActivate`	État souhaité "true" == activer, false == désactiver.
`[in] inGlobalId`	Référence à l'ID Weave Global s'il est nécessaire pour calculer une adresse.
`[in] inInterfaceId`	Référence à l'ID d'interface de l'appareil si celle-ci est nécessaire pour calculer une adresse.

Renvoie

Transfère le résultat à partir de Platform::ThreadAddress().

MakePrefix

void MakePrefix(
  const uint64_t & inGlobalID,
  const uint16_t subnetId,
  const uint8_t inPrefixLen,
  Inet::IPPrefix & outPrefix
)

Un utilitaire permettant de construire un préfixe de 48 bits à partir d'un globalID.

Détails

Paramètres

`[in] inGlobalID`	Référence à l'ID mondial Weave.
`[out] outPrefix`	Préfixe à initialiser.

MapAvailabilityToPriority

RoutePriority MapAvailabilityToPriority(
  Profiles::WeaveTunnel::Platform::TunnelAvailabilityMode inAvailability
)

Fonction statique qui renvoie un mappage de TunnelAvailability à RoutePriority.

Détails

Paramètres

[in] inAvailability

Mode de disponibilité du tunnel Weave.

Renvoie

Valeur mappée pour la priorité.

RecordPlatformResult

PlatformActionExecution RecordPlatformResult(
  PlatformResult inResult,
  ActionType inAction,
  bool inActionState
)

Fonction statique qui enregistre le résultat d'un appel d'action d'API de plate-forme.

Ce module envoie des requêtes pour effectuer des actions via des API spécifiques à la plate-forme. Les API doivent indiquer le résultat kPlatformResultSuccess|kPlatformResultFailure|kPlatformResultInProgress de cette demande d'action. Cette fonction enregistre ce résultat et renvoie la valeur "true" si le résultat est en cours et que d'autres actions doivent être retardées.

Détails

Paramètres

`[in] inResult`	Résultat de l'API de la plate-forme.
`[in] inAction`	Action que l'API de la plate-forme a tentée.
`[in] inActionState`	Nouvel état de l'action en cas de réussite.

Renvoie

"true", l'API de la plate-forme traite la requête de manière asynchrone. Sinon, elle est "false".

ReportActionComplete

void ReportActionComplete(
  PlatformResult inResult
)

API WARM appelée pour annoncer la fin d'un appel d'API de plate-forme asynchrone précédent.

Nous partons du principe que les API d'action de plate-forme doivent peut-être effectuer des opérations asynchrones. Si la valeur est "true", l'API de la plate-forme renvoie kPlatformResultInProgress. Dans ce cas, les nouvelles actions d'adresse et d'itinéraire sont suspendues jusqu'à ce que le système appelle ReportActionComplete pour annoncer que l'opération est terminée.

Détails

Paramètres

[in] inResult

Résultat de l'action en attente. Doit être l'un des suivants: {kPlatformResultSuccess | kPlatformResultFailure}

SetCurrentActionState

void SetCurrentActionState(
  ActionType inAction,
  bool inValue
)

Fonction statique qui définit l'état actuel d'une action spécifiée.

Détails

Paramètres

`[in] inAction`	Type d'action à modifier.
`[in] inValue`	La nouvelle valeur State à adopter.

SetSystemFeatureState

bool SetSystemFeatureState(
  SystemFeatureType inSystemFeature,
  bool inValue
)

Fonction statique qui définit l'état actuel de la fonctionnalité système.

Détails

Paramètres

`[in] inSystemFeature`	Élément système à définir.
`[in] inValue`	La nouvelle valeur State à adopter.

Renvoie

"true" si la fonctionnalité système a été modifiée, "false" dans le cas contraire.

ShouldPerformAction

bool ShouldPerformAction(
  ActionType inAction,
  FlagsType inNecessarySystemFeatureState,
  bool & outActivate
)

Fonction statique qui détermine si l'action spécifiée doit être effectuée.

Cette fonction examine la condition des indicateurs d'état des fonctionnalités système et détermine si l'action spécifiée doit être activée ou désactivée. La fonction examine ensuite l'état actuel de l'action. Si celle-ci n'est pas définie sur la valeur requise par l'état de la fonctionnalité système, la fonction renvoie "true" et l'état de l'action souhaité dans outActivate.

Détails

Paramètres

`[in] inAction`	Action à interroger.
`[in] inNecessarySystemFeatureState`	Les indicateurs d'état nécessaires pour que l'action soit active.
`[out] outActivate`	État souhaité de l'action.

Renvoie

"true" si l'action n'est pas actuellement à l'état souhaité, et "false" dans le cas contraire.

SystemFeatureStateChangeHandler

void SystemFeatureStateChangeHandler(
  SystemFeatureType inSystemFeatureType,
  bool inState
)

Fonction statique qui définit l'état des fonctionnalités système et informe la plate-forme que l'état de l'événement a changé.

Appelée par l'API EventStateChange pour effectuer les opérations de réaction nécessaires.

Détails

Paramètres

`[in] inSystemFeatureType`	État qui a changé correspondant à l'API appelée.
`[in] inState`	Nouvelle valeur de l'état.

TakeActions

void TakeActions(
  void
)

Une fonction statique qui teste l'état de chaque action et effectue un appel d'API de plate-forme pour modifier l'état de l'action si nécessaire.

Cette fonction utilise MustPerformAction() pour déterminer si un état d'action doit être modifié/effectué. Si MustPerformAction() renvoie la valeur "true", la fonction appelle l'API d'action appropriée pour effectuer l'action et lui attribuer l'état souhaité. Le résultat de l'appel d'API d'action est transmis à RecordPlatformResult() et, si cette fonction renvoie la valeur "true", l'exécution de cette fonction est interrompue.

ThreadAdvertisementAction

PlatformResult ThreadAdvertisementAction(
  ActionType inAction,
  bool inActivate,
  const uint64_t & inGlobalId,
  const uint64_t & inInterfaceId
)

L'une des méthodes Action.

Définit l'état de l'annonce Thread

Détails

Paramètres

`[in] inAction`	Type d'action.
`[in] inActivate`	État souhaité "true" == activer, false == désactiver.
`[in] inGlobalId`	Référence à l'ID Weave Global s'il est nécessaire pour calculer une adresse.
`[in] inInterfaceId`	Référence à l'ID d'interface de l'appareil si celle-ci est nécessaire pour calculer une adresse.

Renvoie

Transfère le résultat à partir de Platform::ThreadPublicité().

ThreadHostAddressAction

PlatformResult ThreadHostAddressAction(
  ActionType inAction,
  bool inActivate,
  const uint64_t & inGlobalId,
  const uint64_t & inInterfaceId
)

L'une des méthodes Action.

Définit l'adresse de l'hôte pour l'interface Thread.

Détails

Paramètres

`[in] inAction`	Type d'action.
`[in] inActivate`	État souhaité "true" == activer, false == désactiver.
`[in] inGlobalId`	Référence à l'ID Weave Global s'il est nécessaire pour calculer une adresse.
`[in] inInterfaceId`	Référence à l'ID d'interface de l'appareil si celle-ci est nécessaire pour calculer une adresse.

Renvoie

Transfère le résultat à partir de Platform::HostAddress().

ThreadHostRouteAction

PlatformResult ThreadHostRouteAction(
  ActionType inAction,
  bool inActivate,
  const uint64_t & inGlobalId,
  const uint64_t & inInterfaceId
)

L'une des méthodes Action.

Définit la route hôte pour l'interface Thread.

Détails

Paramètres

`[in] inAction`	Type d'action.
`[in] inActivate`	État souhaité "true" == activer, false == désactiver.
`[in] inGlobalId`	Référence à l'ID Weave Global s'il est nécessaire pour calculer une adresse.
`[in] inInterfaceId`	Référence à l'ID d'interface de l'appareil si celle-ci est nécessaire pour calculer une adresse.

Renvoie

Transfère le résultat à partir de Platform::HostRoute().

ThreadInterfaceStateChange

void ThreadInterfaceStateChange(
  InterfaceState inState
)

API WARM appelée pour annoncer un changement d'état de l'interface Thread.

Détails

Paramètres

[in] inState

kInterfaceStateUp si l'interface Thread est active, kInterfaceStateDown dans le cas contraire.

ThreadRoutePriorityAction

PlatformResult ThreadRoutePriorityAction(
  ActionType inAction,
  bool inActivate,
  const uint64_t & inGlobalId,
  const uint64_t & inInterfaceId
)

L'une des méthodes Action.

Définit la priorité des routes des threads en fonction de la disponibilité du tunnel.

Détails

Paramètres

`[in] inAction`	Type d'action.
`[in] inActivate`	État souhaité "true" == activer, false == désactiver.
`[in] inGlobalId`	Référence à l'ID Weave Global s'il est nécessaire pour calculer une adresse.
`[in] inInterfaceId`	Référence à l'ID d'interface de l'appareil si celle-ci est nécessaire pour calculer une adresse.

Renvoie

Transfère le résultat à partir de Platform::ThreadRoutePriority().

ThreadRoutingStateChange

void ThreadRoutingStateChange(
  InterfaceState inState
)

API WARM appelée pour annoncer un changement d'état de la fonctionnalité de routage de threads.

Détails

Paramètres

[in] inState

kInterfaceStateUp si la fonctionnalité de routage Thread est activée, kInterfaceStateDown dans le cas contraire.

ThreadThreadAddressAction

PlatformResult ThreadThreadAddressAction(
  ActionType inAction,
  bool inActivate,
  const uint64_t & inGlobalId,
  const uint64_t & inInterfaceId
)

L'une des méthodes Action.

Définit l'adresse Thread pour l'interface Thread.

Détails

Paramètres

`[in] inAction`	Type d'action.
`[in] inActivate`	État souhaité "true" == activer, false == désactiver.
`[in] inGlobalId`	Référence à l'ID Weave Global s'il est nécessaire pour calculer une adresse.
`[in] inInterfaceId`	Référence à l'ID d'interface de l'appareil si celle-ci est nécessaire pour calculer une adresse.

Renvoie

Transfère le résultat à partir de Platform::ThreadAddress().

ThreadThreadRouteAction

PlatformResult ThreadThreadRouteAction(
  ActionType inAction,
  bool inActivate,
  const uint64_t & inGlobalId,
  const uint64_t & inInterfaceId
)

L'une des méthodes Action.

Définit la route des threads pour la pile de threads.

Détails

Paramètres

`[in] inAction`	Type d'action.
`[in] inActivate`	État souhaité "true" == activer, false == désactiver.
`[in] inGlobalId`	Référence à l'ID Weave Global s'il est nécessaire pour calculer une adresse.
`[in] inInterfaceId`	Référence à l'ID d'interface de l'appareil si celle-ci est nécessaire pour calculer une adresse.

Renvoie

Transfère le résultat à partir de Platform::ThreadRoute().

TunnelHostAddressAction

PlatformResult TunnelHostAddressAction(
  ActionType inAction,
  bool inActivate,
  const uint64_t & inGlobalId,
  const uint64_t & inInterfaceId
)

L'une des méthodes Action.

Définit l'adresse de l'hôte pour l'interface de tunnel.

Détails

Paramètres

`[in] inAction`	Type d'action.
`[in] inActivate`	État souhaité "true" == activer, false == désactiver.
`[in] inGlobalId`	Référence à l'ID Weave Global s'il est nécessaire pour calculer une adresse.
`[in] inInterfaceId`	Référence à l'ID d'interface de l'appareil si celle-ci est nécessaire pour calculer une adresse.

Renvoie

Transfère le résultat à partir de Platform::HostAddress().

TunnelHostRouteAction

PlatformResult TunnelHostRouteAction(
  ActionType inAction,
  bool inActivate,
  const uint64_t & inGlobalId,
  const uint64_t & inInterfaceId
)

L'une des méthodes Action.

Définit la route hôte pour l'interface de tunnel.

Détails

Paramètres

`[in] inAction`	Type d'action.
`[in] inActivate`	État souhaité "true" == activer, false == désactiver.
`[in] inGlobalId`	Référence à l'ID Weave Global s'il est nécessaire pour calculer une adresse.
`[in] inInterfaceId`	Référence à l'ID d'interface de l'appareil si celle-ci est nécessaire pour calculer une adresse.

Renvoie

Transfère le résultat à partir de Platform::HostRoute().

TunnelInterfaceStateChange

void TunnelInterfaceStateChange(
  InterfaceState inState
)

Une API WARM appelée pour annoncer un changement d'état de l'interface Weave Tunnel.

Détails

Paramètres

[in] inState

kInterfaceStateUp si l'interface Weave Tunnel est opérationnelle, et kInterfaceStateDown dans le cas contraire.

TunnelPriorityStateChange

void TunnelPriorityStateChange(
  nl::Weave::Profiles::WeaveTunnel::Platform::TunnelAvailabilityMode inAvailability
)

Une API WARM appelée pour mettre à jour la priorité du service de tunnel.

Détails

Paramètres

[in] inAvailability

Nouvelle valeur de l'état de disponibilité du tunnel.

TunnelServiceStateChange

void TunnelServiceStateChange(
  InterfaceState inState,
  nl::Weave::Profiles::WeaveTunnel::Platform::TunnelAvailabilityMode inAvailability
)

Une API WARM appelée pour annoncer un changement d'état de l'interface Weave Tunnel.

Détails

Paramètres

`[in] inState`	kInterfaceStateUp si le service de tunnel Weave est établi, kInterfaceStateDown dans le cas contraire.
`[in] inAvailability`	État de disponibilité à utiliser ultérieurement dans la configuration du tunnel.

WiFiHostAddressAction

PlatformResult WiFiHostAddressAction(
  ActionType inAction,
  bool inActivate,
  const uint64_t & inGlobalId,
  const uint64_t & inInterfaceId
)

L'une des méthodes Action.

Définit l'adresse de l'hôte pour l'interface Wi-Fi.

Détails

Paramètres

`[in] inAction`	Type d'action.
`[in] inActivate`	État souhaité "true" == activer, false == désactiver.
`[in] inGlobalId`	Référence à l'ID Weave Global s'il est nécessaire pour calculer une adresse.
`[in] inInterfaceId`	Référence à l'ID d'interface de l'appareil si celle-ci est nécessaire pour calculer une adresse.

Renvoie

Transfère le résultat à partir de Platform::HostAddress().

WiFiInterfaceStateChange

void WiFiInterfaceStateChange(
  InterfaceState inState
)

API WARM appelée pour annoncer un changement d'état de l'interface Wi-Fi.

Détails

Paramètres

[in] inState

kInterfaceStateUp si l'interface WiFi est active, kInterfaceStateDown dans le cas contraire.

nl::Weave::Warm

Résumé

Énumérations

Typedefs

Variables

Fonctions

Classes

Structs

Espaces de noms

Énumérations

ActionType

InitState

InterfaceState

InterfaceType

PlatformActionExecution

PlatformResult

RoutePriority

SystemFeatureType

Typedefs

ActionFunction

FlagsType

Variables

kGlobalULAPrefixLength

kLegacy6LoWPANULAAddressPrefixLength

kThreadULAAddressPrefixLength

kTunnelAddressPrefixLength

kWiFiULAAddressPrefixLength

sFabricStateDelegate

sState

Fonctions

BorderRouterStateChange

CellularInterfaceStateChange

FabricStateChange

GetCurrentActionState

GetFabricState

GetSystemFeatureState

GetULA

Init

InvokeActions

LegacyHostAddressAction

LegacyThreadAddressAction

MakePrefix

MapAvailabilityToPriority

RecordPlatformResult

ReportActionComplete

SetCurrentActionState

SetSystemFeatureState

ShouldPerformAction

SystemFeatureStateChangeHandler

TakeActions

ThreadAdvertisementAction

ThreadHostAddressAction

ThreadHostRouteAction

ThreadInterfaceStateChange

ThreadRoutePriorityAction

ThreadRoutingStateChange

ThreadThreadAddressAction

ThreadThreadRouteAction

TunnelHostAddressAction

TunnelHostRouteAction

TunnelInterfaceStateChange

TunnelPriorityStateChange

TunnelServiceStateChange

WiFiHostAddressAction

WiFiInterfaceStateChange