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) }	enum
`InitState{ kInitStateNotInitialized = 0 }`	enum
`InterfaceState`	enum Énumération des valeurs d'état d'interface possibles.
`InterfaceType{ kInterfaceTypeLegacy6LoWPAN = 0, kInterfaceTypeThread, kInterfaceTypeWiFi, kInterfaceTypeTunnel, kInterfaceTypeCellular }`	enum Énumération des types d'interface possibles.
`PlatformActionExecution{ kPlatformActionExecutionContinue = false, kPlatformActionExecutionSuspendForAsynchOpCompletion = true }`	enum
`PlatformResult{ kPlatformResultSuccess = 0, kPlatformResultFailure, kPlatformResultInProgress }`	enum Énumération des valeurs renvoyées par l'API de la plate-forme possibles.
`RoutePriority`	enum Énumération des priorités d'itinéraires possibles, afin qu'une route puisse être prioritaire 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) }`	enum

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`

distantes
`BorderRouterStateChange(InterfaceState inState)`	`void` Une API WARM appelée pour annoncer un changement d'état pour la fonctionnalité de routeur de bordure.
`CellularInterfaceStateChange(InterfaceState inState)`	`void` Une API WARM appelée pour annoncer un changement d'état pour l'interface mobile.
`FabricStateChange(InterfaceState inState)`	`void` Fonction appelée pour annoncer un changement d'état pour la fonctionnalité Weave Fabric.
`GetCurrentActionState(ActionType inAction)`	`bool` Une fonction statique qui renvoie l'état actuel d'une action spécifiée.
`GetFabricState(const WeaveFabricState *& outFabricState)`	`WEAVE_ERROR` Une API WARM permettant d'acquérir l'objet FabricState fourni à Warm lors de l'initialisation.
`GetSystemFeatureState(SystemFeatureType inSystemFeature)`	`bool` Fonction statique qui obtient l'état actuel d'une fonctionnalité système.
`GetULA(InterfaceType inInterfaceType, Inet::IPAddress & outAddress)`	`WEAVE_ERROR` Une API WARM permettant d'acquérir une ULA pour un type d'interface spécifié.
`Init(WeaveFabricState & inFabricState)`	`WEAVE_ERROR` Une API WARM pour effectuer une initialisation de module ponctuelle.
`InvokeActions(void)`	`void` Une 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` Il s'agit de l'une des méthodes d'action.
`LegacyThreadAddressAction(ActionType inAction, bool inActivate, const uint64_t & inGlobalId, const uint64_t & inInterfaceId)`	`PlatformResult` Il s'agit de l'une des méthodes d'action.
`MakePrefix(const uint64_t & inGlobalID, const uint16_t subnetId, const uint8_t inPrefixLen, Inet::IPPrefix & outPrefix)`	`void` Utilitaire permettant de construire un préfixe de 48 bits à partir d'un globalID.
`MapAvailabilityToPriority(Profiles::WeaveTunnel::Platform::TunnelAvailabilityMode inAvailability)`	`RoutePriority` Une fonction statique qui renvoie un mappage entre TunnelAvailability et RoutePriority.
`RecordPlatformResult(PlatformResult inResult, ActionType inAction, bool inActionState)`	`PlatformActionExecution` Fonction statique qui enregistre le résultat d'un appel d'action d'API de la plate-forme.
`ReportActionComplete(PlatformResult inResult)`	`void` Une API WARM appelée pour annoncer la fin d'un précédent appel d'API de plate-forme asynchrone.
`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 de la fonctionnalité 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 la 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` Il s'agit de l'une des méthodes d'action.
`ThreadHostAddressAction(ActionType inAction, bool inActivate, const uint64_t & inGlobalId, const uint64_t & inInterfaceId)`	`PlatformResult` Il s'agit de l'une des méthodes d'action.
`ThreadHostRouteAction(ActionType inAction, bool inActivate, const uint64_t & inGlobalId, const uint64_t & inInterfaceId)`	`PlatformResult` Il s'agit de l'une des méthodes d'action.
`ThreadInterfaceStateChange(InterfaceState inState)`	`void` Une API WARM appelée pour annoncer un changement d'état pour l'interface Thread.
`ThreadRoutePriorityAction(ActionType inAction, bool inActivate, const uint64_t & inGlobalId, const uint64_t & inInterfaceId)`	`PlatformResult` Il s'agit de l'une des méthodes d'action.
`ThreadRoutingStateChange(InterfaceState inState)`	`void` Une API WARM appelée pour annoncer un changement d'état pour la fonctionnalité de routage des threads.
`ThreadThreadAddressAction(ActionType inAction, bool inActivate, const uint64_t & inGlobalId, const uint64_t & inInterfaceId)`	`PlatformResult` Il s'agit de l'une des méthodes d'action.
`ThreadThreadRouteAction(ActionType inAction, bool inActivate, const uint64_t & inGlobalId, const uint64_t & inInterfaceId)`	`PlatformResult` Il s'agit de l'une des méthodes d'action.
`TunnelHostAddressAction(ActionType inAction, bool inActivate, const uint64_t & inGlobalId, const uint64_t & inInterfaceId)`	`PlatformResult` Il s'agit de l'une des méthodes d'action.
`TunnelHostRouteAction(ActionType inAction, bool inActivate, const uint64_t & inGlobalId, const uint64_t & inInterfaceId)`	`PlatformResult` Il s'agit de l'une des méthodes d'action.
`TunnelInterfaceStateChange(InterfaceState inState)`	`void` Une API WARM appelée pour annoncer un changement d'état pour 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 pour l'interface Weave Tunnel.
`WiFiHostAddressAction(ActionType inAction, bool inActivate, const uint64_t & inGlobalId, const uint64_t & inInterfaceId)`	`PlatformResult` Il s'agit de l'une des méthodes d'action.
`WiFiInterfaceStateChange(InterfaceState inState)`	`void` Une API WARM appelée pour annoncer un changement d'état pour l'interface Wi-Fi.

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

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

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

Énumérations

ActionType

 ActionType

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

InitState

 InitState

Propriétés
`kInitStateNotInitialized`	Sa valeur doit être 0 pour que la valeur initiale de mInitState soit kInitStateNotInitialized.

InterfaceState

 InterfaceState

Énumération des valeurs d'état d'interface possibles.

InterfaceType

 InterfaceType

Énumération des types d'interface possibles.

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

PlatformActionExecution

 PlatformActionExecution

Propriétés
`kPlatformActionExecutionContinue`	poursuivre l'exécution de l'action.
`kPlatformActionExecutionSuspendForAsynchOpCompletion`	Suspendez l'exécution de l'action pour que l'opération asynchrone puisse se terminer.

PlatformResult

 PlatformResult

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

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

RoutePriority

 RoutePriority

Énumération des priorités d'itinéraires possibles, afin qu'une route puisse être prioritaire sur une autre.

SystemFeatureType

 SystemFeatureType

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

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

distantes

BorderRouterStateChange

void BorderRouterStateChange(
  InterfaceState inState
)

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

Détails

Paramètres

[in] inState

kInterfaceStateUp si la fonctionnalité de routeur de bordure est activée, kInterfaceStateDown si ce n'est pas le cas.

CellularInterfaceStateChange

void CellularInterfaceStateChange(
  InterfaceState inState
)

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

Détails

Paramètres

[in] inState

kInterfaceStateUp si l'interface cellulaire est active, kInterfaceStateDown si ce n'est pas le cas.

FabricStateChange

void FabricStateChange(
  InterfaceState inState
)

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

Détails

Paramètres

[in] inState

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

GetCurrentActionState

bool GetCurrentActionState(
  ActionType inAction
)

Une 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" et "false" dans le cas contraire.

GetFabricState

WEAVE_ERROR GetFabricState(
  const WeaveFabricState *& outFabricState
)

Une API WARM permettant d'acquérir l'objet FabricState fourni à Warm lors de l'initialisation.

Détails

Paramètres

[out] outFabricState

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

Valeurs de retour

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

GetSystemFeatureState

bool GetSystemFeatureState(
  SystemFeatureType inSystemFeature
)

Fonction statique qui obtient l'état actuel d'une fonctionnalité système.

Détails

Paramètres

[in] inSystemFeature

Fonctionnalité système à interroger.

Renvoie

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

GetULA

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

Une 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 stocker l'ULA obtenue.

Valeurs de retour

`WEAVE_NO_ERROR`	Pour la 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
)

Une API WARM pour effectuer une initialisation de module ponctuelle.

Détails

Paramètres

[in] inFabricState

Référence à un WeaveFabricState valide.

Valeurs de retour

`WEAVE_NO_ERROR`	En cas d'initialisation réussie.
`WEAVE_ERROR_INCORRECT_STATE`	Lorsque Init est appelé plusieurs fois.
`other`	Sinon, code d'erreur.

Renvoie

WEAVE_NO_ERROR en cas de réussite, sinon, code d'erreur.

InvokeActions

void InvokeActions(
  void
)

Une 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 Thread est passée de "Désactivée" à "Activée", cette fonction effectue les appels nécessaires à la plate-forme pour attribuer l'adresse de l'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 de RequestRequestActions. L'appel de ClaimActions entraîne un ou plusieurs appels de l'API nl::Warm::Platform. Les développeurs doivent donc implémenter RequestRequestActions et l'appelant de InvokeActions() de manière appropriée. Il peut s'avérer judicieux de demander à RequestDemandeActions de publier un événement dans la tâche, qui appellera alors InvokeActions(), par exemple. À l'inverse, si le système est à thread unique, RequestRequestActions peut être implémentée pour appeler directement InvokeActions().

LegacyHostAddressAction

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

Il s'agit de l'une des méthodes d'action.

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

Détails

Paramètres

`[in] inAction`	Type d'action.
`[in] inActivate`	L'état souhaité, c'est-à-dire "true" == "activate", "false" == "désactiver".
`[in] inGlobalId`	Une référence à l'identifiant global Weave si nécessaire pour calculer une adresse.
`[in] inInterfaceId`	Référence à l'ID d'interface de l'appareil, si 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
)

Il s'agit de l'une des méthodes d'action.

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

Détails

Paramètres

`[in] inAction`	Type d'action.
`[in] inActivate`	L'état souhaité, c'est-à-dire "true" == "activate", "false" == "désactiver".
`[in] inGlobalId`	Une référence à l'identifiant global Weave si nécessaire pour calculer une adresse.
`[in] inInterfaceId`	Référence à l'ID d'interface de l'appareil, si 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
)

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

Détails

Paramètres

`[in] inGlobalID`	Une référence à l'identifiant global Weave.
`[out] outPrefix`	Préfixe à initialiser.

MapAvailabilityToPriority

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

Une fonction statique qui renvoie un mappage entre TunnelAvailability et RoutePriority.

Détails

Paramètres

[in] inAvailability

Mode de disponibilité du tunnel Weave.

Renvoie

Valeur mappée de 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 la plate-forme.

Ce module envoie des requêtes pour effectuer des actions via des API spécifiques à une plate-forme. Les API sont requises pour signaler le résultat kPlatformResultSuccess|kPlatformResultFailure|kPlatformResultInProgress de cette requête d'action. Cette fonction enregistre ce résultat et renvoie la valeur "true" si le résultat est en cours et que les 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 d'effectuer.
`[in] inActionState`	Nouvel état de l'action si le résultat a abouti.

Renvoie

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

ReportActionComplete

void ReportActionComplete(
  PlatformResult inResult
)

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

Nous partons du principe que les API d'action de plate-forme doivent effectuer des opérations asynchrones. Si c'est le cas, l'API de la plate-forme renvoie kPlatformResultInProgress. Dans ce cas, les nouvelles actions liées à l'adresse et au routage sont suspendues jusqu'à ce que le système appelle ReportActionComplete pour annoncer la fin de l'opération.

Détails

Paramètres

[in] inResult

Le 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`	Nouvelle valeur d'état à 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`	Fonction système à définir.
`[in] inValue`	Nouvelle valeur d'état à adopter.

Renvoie

"true" si la fonctionnalité système a été modifiée, ou "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 l'état 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, elle renvoie la valeur "true" et renvoie l'état de l'action souhaité dans "outActivate".

Détails

Paramètres

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

Renvoie

La valeur est "true" si l'action n'est pas à l'état souhaité. Sinon, la valeur "false" est définie.

SystemFeatureStateChangeHandler

void SystemFeatureStateChangeHandler(
  SystemFeatureType inSystemFeatureType,
  bool inState
)

Fonction statique qui définit l'état de la fonctionnalité 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 la plate-forme pour modifier l'état de l'action si nécessaire.

Cette fonction utilise DevPerformAction() pour déterminer si l'état d'une action doit être modifié ou appliqué. Si DevPerformAction() renvoie la valeur "true", la fonction appelle l'API d'action appropriée pour effectuer l'action afin de la placer dans l'état souhaité. Le résultat de l'appel de l'API Action est transmis à RecordPlatformResult(). Si cette fonction renvoie la valeur "true", son exécution est interrompue.

ThreadAdvertisementAction

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

Il s'agit de l'une des méthodes d'action.

Définit l'état de l'annonce du thread

Détails

Paramètres

`[in] inAction`	Type d'action.
`[in] inActivate`	L'état souhaité, c'est-à-dire "true" == "activate", "false" == "désactiver".
`[in] inGlobalId`	Une référence à l'identifiant global Weave si nécessaire pour calculer une adresse.
`[in] inInterfaceId`	Référence à l'ID d'interface de l'appareil, si nécessaire pour calculer une adresse.

Renvoie

Transfère le résultat de Platform::ThreadAnnonce().

ThreadHostAddressAction

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

Il s'agit de l'une des méthodes d'action.

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

Détails

Paramètres

`[in] inAction`	Type d'action.
`[in] inActivate`	L'état souhaité, c'est-à-dire "true" == "activate", "false" == "désactiver".
`[in] inGlobalId`	Une référence à l'identifiant global Weave si nécessaire pour calculer une adresse.
`[in] inInterfaceId`	Référence à l'ID d'interface de l'appareil, si 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
)

Il s'agit de l'une des méthodes d'action.

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

Détails

Paramètres

`[in] inAction`	Type d'action.
`[in] inActivate`	L'état souhaité, c'est-à-dire "true" == "activate", "false" == "désactiver".
`[in] inGlobalId`	Une référence à l'identifiant global Weave si nécessaire pour calculer une adresse.
`[in] inInterfaceId`	Référence à l'ID d'interface de l'appareil, si nécessaire pour calculer une adresse.

Renvoie

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

ThreadInterfaceStateChange

void ThreadInterfaceStateChange(
  InterfaceState inState
)

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

Détails

Paramètres

[in] inState

kInterfaceStateUp si l'interface Thread est active, kInterfaceStateDown si ce n'est pas le cas.

ThreadRoutePriorityAction

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

Il s'agit de l'une des méthodes d'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`	L'état souhaité, c'est-à-dire "true" == "activate", "false" == "désactiver".
`[in] inGlobalId`	Une référence à l'identifiant global Weave si nécessaire pour calculer une adresse.
`[in] inInterfaceId`	Référence à l'ID d'interface de l'appareil, si nécessaire pour calculer une adresse.

Renvoie

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

ThreadRoutingStateChange

void ThreadRoutingStateChange(
  InterfaceState inState
)

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

Détails

Paramètres

[in] inState

kInterfaceStateUp si la fonctionnalité de routage des threads est activée, kInterfaceStateDown si ce n'est pas le cas.

ThreadThreadAddressAction

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

Il s'agit de l'une des méthodes d'action.

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

Détails

Paramètres

`[in] inAction`	Type d'action.
`[in] inActivate`	L'état souhaité, c'est-à-dire "true" == "activate", "false" == "désactiver".
`[in] inGlobalId`	Une référence à l'identifiant global Weave si nécessaire pour calculer une adresse.
`[in] inInterfaceId`	Référence à l'ID d'interface de l'appareil, si 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
)

Il s'agit de l'une des méthodes d'action.

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

Détails

Paramètres

`[in] inAction`	Type d'action.
`[in] inActivate`	L'état souhaité, c'est-à-dire "true" == "activate", "false" == "désactiver".
`[in] inGlobalId`	Une référence à l'identifiant global Weave si nécessaire pour calculer une adresse.
`[in] inInterfaceId`	Référence à l'ID d'interface de l'appareil, si 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
)

Il s'agit de l'une des méthodes d'action.

Définit l'HostAddress pour l'interface du tunnel.

Détails

Paramètres

`[in] inAction`	Type d'action.
`[in] inActivate`	L'état souhaité, c'est-à-dire "true" == "activate", "false" == "désactiver".
`[in] inGlobalId`	Une référence à l'identifiant global Weave si nécessaire pour calculer une adresse.
`[in] inInterfaceId`	Référence à l'ID d'interface de l'appareil, si 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
)

Il s'agit de l'une des méthodes d'action.

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

Détails

Paramètres

`[in] inAction`	Type d'action.
`[in] inActivate`	L'état souhaité, c'est-à-dire "true" == "activate", "false" == "désactiver".
`[in] inGlobalId`	Une référence à l'identifiant global Weave si nécessaire pour calculer une adresse.
`[in] inInterfaceId`	Référence à l'ID d'interface de l'appareil, si nécessaire pour calculer une adresse.

Renvoie

Il 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 pour l'interface Weave Tunnel.

Détails

Paramètres

[in] inState

kInterfaceStateUp si l'interface Weave Tunnel est active, kInterfaceStateDown si ce n'est pas le cas.

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 pour l'interface Weave Tunnel.

Détails

Paramètres

`[in] inState`	kInterfaceStateUp si le service Weave Tunnel est établi, kInterfaceStateDown si ce n'est pas le cas.
`[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
)

Il s'agit de l'une des méthodes d'action.

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

Détails

Paramètres

`[in] inAction`	Type d'action.
`[in] inActivate`	L'état souhaité, c'est-à-dire "true" == "activate", "false" == "désactiver".
`[in] inGlobalId`	Une référence à l'identifiant global Weave si nécessaire pour calculer une adresse.
`[in] inInterfaceId`	Référence à l'ID d'interface de l'appareil, si nécessaire pour calculer une adresse.

Renvoie

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

WiFiInterfaceStateChange

void WiFiInterfaceStateChange(
  InterfaceState inState
)

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

Détails

Paramètres

[in] inState

kInterfaceStateUp si l'interface WiFi est active, kInterfaceStateDown si ce n'est pas le cas.

nl::Weave::Warm

Résumé

Énumérations

Typedefs

Variables

distantes

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

distantes

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