Routeur frontalier

Ce module comprend des fonctions pour gérer les données du réseau local avec OpenThread Border Router.

Résumé

Les fonctions
`otBorderRouterAddOnMeshPrefix ( otInstance aInstance, const otBorderRouterConfig aConfig)`	`otError` Ajoutez une configuration de routeur de bordure aux données du réseau local.
`otBorderRouterAddRoute ( otInstance aInstance, const otExternalRouteConfig aConfig)`	`otError` Ajoutez une configuration d'itinéraire externe aux données du réseau local.
`otBorderRouterGetNetData ( otInstance aInstance, bool aStable, uint8_t aData, uint8_t *aDataLength)`	`otError` Cette méthode fournit une copie complète ou stable des données du réseau Thread local.
`otBorderRouterGetNextOnMeshPrefix ( otInstance aInstance, otNetworkDataIterator aIterator, otBorderRouterConfig *aConfig)`	`otError` Cette fonction obtient le prochain préfixe On Mesh dans les données du réseau local.
`otBorderRouterGetNextRoute ( otInstance aInstance, otNetworkDataIterator aIterator, otExternalRouteConfig *aConfig)`	`otError` Cette fonction obtient la route externe suivante dans les données du réseau local.
`otBorderRouterRegister ( otInstance *aInstance)`	`otError` Enregistrez immédiatement les données du réseau local auprès du leader.
`otBorderRouterRemoveOnMeshPrefix ( otInstance aInstance, const otIp6Prefix aPrefix)`	`otError` Supprimez une configuration de routeur de bordure des données du réseau local.
`otBorderRouterRemoveRoute ( otInstance aInstance, const otIp6Prefix aPrefix)`	`otError` Supprimez une configuration d'itinéraire externe des données du réseau local.

Les fonctions

otBorderRouterAddOnMeshPrefix

 otError otBorderRouterAddOnMeshPrefix(
  otInstance *aInstance,
  const otBorderRouterConfig *aConfig
)

Ajoutez une configuration de routeur de bordure aux données du réseau local.

Détails

Paramètres

`[in] aInstance`	Un pointeur vers une instance d'OpenThread.
`[in] aConfig`	Un pointeur vers la configuration du routeur frontalier.

Valeurs de retour

`OT_ERROR_NONE`	Ajout réussi de la configuration aux données du réseau local.
`OT_ERROR_INVALID_ARGS`	Un ou plusieurs paramètres de configuration n'étaient pas valides.
`OT_ERROR_NO_BUFS`	Il n'y a pas assez de place disponible pour ajouter la configuration aux données du réseau local.

Voir également:
otBorderRouterRemoveOnMeshPrefix
otBorderRouterRegister

otBorderRouterAddRoute

 otError otBorderRouterAddRoute(
  otInstance *aInstance,
  const otExternalRouteConfig *aConfig
)

Ajoutez une configuration d'itinéraire externe aux données du réseau local.

Détails

Paramètres

`[in] aInstance`	Un pointeur vers une instance d'OpenThread.
`[in] aConfig`	Un pointeur vers la configuration de l'itinéraire externe.

Valeurs de retour

`OT_ERROR_NONE`	Ajout réussi de la configuration aux données du réseau local.
`OT_ERROR_INVALID_ARGS`	Un ou plusieurs paramètres de configuration n'étaient pas valides.
`OT_ERROR_NO_BUFS`	Il n'y a pas assez de place disponible pour ajouter la configuration aux données du réseau local.

Voir également:
otBorderRouterRemoveRoute
otBorderRouterRegister

otBorderRouterGetNetData

 otError otBorderRouterGetNetData(
  otInstance *aInstance,
  bool aStable,
  uint8_t *aData,
  uint8_t *aDataLength
)

Cette méthode fournit une copie complète ou stable des données du réseau Thread local.

Détails

Paramètres

`[in] aInstance`	Un pointeur vers une instance d'OpenThread.
`[in] aStable`	TRUE lors de la copie de la version stable, FALSE lors de la copie de la version complète.
`[out] aData`	Un pointeur vers le tampon de données.
`[in,out] aDataLength`	A l'entrée, taille du tampon de données pointé par `aData` . A la sortie, nombre d'octets copiés.

otBorderRouterGetNextOnMeshPrefix

 otError otBorderRouterGetNextOnMeshPrefix(
  otInstance *aInstance,
  otNetworkDataIterator *aIterator,
  otBorderRouterConfig *aConfig
)

Cette fonction obtient le prochain préfixe On Mesh dans les données du réseau local.

Détails

Paramètres

`[in] aInstance`	Un pointeur vers une instance d'OpenThread.
`[in,out] aIterator`	Un pointeur vers le contexte de l'itérateur de données réseau. Pour obtenir la première entrée sur le maillage, elle doit être définie sur OT_NETWORK_DATA_ITERATOR_INIT.
`[out] aConfig`	Un pointeur vers les informations sur le préfixe de maillage.

Valeurs de retour

`OT_ERROR_NONE`	Le prochain préfixe On Mesh a été trouvé.
`OT_ERROR_NOT_FOUND`	Aucun préfixe On Mesh subséquent n'existe dans les données du réseau de threads.

otBorderRouterGetNextRoute

 otError otBorderRouterGetNextRoute(
  otInstance *aInstance,
  otNetworkDataIterator *aIterator,
  otExternalRouteConfig *aConfig
)

Cette fonction obtient la route externe suivante dans les données du réseau local.

Détails

Paramètres

`[in] aInstance`	Un pointeur vers une instance d'OpenThread.
`[in,out] aIterator`	Un pointeur vers le contexte de l'itérateur de données réseau. Pour obtenir la première entrée de route externe, elle doit être définie sur OT_NETWORK_DATA_ITERATOR_INIT.
`[out] aConfig`	Un pointeur vers les informations de l'itinéraire externe.

Valeurs de retour

`OT_ERROR_NONE`	La prochaine route externe a été trouvée avec succès.
`OT_ERROR_NOT_FOUND`	Aucune entrée de route externe ultérieure n'existe dans les données du réseau de threads.

otBorderRouterRegister

 otError otBorderRouterRegister(
  otInstance *aInstance
)

Enregistrez immédiatement les données du réseau local auprès du leader.

Détails

Paramètres

[in] aInstance

Un pointeur vers une instance d'OpenThread.

Valeurs de retour

OT_ERROR_NONE

Mise en file d'attente réussie d'un message de demande de données serveur pour la remise

Voir également:
otBorderRouterAddOnMeshPrefix
otBorderRouterRemoveOnMeshPrefix
otBorderRouterAddRoute
otBorderRouterRemoveRoute

otBorderRouterRemoveOnMeshPrefix

 otError otBorderRouterRemoveOnMeshPrefix(
  otInstance *aInstance,
  const otIp6Prefix *aPrefix
)

Supprimez une configuration de routeur de bordure des données du réseau local.

Détails

Paramètres

`[in] aInstance`	Un pointeur vers une instance d'OpenThread.
`[in] aPrefix`	Un pointeur vers un préfixe IPv6.

Valeurs de retour

`OT_ERROR_NONE`	Suppression réussie de la configuration des données du réseau local.
`OT_ERROR_NOT_FOUND`	Impossible de trouver l'entrée Border Router.

Voir également:
otBorderRouterAddOnMeshPrefix
otBorderRouterRegister

otBorderRouterRemoveRoute

 otError otBorderRouterRemoveRoute(
  otInstance *aInstance,
  const otIp6Prefix *aPrefix
)

Supprimez une configuration d'itinéraire externe des données du réseau local.

Détails

Paramètres

`[in] aInstance`	Un pointeur vers une instance d'OpenThread.
`[in] aPrefix`	Un pointeur vers un préfixe IPv6.

Valeurs de retour

`OT_ERROR_NONE`	Suppression réussie de la configuration des données du réseau local.
`OT_ERROR_NOT_FOUND`	Impossible de trouver l'entrée Border Router.

Voir également:
otBorderRouterAddRoute
otBorderRouterRegister