Serveur DNS-SD

Ce module contient les API pour le serveur DNS-SD.

Résumé

Énumérations

otDnssdQueryType{
  OT_DNSSD_QUERY_TYPE_NONE = 0,
  OT_DNSSD_QUERY_TYPE_BROWSE = 1,
  OT_DNSSD_QUERY_TYPE_RESOLVE = 2,
  OT_DNSSD_QUERY_TYPE_RESOLVE_HOST = 3
}
enum
Cette énumération spécifie un type de requête DNS-SD.

Définitions

otDnssdCounters CANNOT TRANSLATE
Cette structure contient les compteurs du serveur DNS-SD.
otDnssdHostInfo CANNOT TRANSLATE
Cette structure représente les informations d'un hôte détecté pour une requête DNS-SD.
otDnssdQuery CANNOT TRANSLATE
void
Ce type opaque représente une requête DNS-SD.
otDnssdQuerySubscribeCallback)(void *aContext, const char *aFullName) CANNOT TRANSLATE
void(*
Cette fonction est appelée lorsqu'une requête DNS-SD envoie l'un des éléments suivants:
otDnssdQueryUnsubscribeCallback)(void *aContext, const char *aFullName) CANNOT TRANSLATE
void(*
Cette fonction est appelée lorsqu'une requête DNS-SD désabonne l'un des éléments suivants:
otDnssdServiceInstanceInfo CANNOT TRANSLATE
Cette structure représente les informations d'une instance de service découverte pour une requête DNS-SD.

Fonctions

otDnssdGetCounters(otInstance *aInstance)
const otDnssdCounters *
Cette fonction renvoie les compteurs du serveur DNS-SD.
otDnssdGetNextQuery(otInstance *aInstance, const otDnssdQuery *aQuery)
const otDnssdQuery *
Cette fonction acquiert la requête suivante sur le serveur DNS-SD.
otDnssdGetQueryTypeAndName(const otDnssdQuery *aQuery, char(*) aNameOutput[OT_DNS_MAX_NAME_SIZE])
Cette fonction récupère le type et le nom des requêtes DNS-SD pour une requête spécifique.
otDnssdQueryHandleDiscoveredHost(otInstance *aInstance, const char *aHostFullName, otDnssdHostInfo *aHostInfo)
void
Cette fonction notifie un hôte détecté.
otDnssdQueryHandleDiscoveredServiceInstance(otInstance *aInstance, const char *aServiceFullName, otDnssdServiceInstanceInfo *aInstanceInfo)
void
Cette fonction notifie une instance de service découverte.
otDnssdQuerySetCallbacks(otInstance *aInstance, otDnssdQuerySubscribeCallback aSubscribe, otDnssdQueryUnsubscribeCallback aUnsubscribe, void *aContext)
void
Cette fonction définit les rappels de requête du serveur DNS-SD.

Structures

otDnssdCounters

Cette structure contient les compteurs du serveur DNS-SD.

otDnssdHostInfo

Cette structure représente les informations d'un hôte détecté pour une requête DNS-SD.

otDnssdServiceInstanceInfo

Cette structure représente les informations d'une instance de service découverte pour une requête DNS-SD.

Énumérations

otDnssdQueryType (Type de requête)

 otDnssdQueryType

Cette énumération spécifie un type de requête DNS-SD.

Properties
OT_DNSSD_QUERY_TYPE_BROWSE

Service de navigation par type de service.

OT_DNSSD_QUERY_TYPE_NONE

Type de service non spécifié.

OT_DNSSD_QUERY_TYPE_RESOLVE

Le type de service résout l'instance de service.

OT_DNSSD_QUERY_TYPE_RESOLVE_HOST

Le type de service résout le nom d'hôte.

Définitions

otDnssdCounters

struct otDnssdCounters otDnssdCounters

Cette structure contient les compteurs du serveur DNS-SD.

OTDnssdHostInfo

struct otDnssdHostInfo otDnssdHostInfo

Cette structure représente les informations d'un hôte détecté pour une requête DNS-SD.

OTDnssdQuery

void otDnssdQuery

Ce type opaque représente une requête DNS-SD.

otDnssdQuerySubscribeCall

void(* otDnssdQuerySubscribeCallback)(void *aContext, const char *aFullName)

Cette fonction est appelée lorsqu'une requête DNS-SD envoie l'un des éléments suivants:

  1. un nom de service.
  2. Un nom d'instance de service.
  3. un nom d'hôte.

L'implémentation de la requête DNS-SD est chargée d'identifier ce qui est aFullName. Si aFullName est un nom de service ou un nom d'instance de service, la mise en œuvre de la requête DNS-SD doit détecter les informations d'instance de service correspondantes et avertir le serveur DNS-SD à l'aide de otDnssdQueryHandleDiscoveredServiceInstance. Si aFullName est un nom d'hôte, la mise en œuvre de la requête DNS-SD doit détecter les informations hôtes et avertir le serveur DNS-SD à l'aide de otDnssdQueryHandleDiscoveredHost.

Détails
Paramètres
[in] aContext
Un pointeur vers le contexte spécifique à l'application
[in] aFullName
Nom complet du service terminé (par exemple, "_ipps._tcp.default.service.arpa."), nom d'instance de service complet (par exemple, "OpenThread._ipps._tcp.default.service.arpa.") ou nom d'hôte complet (par exemple, "ot-host.service.ar.a.pr.)
Voir aussi :
otDnssdQueryPoignerDiscoveredServiceInstance
otDnssdQueryHandlingDiscoveredHost

otDnssdQueryUnsubscribeCallback

void(* otDnssdQueryUnsubscribeCallback)(void *aContext, const char *aFullName)

Cette fonction est appelée lorsqu'une requête DNS-SD désabonne l'un des éléments suivants:

  1. un nom de service.
  2. Un nom d'instance de service.
  3. un nom d'hôte.

L'implémentation de la requête DNS-SD est chargée d'identifier ce qu'est aFullName.

Détails
Paramètres
[in] aContext
Un pointeur vers le contexte spécifique à l'application
[in] aFullName
Nom complet du service terminé (par exemple, "_ipps._tcp.default.service.arpa.") ou nom d'instance de service complet (par exemple &&t.;OpenThread._ipps._tcp.default.service.arpa.").

otDnssdServiceInstanceInfo

struct otDnssdServiceInstanceInfo otDnssdServiceInstanceInfo

Cette structure représente les informations d'une instance de service découverte pour une requête DNS-SD.

Fonctions

otDnssdGetCounters

const otDnssdCounters * otDnssdGetCounters(
  otInstance *aInstance
)

Cette fonction renvoie les compteurs du serveur DNS-SD.

Détails
Paramètres
[in] aInstance
Structure de l'instance OpenThread.
Renvoie
Pointeur vers les compteurs du serveur DNS-SD.

otDnssdGetNextQuery

const otDnssdQuery * otDnssdGetNextQuery(
  otInstance *aInstance,
  const otDnssdQuery *aQuery
)

Cette fonction acquiert la requête suivante sur le serveur DNS-SD.

Détails
Paramètres
[in] aInstance
Structure de l'instance OpenThread.
[in] aQuery
Pointeur de requêtes. Transmettre NULL pour obtenir la première requête.
Renvoie
Pointeur vers la requête ou valeur NULL si aucune autre requête n'est définie.

otDnssdGetQueryTypeAndName

otDnssdQueryType otDnssdGetQueryTypeAndName(
  const otDnssdQuery *aQuery,
  char(*) aNameOutput[OT_DNS_MAX_NAME_SIZE]
)

Cette fonction récupère le type et le nom des requêtes DNS-SD pour une requête spécifique.

Détails
Paramètres
[in] aQuery
Point de la requête acquis auprès de otDnssdGetNextQuery.
[out] aNameOutput
Tampon de sortie du nom, d'une longueur de OT_DNS_MAX_NAME_SIZE octets.
Renvoie
Type de requête DNS-SD.

otDnssdQueryHandlingDiscoveredHost

void otDnssdQueryHandleDiscoveredHost(
  otInstance *aInstance,
  const char *aHostFullName,
  otDnssdHostInfo *aHostInfo
)

Cette fonction notifie un hôte détecté.

Le résolveur de requêtes externe (par exemple, Proxy Proxy) doit appeler cette fonction pour avertir les cœurs OpenThread des hôtes abonnés.

Détails
Paramètres
[in] aInstance
Structure de l'instance OpenThread.
[in] aHostFullName
Nom d'hôte complet avec valeur nulle.
[in] aHostInfo
Pointeur vers les informations sur l'instance de service découverte.

otDnssdQueryHandlingDiscoveredServiceInstance

void otDnssdQueryHandleDiscoveredServiceInstance(
  otInstance *aInstance,
  const char *aServiceFullName,
  otDnssdServiceInstanceInfo *aInstanceInfo
)

Cette fonction notifie une instance de service découverte.

Le résolveur de requêtes externe (par exemple, le proxy Discovery) doit appeler cette fonction pour informer le cœur d'OpenThread des services ou instances de service abonnés.

Détails
Paramètres
[in] aInstance
Structure de l'instance OpenThread.
[in] aServiceFullName
Nom complet du service terminé.
[in] aInstanceInfo
Pointeur vers les informations sur l'instance de service découverte.

otDnssdQuerySetCallbacks

void otDnssdQuerySetCallbacks(
  otInstance *aInstance,
  otDnssdQuerySubscribeCallback aSubscribe,
  otDnssdQueryUnsubscribeCallback aUnsubscribe,
  void *aContext
)

Cette fonction définit les rappels de requête du serveur DNS-SD.

Le serveur DNS-SD appelle aSubscribe pour s'abonner à un service ou à une instance de service afin de résoudre une requête DNS-SD, et aUnsubscribe pour se désabonner lorsque la requête est résolue ou expire.

Détails
Paramètres
[in] aInstance
Structure de l'instance OpenThread.
[in] aSubscribe
Pointeur vers la fonction de rappel pour abonner un service ou une instance de service.
[in] aUnsubscribe
Pointeur vers la fonction de rappel permettant de désabonner un service ou une instance de service.
[in] aContext
Un pointeur vers le contexte spécifique à l'application

Resources

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