Servidor DNS-SD

Este módulo incluye API para el servidor DNS-SD.

Resumen

Enumeraciones
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
Especifica un tipo de consulta de DNS-SD.

Typedefs
otDnssdCounters typedef
Contiene los contadores del servidor DNS-SD.
otDnssdHostInfo typedef
Representa la información de un host detectado para una consulta de DNS-SD.
otDnssdQuery typedef
void
Este tipo opaco representa una consulta de DNS-SD.
otDnssdQuerySubscribeCallback)(void *aContext, const char *aFullName) typedef
void(*
Se llama cuando una consulta de DNS-SD se suscribe a una de las siguientes opciones:
otDnssdQueryUnsubscribeCallback)(void *aContext, const char *aFullName) typedef
void(*
Se llama cuando una consulta de DNS-SD anula una de las siguientes opciones:
otDnssdServiceInstanceInfo typedef
Representa la información de una instancia de servicio detectada para una consulta de DNS-SD.

remotas
otDnssdGetCounters(otInstance *aInstance)
const otDnssdCounters *
Muestra los contadores del servidor DNS-SD.
otDnssdGetNextQuery(otInstance *aInstance, const otDnssdQuery *aQuery)
const otDnssdQuery *
Adquiere la siguiente consulta en el servidor DNS-SD.
otDnssdGetQueryTypeAndName(const otDnssdQuery *aQuery, char(*) aNameOutput[OT_DNS_MAX_NAME_SIZE])
Adquiere el tipo de consulta de DNS-SD y el nombre de una consulta específica.
otDnssdQueryHandleDiscoveredHost(otInstance *aInstance, const char *aHostFullName, otDnssdHostInfo *aHostInfo)
void
Notifica a un host detectado.
otDnssdQueryHandleDiscoveredServiceInstance(otInstance *aInstance, const char *aServiceFullName, otDnssdServiceInstanceInfo *aInstanceInfo)
void
Notifica una instancia de servicio detectada.
otDnssdQuerySetCallbacks(otInstance *aInstance, otDnssdQuerySubscribeCallback aSubscribe, otDnssdQueryUnsubscribeCallback aUnsubscribe, void *aContext)
void
Establece devoluciones de llamada de consulta del servidor DNS-SD.
otDnssdUpstreamQueryIsEnabled(otInstance *aInstance)
bool
Muestra si el servidor DNSSD reenviará consultas de DNS a la API ascendente de DNS de la plataforma.
otDnssdUpstreamQuerySetEnabled(otInstance *aInstance, bool aEnabled)
void
Habilita o inhabilita el reenvío de consultas de DNS a la API ascendente de DNS de la plataforma.

Structs
otDnssdCounters

Contiene los contadores del servidor DNS-SD.

otDnssdHostInfo

Representa la información de un host detectado para una consulta de DNS-SD.

otDnssdServiceInstanceInfo

Representa la información de una instancia de servicio detectada para una consulta de DNS-SD.

Enumeraciones

otDnssdQueryType

 otDnssdQueryType

Especifica un tipo de consulta de DNS-SD.

Propiedades
OT_DNSSD_QUERY_TYPE_BROWSE

Servicio de exploración de tipos de servicio.

OT_DNSSD_QUERY_TYPE_NONE

Tipo de servicio sin especificar.

OT_DNSSD_QUERY_TYPE_RESOLVE

El tipo de servicio resuelve la instancia de servicio.

OT_DNSSD_QUERY_TYPE_RESOLVE_HOST

El tipo de Service resuelve el nombre de host.

Typedefs

otDnssdCounters

struct otDnssdCounters otDnssdCounters

Contiene los contadores del servidor DNS-SD.

otDnssdHostInfo

struct otDnssdHostInfo otDnssdHostInfo

Representa la información de un host detectado para una consulta de DNS-SD.

otDnssdQuery

void otDnssdQuery

Este tipo opaco representa una consulta de DNS-SD.

otDnssdQuerySubscribeCallback

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

Se llama cuando una consulta de DNS-SD se suscribe a una de las siguientes opciones:

  1. un nombre de servicio.
  2. un nombre de instancia de servicio.
  3. un nombre de host.

La implementación de la consulta de DNS-SD es responsable de identificar qué es aFullName. Si aFullName es un nombre de servicio o de instancia de servicio, la implementación de la consulta de DNS-SD debe descubrir la información de la instancia de servicio correspondiente y notificar al servidor DNS-SD mediante otDnssdQueryHandleDiscoveredServiceInstance. Si aFullName es un nombre de host, la implementación de la consulta de DNS-SD debe descubrir la información del host y notificar al servidor DNS-SD mediante otDnssdQueryHandleDiscoveredHost.

Detalles
Parámetros
[in] aContext
Un puntero al contexto específico de la aplicación.
[in] aFullName
El nombre completo del servicio terminado en valores nulos (p.ej., "_ipps._tcp.default.service.arpa."), el nombre completo de la instancia de servicio (p.ej., "OpenThread._ipps._tcp.default.service.arpa.") o el nombre completo de host (p.ej., "ot-host.default.service.arpa.").
Consulta también:
otDnssdQueryHandleDiscoveredServiceInstance
otDnssdQueryHandleDiscoveredHost

otDnssdQueryUnsubscribeCallback

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

Se llama cuando una consulta de DNS-SD anula una de las siguientes opciones:

  1. un nombre de servicio.
  2. un nombre de instancia de servicio.
  3. un nombre de host.

La implementación de consultas de DNS-SD es responsable de identificar qué es aFullName.

Detalles
Parámetros
[in] aContext
Un puntero al contexto específico de la aplicación.
[in] aFullName
El nombre completo del servicio terminado en valores nulos (p.ej., "_ipps._tcp.default.service.arpa.") o el nombre completo de la instancia de servicio (p.ej., "OpenThread._ipps._tcp.default.service.arpa.").

otDnssdServiceInstanceInfo

struct otDnssdServiceInstanceInfo otDnssdServiceInstanceInfo

Representa la información de una instancia de servicio detectada para una consulta de DNS-SD.

remotas

otDnssdGetCounters

const otDnssdCounters * otDnssdGetCounters(
  otInstance *aInstance
)

Muestra los contadores del servidor DNS-SD.

Detalles
Parámetros
[in] aInstance
Estructura de instancias de OpenThread
Qué muestra
Un puntero a los contadores del servidor DNS-SD.

otDnssdGetNextQuery

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

Adquiere la siguiente consulta en el servidor DNS-SD.

Detalles
Parámetros
[in] aInstance
Estructura de instancias de OpenThread
[in] aQuery
El puntero de consulta. Pasa NULL para obtener la primera consulta.
Qué muestra
Un puntero para la consulta o NULL si no hay más consultas.

otDnssdGetQueryTypeAndName

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

Adquiere el tipo de consulta de DNS-SD y el nombre de una consulta específica.

Detalles
Parámetros
[in] aQuery
El puntero de consulta adquirido de otDnssdGetNextQuery.
[out] aNameOutput
El búfer de salida del nombre, que debe tener OT_DNS_MAX_NAME_SIZE bytes de longitud.
Qué muestra
El tipo de consulta de DNS-SD.

otDnssdQueryHandleDiscoveredHost

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

Notifica a un host detectado.

El agente de resolución de consultas externo (p.ej., el Proxy de detección) debe llamar a esta función para notificar al núcleo de OpenThread sobre los hosts suscritos.

Detalles
Parámetros
[in] aInstance
Estructura de instancias de OpenThread
[in] aHostFullName
El nombre completo de host terminado en versión nula.
[in] aHostInfo
Un puntero para la información de la instancia de servicio detectada.

otDnssdQueryHandleDiscoveredServiceInstance

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

Notifica una instancia de servicio detectada.

El agente de resolución de consultas externo (p.ej., el Proxy de descubrimiento) debe llamar a esta función para notificar al núcleo de OpenThread sobre los servicios o las instancias de servicio suscritos.

Detalles
Parámetros
[in] aInstance
Estructura de instancias de OpenThread
[in] aServiceFullName
El nombre completo del servicio terminado en nulo.
[in] aInstanceInfo
Un puntero para la información de la instancia de servicio detectada.

otDnssdQuerySetCallbacks

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

Establece devoluciones de llamada de consulta del servidor DNS-SD.

El servidor DNS-SD llama a aSubscribe para suscribirse a un servicio o una instancia de servicio a fin de resolver una consulta de DNS-SD y a aUnsubscribe para anular la suscripción cuando se resuelve la consulta o se agota el tiempo de espera.

Detalles
Parámetros
[in] aInstance
Estructura de instancias de OpenThread
[in] aSubscribe
Un puntero a la función de devolución de llamada para suscribir un servicio o una instancia de servicio.
[in] aUnsubscribe
Un puntero a la función de devolución de llamada para anular la suscripción de un servicio o una instancia de servicio.
[in] aContext
Un puntero al contexto específico de la aplicación.

otDnssdUpstreamQueryIsEnabled

bool otDnssdUpstreamQueryIsEnabled(
  otInstance *aInstance
)

Muestra si el servidor DNSSD reenviará consultas de DNS a la API ascendente de DNS de la plataforma.

Disponible cuando se habilita OPENTHREAD_CONFIG_DNS_UPSTREAM_QUERY_ENABLE.

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.
Valores que se muestran
TRUE
Si el servidor DNSSD reenviará las consultas de DNS.
FALSE
Si el servidor DNSSD no reenviará consultas de DNS.
Consulta también:
otDnssdUpstreamQuerySetEnabled

otDnssdUpstreamQuerySetEnabled

void otDnssdUpstreamQuerySetEnabled(
  otInstance *aInstance,
  bool aEnabled
)

Habilita o inhabilita el reenvío de consultas de DNS a la API ascendente de DNS de la plataforma.

Disponible cuando se habilita OPENTHREAD_CONFIG_DNS_UPSTREAM_QUERY_ENABLE.

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.
[in] aEnabled
Un valor booleano para habilitar o inhabilitar el reenvío de consultas de DNS a upstream.
Consulta también:
otPlatDnsStartUpstreamQuery
otPlatDnsCancelUpstreamQuery
otPlatDnsUpstreamQueryDone

Recursos

Los temas de referencia de la API de OpenThread se originan a partir del código fuente, disponible en GitHub. Para obtener más información o contribuir a nuestra documentación, consulta Recursos.