Serveur

Ce module inclut des fonctions permettant de gérer les données de réseau local avec le serveur OpenThread.

Résumé

Functions

otServerAddService(otInstance *aInstance, const otServiceConfig *aConfig)
Ajoutez une configuration de service aux données du réseau local.
otServerGetNetDataLocal(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 de threads locales.
otServerGetNextService(otInstance *aInstance, otNetworkDataIterator *aIterator, otServiceConfig *aConfig)
Cette fonction obtient le service suivant dans les données réseau locales.
otServerRegister(otInstance *aInstance)
Enregistrez immédiatement les données du réseau local auprès du responsable.
otServerRemoveService(otInstance *aInstance, uint32_t aEnterpriseNumber, const uint8_t *aServiceData, uint8_t aServiceDataLength)
Supprimez une configuration de service des données du réseau local.

Functions

otServerAddService

otError otServerAddService(
  otInstance *aInstance,
  const otServiceConfig *aConfig
)

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

Détails
Paramètres
[in] aInstance
Pointeur vers une instance OpenThread.
[in] aConfig
Pointeur vers la configuration du service.
Valeurs renvoyées
OT_ERROR_NONE
La configuration a bien été ajoutée aux données du réseau local.
OT_ERROR_INVALID_ARGS
Un ou plusieurs paramètres de configuration ne sont pas valides.
OT_ERROR_NO_BUFS
L'espace disponible est insuffisant pour ajouter la configuration aux données du réseau local.
Voir également:
otServerRemoveService
otServerRegister

otServerGetNetDataLocal

otError otServerGetNetDataLocal(
  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 de threads locales.

Détails
Paramètres
[in] aInstance
Pointeur vers une instance OpenThread.
[in] aStable
TRUE lors de la copie de la version stable, FALSE lors de la copie de la version complète.
[out] aData
Pointeur vers le tampon de données.
[in,out] aDataLength
À l'entrée, taille du tampon de données vers laquelle pointe aData. À la sortie, nombre d'octets copiés.

otServerGetNextService

otError otServerGetNextService(
  otInstance *aInstance,
  otNetworkDataIterator *aIterator,
  otServiceConfig *aConfig
)

Cette fonction obtient le service suivant dans les données réseau locales.

Détails
Paramètres
[in] aInstance
Pointeur vers une instance OpenThread.
[in,out] aIterator
Pointeur vers le contexte de l'itérateur de données réseau. Pour obtenir la première entrée de service, elle doit être définie sur OT_NETWORK_DATA_ITERATOR_INIT.
[out] aConfig
Pointeur vers l'emplacement des informations de service.
Valeurs renvoyées
OT_ERROR_NONE
Le service suivant a bien été trouvé.
OT_ERROR_NOT_FOUND
Aucun service ultérieur n'existe dans les données du réseau de threads.

OtServerRegister

otError otServerRegister(
  otInstance *aInstance
)

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

Détails
Paramètres
[in] aInstance
Pointeur vers une instance OpenThread.
Valeurs renvoyées
OT_ERROR_NONE
Le message de demande de données du serveur a bien été mis en file d'attente en vue de sa distribution.
Voir également:
otServerAddService
otServerRemoveService

otServerRemoveService

otError otServerRemoveService(
  otInstance *aInstance,
  uint32_t aEnterpriseNumber,
  const uint8_t *aServiceData,
  uint8_t aServiceDataLength
)

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

Détails
Paramètres
[in] aInstance
Pointeur vers une instance OpenThread.
[in] aEnterpriseNumber
Numéro d'entreprise de l'entrée de service à supprimer.
[in] aServiceData
Pointeur vers des données de service à rechercher pendant la suppression.
[in] aServiceDataLength
Longueur de aServiceData en octets.
Valeurs renvoyées
OT_ERROR_NONE
La configuration a bien été supprimée des données du réseau local.
OT_ERROR_NOT_FOUND
Impossible de trouver l'entrée du routeur de bordure.
Voir également:
otServerAddService
otServerRegister

Resources

Les sujets de référence de l'API OpenThread proviennent du code source, disponible sur GitHub. Pour en savoir plus ou pour contribuer à notre documentation, consultez la page Ressources.