Paramètres

Ce module comprend l'abstraction de la plate-forme pour le stockage non volatile des paramètres.

Résumé

Les fonctions
`otPlatSettingsAdd ( otInstance aInstance, uint16_t aKey, const uint8_t aValue, uint16_t aValueLength)`	`otError` Ajoute une valeur à un paramètre.
`otPlatSettingsDeinit ( otInstance *aInstance)`	`void` Effectue une initialisation de-pour les paramètres sous-système, le cas échéant.
`otPlatSettingsDelete ( otInstance *aInstance, uint16_t aKey, int aIndex)`	`otError` Supprime un paramètre dans le magasin de réglage.
`otPlatSettingsGet ( otInstance aInstance, uint16_t aKey, int aIndex, uint8_t aValue, uint16_t *aValueLength)`	`otError` Récupère la valeur d'un paramètre.
`otPlatSettingsInit ( otInstance *aInstance)`	`void` Effectue toute initialisation du sous-système de paramètres, le cas échéant.
`otPlatSettingsSet ( otInstance aInstance, uint16_t aKey, const uint8_t aValue, uint16_t aValueLength)`	`otError` Définit ou remplace la valeur d'un paramètre.
`otPlatSettingsWipe ( otInstance *aInstance)`	`void` Supprime tous les paramètres du magasin de réglage.

Les fonctions

otPlatSettingsAdd

 otError otPlatSettingsAdd(
  otInstance *aInstance,
  uint16_t aKey,
  const uint8_t *aValue,
  uint16_t aValueLength
)

Ajoute une valeur à un paramètre.

Cette fonction ajoute la valeur à un paramètre identifié par aKey, sans remplacer les valeurs existantes.

Notez que la mise en œuvre sous-jacente n'est pas nécessaire de maintenir l'ordre des éléments associés à une clé spécifique. La valeur ajoutée peut être ajoutée à la fin, le début ou même quelque part au milieu. L'ordre de toutes les valeurs préexistantes peuvent également changer.

L'appel de cette fonction peut provoquer des paramètres avec succès sans lien avec plusieurs valeurs à réorganisés.

Détails

Paramètres

`[in] aInstance`	La structure de l'instance OpenThread.
`[in] aKey`	La clé associée au paramètre pour le modifier.
`[in] aValue`	Un pointeur à l'endroit où doit être lu la nouvelle valeur du paramètre de. NE DOIT PAS être NULL si aValueLength est non nul.
`[in] aValueLength`	La longueur des données pointée par aValue. Peut être nul.

valeurs de retour

`OT_ERROR_NONE`	Le réglage donné a été ajouté ou mis en scène à ajouter.
`OT_ERROR_NOT_IMPLEMENTED`	Cette fonction n'est pas implémentée sur cette plate-forme.
`OT_ERROR_NO_BUFS`	Pas d'espace restant pour enregistrer le réglage donné.

otPlatSettingsDeinit

void otPlatSettingsDeinit(
  otInstance *aInstance
)

Effectue une initialisation de-pour les paramètres sous-système, le cas échéant.

Détails

Paramètres

[in] aInstance

La structure de l'instance OpenThread.

otPlatSettingsDelete

 otError otPlatSettingsDelete(
  otInstance *aInstance,
  uint16_t aKey,
  int aIndex
)

Supprime un paramètre dans le magasin de réglage.

Cette fonction supprime une valeur spécifique du paramètre identifié par aKey à partir du magasin de paramètres.

Notez que la mise en œuvre sous-jacente n'est pas nécessaire de maintenir l'ordre des éléments associés à une clé spécifique.

Détails

Paramètres

`[in] aInstance`	La structure de l'instance OpenThread.
`[in] aKey`	La clé associée au réglage demandé.
`[in] aIndex`	L'indice de la valeur à supprimer. Si elle est définie à -1, toutes les valeurs de ce aKey seront supprimés.

valeurs de retour

`OT_ERROR_NONE`	La clé et d'index a été trouvé et enlevé avec succès.
`OT_ERROR_NOT_FOUND`	La clé donnée ou de l'indice n'a pas été trouvé dans le magasin de réglage.
`OT_ERROR_NOT_IMPLEMENTED`	Cette fonction n'est pas implémentée sur cette plate-forme.

otPlatSettingsGet

 otError otPlatSettingsGet(
  otInstance *aInstance,
  uint16_t aKey,
  int aIndex,
  uint8_t *aValue,
  uint16_t *aValueLength
)

Récupère la valeur d'un paramètre.

Cette fonction va chercher la valeur du paramètre identifié par aKey et écrire à la mémoire pointée par aValue. Il écrit alors la longueur à l'entier pointé par aValueLength. La valeur initiale de aValueLength est le nombre maximal d'octets à écrire à aValue.

Cette fonction peut être utilisée pour vérifier l'existence d'une clé sans aller chercher la valeur en réglant aValue et aValueLength à NULL. Vous pouvez également vérifier la longueur du paramètre sans aller chercher en réglant uniquement aValue à NULL.

Notez que la mise en œuvre de stockage sous-jacent n'est pas nécessaire pour maintenir l'ordre des paramètres à valeurs multiples. L'ordre de ces valeurs peuvent changer après toute opération d'écriture au magasin.

Détails

Paramètres

`[in] aInstance`	La structure de l'instance OpenThread.
`[in] aKey`	La clé associée au réglage demandé.
`[in] aIndex`	L'indice de l'élément spécifique à obtenir.
`[out] aValue`	Un pointeur à l'endroit où doit être écrit de la valeur du paramètre. Peut être à NULL si juste pour tester la présence ou la longueur d'un paramètre.
`[in,out] aValueLength`	Un pointeur sur la longueur de la valeur. Lorsqu'elle est appelée, ce pointeur doit pointer vers un entier contenant la taille de valeur maximale qui peut être écrit à aValue. Au retour, la longueur réelle du paramètre est écrit. Cela peut être NULL si effectuer une vérification de présence.

valeurs de retour

`OT_ERROR_NONE`	Le paramètre donné a été trouvé et alla chercher avec succès.
`OT_ERROR_NOT_FOUND`	Le paramètre donné n'a pas été trouvé dans le magasin de réglage.
`OT_ERROR_NOT_IMPLEMENTED`	Cette fonction n'est pas implémentée sur cette plate-forme.

otPlatSettingsInit

void otPlatSettingsInit(
  otInstance *aInstance
)

Effectue toute initialisation du sous-système de paramètres, le cas échéant.

Détails

Paramètres

[in] aInstance

La structure de l'instance OpenThread.

otPlatSettingsSet

 otError otPlatSettingsSet(
  otInstance *aInstance,
  uint16_t aKey,
  const uint8_t *aValue,
  uint16_t aValueLength
)

Définit ou remplace la valeur d'un paramètre.

Cette fonction définit ou remplace la valeur d'un paramètre identifié par aKey. S'il y avait plus d'une valeur précédemment associée à aKey, ils sont tous supprimés et remplacés par cette seule entrée.

L'appel de cette fonction peut provoquer des paramètres avec succès sans lien avec plusieurs valeurs à réorganisés.

Détails

Paramètres

`[in] aInstance`	La structure de l'instance OpenThread.
`[in] aKey`	La clé associée au paramètre pour le modifier.
`[in] aValue`	Un pointeur à l'endroit où doit être lu la nouvelle valeur du paramètre de. NE DOIT PAS être NULL si aValueLength est non nul.
`[in] aValueLength`	La longueur des données pointée par aValue. Peut être nul.

valeurs de retour

`OT_ERROR_NONE`	Le réglage donné a été modifié ou mis en scène.
`OT_ERROR_NOT_IMPLEMENTED`	Cette fonction n'est pas implémentée sur cette plate-forme.
`OT_ERROR_NO_BUFS`	Pas d'espace restant pour enregistrer le réglage donné.

otPlatSettingsWipe

void otPlatSettingsWipe(
  otInstance *aInstance
)

Supprime tous les paramètres du magasin de réglage.

Cette fonction supprime tous les paramètres du magasin de paramètres, la réinitialisation à son état d'usine initiale.

Détails

Paramètres

[in] aInstance

La structure de l'instance OpenThread.