Servidor DNS-SD

Este módulo inclui APIs para o servidor DNS-SD.

Resumo

Enumerações
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 um tipo de consulta DNS-SD.

Typedefs
otDnssdCounters typedef
Contém os contadores do servidor DNS-SD.
otDnssdHostInfo typedef
Representa informações de um host descoberto para uma consulta DNS-SD.
otDnssdQuery typedef
void
Esse tipo opaco representa uma consulta DNS-SD.
otDnssdQuerySubscribeCallback)(void *aContext, const char *aFullName) typedef
void(*
É chamado quando uma consulta DNS-SD assina um dos seguintes itens:
otDnssdQueryUnsubscribeCallback)(void *aContext, const char *aFullName) typedef
void(*
É chamado quando uma consulta DNS-SD cancela a inscrição de uma das seguintes opções:
otDnssdServiceInstanceInfo typedef
Representa informações de uma instância de serviço descoberta para uma consulta DNS-SD.

remotas
otDnssdGetCounters(otInstance *aInstance)
const otDnssdCounters *
Retorna os contadores do servidor DNS-SD.
otDnssdGetNextQuery(otInstance *aInstance, const otDnssdQuery *aQuery)
const otDnssdQuery *
Recebe a próxima consulta no servidor DNS-SD.
otDnssdGetQueryTypeAndName(const otDnssdQuery *aQuery, char(*) aNameOutput[OT_DNS_MAX_NAME_SIZE])
Recebe o tipo e o nome de consulta DNS-SD para uma consulta específica.
otDnssdQueryHandleDiscoveredHost(otInstance *aInstance, const char *aHostFullName, otDnssdHostInfo *aHostInfo)
void
Notifica um host descoberto.
otDnssdQueryHandleDiscoveredServiceInstance(otInstance *aInstance, const char *aServiceFullName, otDnssdServiceInstanceInfo *aInstanceInfo)
void
Notifica uma instância de serviço descoberta.
otDnssdQuerySetCallbacks(otInstance *aInstance, otDnssdQuerySubscribeCallback aSubscribe, otDnssdQueryUnsubscribeCallback aUnsubscribe, void *aContext)
void
Define callbacks de consulta do servidor DNS-SD.
otDnssdUpstreamQueryIsEnabled(otInstance *aInstance)
bool
Retorna se o servidor DNSSD irá encaminhar consultas DNS para a API de upstream de DNS da plataforma.
otDnssdUpstreamQuerySetEnabled(otInstance *aInstance, bool aEnabled)
void
Ativar ou desativar o encaminhamento de consultas DNS para a API upstream de DNS da plataforma.

Estruturas
otDnssdCounters

Contém os contadores do servidor DNS-SD.

otDnssdHostInfo

Representa informações de um host descoberto para uma consulta DNS-SD.

otDnssdServiceInstanceInfo

Representa informações de uma instância de serviço descoberta para uma consulta DNS-SD.

Enumerações

otDnssdQueryType

 otDnssdQueryType

Especifica um tipo de consulta DNS-SD.

Propriedades
OT_DNSSD_QUERY_TYPE_BROWSE

Serviço de navegação de tipo de serviço.

OT_DNSSD_QUERY_TYPE_NONE

Tipo de serviço não especificado.

OT_DNSSD_QUERY_TYPE_RESOLVE

O tipo de serviço resolve a instância de serviço.

OT_DNSSD_QUERY_TYPE_RESOLVE_HOST

O tipo de serviço resolve o nome do host.

Typedefs

otDnssdCounters

struct otDnssdCounters otDnssdCounters

Contém os contadores do servidor DNS-SD.

otDnssdHostInfo

struct otDnssdHostInfo otDnssdHostInfo

Representa informações de um host descoberto para uma consulta DNS-SD.

otDnssdQuery

void otDnssdQuery

Esse tipo opaco representa uma consulta DNS-SD.

otDnssdQuerySubscribeCallback

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

É chamado quando uma consulta DNS-SD assina um dos seguintes itens:

  1. um nome de serviço.
  2. um nome de instância de serviço.
  3. um nome de host.

A implementação da consulta DNS-SD é responsável por identificar o que é aFullName. Se aFullName for um nome de serviço ou de instância de serviço, a implementação da consulta DNS-SD deverá descobrir as informações correspondentes da instância de serviço e notificar o servidor DNS-SD usando otDnssdQueryHandleDiscoveredServiceInstance. Se aFullName for um nome de host, a implementação da consulta DNS-SD deverá descobrir as informações do host e notificar o servidor DNS-SD usando otDnssdQueryHandleDiscoveredHost.

Detalhes
Parâmetros
[in] aContext
Um ponteiro para o contexto específico do aplicativo.
[in] aFullName
O nome completo do serviço com terminação nula (por exemplo, "_ipps._tcp.default.service.arpa."), ou o nome completo da instância de serviço (por exemplo, "OpenThread._ipps._tcp.default.service.arpa.") ou o nome de host completo (por exemplo, "ot-host.default.service.arpa.").
Consulte também:
otDnssdQueryHandleDiscoveredServiceInstance
otDnssdQueryHandleDiscoveredHost

otDnssdQueryUnsubscribeCallback

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

É chamado quando uma consulta DNS-SD cancela a inscrição de uma das seguintes opções:

  1. um nome de serviço.
  2. um nome de instância de serviço.
  3. um nome de host.

A implementação da consulta DNS-SD é responsável por identificar o que é aFullName.

Detalhes
Parâmetros
[in] aContext
Um ponteiro para o contexto específico do aplicativo.
[in] aFullName
O nome completo do serviço com terminação nula (por exemplo, "_ipps._tcp.default.service.arpa.") ou o nome completo da instância de serviço (por exemplo, "OpenThread._ipps._tcp.default.service.arpa.").

otDnssdServiceInstanceInfo

struct otDnssdServiceInstanceInfo otDnssdServiceInstanceInfo

Representa informações de uma instância de serviço descoberta para uma consulta DNS-SD.

remotas

otDnssdGetCounters

const otDnssdCounters * otDnssdGetCounters(
  otInstance *aInstance
)

Retorna os contadores do servidor DNS-SD.

Detalhes
Parâmetros
[in] aInstance
A estrutura da instância do OpenThread.
Retorna
Um ponteiro para os contadores do servidor DNS-SD.

otDnssdGetNextQuery

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

Recebe a próxima consulta no servidor DNS-SD.

Detalhes
Parâmetros
[in] aInstance
A estrutura da instância do OpenThread.
[in] aQuery
O ponteiro da consulta. Transmita NULL para receber a primeira consulta.
Retorna
Um ponteiro para a consulta ou NULL se não houver mais consultas.

otDnssdGetQueryTypeAndName

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

Recebe o tipo e o nome de consulta DNS-SD para uma consulta específica.

Detalhes
Parâmetros
[in] aQuery
O ponteiro de consulta adquirido de otDnssdGetNextQuery.
[out] aNameOutput
O buffer de saída de nome, que precisa ter OT_DNS_MAX_NAME_SIZE bytes.
Retorna
O tipo de consulta DNS-SD.

otDnssdQueryHandleDiscoveredHost

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

Notifica um host descoberto.

O resolvedor de consultas externas (por exemplo, o Discovery Proxy) deve chamar essa função para notificar o núcleo do OpenThread dos hosts inscritos.

Detalhes
Parâmetros
[in] aInstance
A estrutura da instância do OpenThread.
[in] aHostFullName
O nome do host completo terminado em nulo.
[in] aHostInfo
Um ponteiro para as informações da instância de serviço descoberta.

otDnssdQueryHandleDiscoveredServiceInstance

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

Notifica uma instância de serviço descoberta.

O resolvedor de consultas externas (por exemplo, o Discovery Proxy) deve chamar essa função para notificar o núcleo do OpenThread dos serviços ou instâncias de serviço inscritos.

Detalhes
Parâmetros
[in] aInstance
A estrutura da instância do OpenThread.
[in] aServiceFullName
O nome do serviço completo terminado em nulo.
[in] aInstanceInfo
Um ponteiro para as informações da instância de serviço descoberta.

otDnssdQuerySetCallbacks

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

Define callbacks de consulta do servidor DNS-SD.

O servidor DNS-SD chama aSubscribe para se inscrever em uma instância de serviço ou serviço e resolver uma consulta DNS-SD, e aUnsubscribe para cancelar a inscrição quando a consulta é resolvida ou o tempo limite.

Detalhes
Parâmetros
[in] aInstance
A estrutura da instância do OpenThread.
[in] aSubscribe
Um ponteiro para a função de callback para inscrever uma instância ou um serviço.
[in] aUnsubscribe
Um ponteiro para a função de callback para cancelar a inscrição de um serviço ou instância de serviço.
[in] aContext
Um ponteiro para o contexto específico do aplicativo.

otDnssdUpstreamQueryIsEnabled

bool otDnssdUpstreamQueryIsEnabled(
  otInstance *aInstance
)

Retorna se o servidor DNSSD irá encaminhar consultas DNS para a API de upstream de DNS da plataforma.

Disponível quando o OPENTHREAD_CONFIG_DNS_UPSTREAM_QUERY_ENABLE estiver ativado.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
Valores de retorno
TRUE
Se o servidor DNSSD encaminha as consultas DNS.
FALSE
Se o servidor DNSSD não encaminhar consultas DNS.
Consulte também:
otDnssdUpstreamQuerySetEnabled

otDnssdUpstreamQuerySetEnabled

void otDnssdUpstreamQuerySetEnabled(
  otInstance *aInstance,
  bool aEnabled
)

Ativar ou desativar o encaminhamento de consultas DNS para a API upstream de DNS da plataforma.

Disponível quando o OPENTHREAD_CONFIG_DNS_UPSTREAM_QUERY_ENABLE estiver ativado.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
[in] aEnabled
Um booleano para ativar/desativar o encaminhamento de consultas DNS para upstream.
Consulte também:
otPlatDnsStartUpstreamQuery
otPlatDnsCancelUpstreamQuery
otPlatDnsUpstreamQueryDone

Recursos

Os tópicos de Referência da API OpenThread são originados do código-fonte, disponível no GitHub. Para mais informações ou para contribuir com nossa documentação, consulte Recursos.