Serveur DNS-SD

Ce module inclut des 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
Spécifie un type de requête DNS-SD.

Typedefs
otDnssdCounters typedef
Contient les compteurs du serveur DNS-SD.
otDnssdHostInfo typedef
Représente les informations d'un hôte découvert pour une requête DNS-SD.
otDnssdQuery typedef
void
Ce type opaque représente une requête DNS-SD.
otDnssdQuerySubscribeCallback)(void *aContext, const char *aFullName) typedef
void(*
Est appelée lorsqu'une requête DNS-SD abonne l'un des éléments suivants:
otDnssdQueryUnsubscribeCallback)(void *aContext, const char *aFullName) typedef
void(*
Est appelée lorsqu'une requête DNS-SD désabonne l'un des éléments suivants:
otDnssdServiceInstanceInfo typedef
Représente les informations d'une instance de service découverte pour une requête DNS-SD.

distantes
otDnssdGetCounters(otInstance *aInstance)
const otDnssdCounters *
Renvoie les compteurs du serveur DNS-SD.
otDnssdGetNextQuery(otInstance *aInstance, const otDnssdQuery *aQuery)
const otDnssdQuery *
Elle récupère la requête suivante sur le serveur DNS-SD.
otDnssdGetQueryTypeAndName(const otDnssdQuery *aQuery, char(*) aNameOutput[OT_DNS_MAX_NAME_SIZE])
Récupère le type et le nom d'une requête DNS-SD.
otDnssdQueryHandleDiscoveredHost(otInstance *aInstance, const char *aHostFullName, otDnssdHostInfo *aHostInfo)
void
Notifie un hôte découvert.
otDnssdQueryHandleDiscoveredServiceInstance(otInstance *aInstance, const char *aServiceFullName, otDnssdServiceInstanceInfo *aInstanceInfo)
void
Notifie une instance de service détectée.
otDnssdQuerySetCallbacks(otInstance *aInstance, otDnssdQuerySubscribeCallback aSubscribe, otDnssdQueryUnsubscribeCallback aUnsubscribe, void *aContext)
void
Définit les rappels de requête du serveur DNS-SD.
otDnssdUpstreamQueryIsEnabled(otInstance *aInstance)
bool
Indique si le serveur DNSSD transférera les requêtes DNS à l'API DNS en amont de la plate-forme.
otDnssdUpstreamQuerySetEnabled(otInstance *aInstance, bool aEnabled)
void
Activez ou désactivez le transfert des requêtes DNS vers l'API DNS en amont de la plate-forme.

Structs
otDnssdCounters

Contient les compteurs du serveur DNS-SD.

otDnssdHostInfo

Représente les informations d'un hôte découvert pour une requête DNS-SD.

otDnssdServiceInstanceInfo

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

Énumérations

otDnssdQueryType

 otDnssdQueryType

Spécifie un type de requête DNS-SD.

Propriétés
OT_DNSSD_QUERY_TYPE_BROWSE

Service de navigation de 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.

Typedefs

otDnssdCounters

struct otDnssdCounters otDnssdCounters

Contient les compteurs du serveur DNS-SD.

otDnssdHostInfo

struct otDnssdHostInfo otDnssdHostInfo

Représente les informations d'un hôte découvert pour une requête DNS-SD.

otDnssdQuery

void otDnssdQuery

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

otDnssdQuerySubscribeCallback

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

Est appelée lorsqu'une requête DNS-SD abonne 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 aFullName. Si aFullName est un nom de service ou un nom d'instance de service, l'implémentation 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, l'implémentation de la requête DNS-SD doit découvrir les informations sur l'hôte et avertir le serveur DNS-SD à l'aide de otDnssdQueryHandleDiscoveredHost.

Détails
Paramètres
[in] aContext
Pointeur vers le contexte spécifique à l'application.
[in] aFullName
Nom complet du service clôturé (par exemple, "_ipps._tcp.default.service.arpa.") ou nom complet de l'instance du service (par exemple, "OpenThread._ipps._tcp.default.service.arpa.") ou nom complet de l'hôte (par exemple, "ot-host.default.service.arpa.").
Voir aussi:
otDnssdQueryHandleDiscoveredServiceInstance
otDnssdQueryHandleDiscoveredHost

otDnssdQueryUnsubscribeCallback

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

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 aFullName.

Détails
Paramètres
[in] aContext
Pointeur vers le contexte spécifique à l'application.
[in] aFullName
Nom complet du service clôturé (par exemple, "_ipps._tcp.default.service.arpa.") ou nom complet de l'instance du service (par exemple, "OpenThread._ipps._tcp.default.service.arpa.").

otDnssdServiceInstanceInfo

struct otDnssdServiceInstanceInfo otDnssdServiceInstanceInfo

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

distantes

otDnssdGetCounters

const otDnssdCounters * otDnssdGetCounters(
  otInstance *aInstance
)

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
)

Elle récupère 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ête. Transmettez la valeur NULL pour obtenir la première requête.
Renvoie
Un pointeur vers la requête ou NULL s'il n'y a plus de requêtes.

otDnssdGetQueryTypeAndName

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

Récupère le type et le nom d'une requête DNS-SD.

Détails
Paramètres
[in] aQuery
Pointeur de requête acquis à partir de otDnssdGetNextQuery.
[out] aNameOutput
Nom du tampon de sortie, qui doit comporter OT_DNS_MAX_NAME_SIZE octets.
Renvoie
Type de requête DNS-SD

otDnssdQueryHandleDiscoveredHost

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

Notifie un hôte découvert.

Le résolveur de requêtes externe (par exemple, le proxy de découverte) doit appeler cette fonction pour avertir le cœur OpenThread des hôtes abonnés.

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

otDnssdQueryHandleDiscoveredServiceInstance

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

Notifie une instance de service détectée.

Le résolveur de requêtes externe (par exemple, le proxy de découverte) doit appeler cette fonction pour avertir le cœur 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 se terminant par une valeur nulle.
[in] aInstanceInfo
Pointeur vers les informations sur l'instance de service découverte.

otDnssdQuerySetCallbacks

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

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 a expiré.

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 pour désabonner un service ou une instance de service.
[in] aContext
Pointeur vers le contexte spécifique à l'application.

otDnssdUpstreamQueryIsEnabled

bool otDnssdUpstreamQueryIsEnabled(
  otInstance *aInstance
)

Indique si le serveur DNSSD transférera les requêtes DNS à l'API DNS en amont de la plate-forme.

Disponible lorsque OPENTHREAD_CONFIG_DNS_UPSTREAM_QUERY_ENABLE est activé.

Détails
Paramètres
[in] aInstance
Un pointeur vers une instance OpenThread.
Valeurs de retour
TRUE
Si le serveur DNSSD transfère les requêtes DNS.
FALSE
Si le serveur DNSSD ne transfère pas les requêtes DNS.
Voir aussi:
otDnssdUpstreamQuerySetEnabled

otDnssdUpstreamQuerySetEnabled

void otDnssdUpstreamQuerySetEnabled(
  otInstance *aInstance,
  bool aEnabled
)

Activez ou désactivez le transfert des requêtes DNS vers l'API DNS en amont de la plate-forme.

Disponible lorsque OPENTHREAD_CONFIG_DNS_UPSTREAM_QUERY_ENABLE est activé.

Détails
Paramètres
[in] aInstance
Un pointeur vers une instance OpenThread.
[in] aEnabled
Valeur booléenne permettant d'activer ou de désactiver le transfert des requêtes DNS en amont.
Voir aussi:
otPlatDnsStartUpstreamQuery
otPlatDnsCancelUpstreamQuery
otPlatDnsUpstreamQueryDone

Ressources

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 section Ressources.