DNS-SD-сервер

Этот модуль включает API для сервера DNS-SD.

Краткое содержание

Перечисления
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 }	перечисление Указывает тип запроса DNS-SD.

Определения типов
otDnssdCounters	определение типа struct otDnssdCounters Содержит счетчики DNS-SD сервера.
otDnssdHostInfo	определение типа struct otDnssdHostInfo Представляет информацию об обнаруженном хосте для запроса DNS-SD.
otDnssdQuery	определение типа void Этот непрозрачный тип представляет собой запрос DNS-SD.
otDnssdQuerySubscribeCallback )(void *aContext, const char *aFullName)	определение типа void(* Вызывается, когда запрос DNS-SD подписывается на одно из:
otDnssdQueryUnsubscribeCallback )(void *aContext, const char *aFullName)	определение типа void(* Вызывается, когда запрос DNS-SD отменяет подписку на одно из:
otDnssdServiceInstanceInfo	определение типа struct otDnssdServiceInstanceInfo Представляет информацию об обнаруженном экземпляре службы для запроса DNS-SD.

Функции
otDnssdGetCounters ( otInstance *aInstance)	const otDnssdCounters * Возвращает счетчики DNS-SD-сервера.
otDnssdGetNextQuery ( otInstance *aInstance, const otDnssdQuery *aQuery)	const otDnssdQuery * Получает следующий запрос на сервере DNS-SD.
otDnssdGetQueryTypeAndName (const otDnssdQuery *aQuery, char(*) aNameOutput[OT_DNS_MAX_NAME_SIZE])	otDnssdQueryType Получает тип и имя запроса DNS-SD для конкретного запроса.
otDnssdQueryHandleDiscoveredHost ( otInstance *aInstance, const char *aHostFullName, otDnssdHostInfo *aHostInfo)	void Уведомляет обнаруженный хост.
otDnssdQueryHandleDiscoveredServiceInstance ( otInstance *aInstance, const char *aServiceFullName, otDnssdServiceInstanceInfo *aInstanceInfo)	void Уведомляет обнаруженный экземпляр службы.
otDnssdQuerySetCallbacks ( otInstance *aInstance, otDnssdQuerySubscribeCallback aSubscribe, otDnssdQueryUnsubscribeCallback aUnsubscribe, void *aContext)	void Устанавливает обратные вызовы запроса сервера DNS-SD.
otDnssdUpstreamQueryIsEnabled ( otInstance *aInstance)	bool Возвращает, будет ли сервер DNSSD пересылать DNS-запросы в восходящий API DNS платформы.
otDnssdUpstreamQuerySetEnabled ( otInstance *aInstance, bool aEnabled)	void Включите или отключите пересылку DNS-запросов в восходящий API DNS платформы.

Структуры
otDnssdCounters	Содержит счетчики DNS-SD сервера.
отДнссдХостИнфо	Представляет информацию об обнаруженном хосте для запроса DNS-SD.
отднссдсервицеинстанцеинфо	Представляет информацию об обнаруженном экземпляре службы для запроса DNS-SD.

Перечисления

отДнссдкуеритипе

 otDnssdQueryType

Указывает тип запроса DNS-SD.

Характеристики
OT_DNSSD_QUERY_TYPE_BROWSE	Тип службы: просмотр службы.
OT_DNSSD_QUERY_TYPE_NONE	Тип услуги не указан.
OT_DNSSD_QUERY_TYPE_RESOLVE	Тип службы определяет экземпляр службы.
OT_DNSSD_QUERY_TYPE_RESOLVE_HOST	Тип службы разрешает имя хоста.

Определения типов

otDnssdCounters

struct otDnssdCounters otDnssdCounters

Содержит счетчики DNS-SD сервера.

отДнссдХостИнфо

struct otDnssdHostInfo otDnssdHostInfo

Представляет информацию об обнаруженном хосте для запроса DNS-SD.

отднссдкуери

void otDnssdQuery

Этот непрозрачный тип представляет собой запрос DNS-SD.

otDnssdQuerySubscribeCallback

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

Вызывается, когда запрос DNS-SD подписывается на одно из:

1. имя службы.
2. имя экземпляра службы.
3. имя хоста.

Реализация запроса DNS-SD отвечает за определение того, что такое aFullName . Если aFullName — это имя службы или имя экземпляра службы, реализация запроса DNS-SD должна обнаружить соответствующую информацию об экземпляре службы и уведомить сервер DNS-SD с помощью otDnssdQueryHandleDiscoveredServiceInstance . Если aFullName — это имя хоста, реализация запроса DNS-SD должна обнаружить информацию об хосте и уведомить сервер DNS-SD с помощью otDnssdQueryHandleDiscoveredHost .

Примечание. На одно и то же имя может быть несколько подписок. Реализация запроса DNS-SD должна записывать количество активных подписок и перестать уведомлять, когда для aFullName нет активной подписки.

Подробности
Параметры	[in] aContext Указатель на контекст конкретного приложения. [in] aFullName Полное имя службы, завершающееся нулем (например, "_ipps._tcp.default.service.arpa"), или полное имя экземпляра службы (например, "OpenThread._ipps._tcp.default.service.arpa"), или полное имя хоста. (например, «ot-host.default.service.arpa».).

Смотрите также:
отднссдкуерихандледисковерсервицеинстанце
отднссдкуериехандледисковередхост

otDnssdQueryUnsubscribeCallback

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

Вызывается, когда запрос DNS-SD отменяет подписку на одно из:

1. имя службы.
2. имя экземпляра службы.
3. имя хоста.

Реализация запроса DNS-SD отвечает за определение того, что такое aFullName .

Примечание. На одно и то же имя может быть несколько подписок. Реализация запроса DNS-SD должна записывать количество активных подписок и перестать уведомлять, когда для aFullName нет активной подписки.

Подробности
Параметры	[in] aContext Указатель на контекст конкретного приложения. [in] aFullName Полное имя службы, завершающееся нулем (например, "_ipps._tcp.default.service.arpa") или полное имя экземпляра службы (например, "OpenThread._ipps._tcp.default.service.arpa").

отднссдсервицеинстанцеинфо

struct otDnssdServiceInstanceInfo otDnssdServiceInstanceInfo

Представляет информацию об обнаруженном экземпляре службы для запроса DNS-SD.

Функции

отднссджеткаунтерс

const otDnssdCounters * otDnssdGetCounters(
  otInstance *aInstance
)

Возвращает счетчики DNS-SD-сервера.

Подробности
Параметры	[in] aInstance Структура экземпляра OpenThread.
Возврат	Указатель на счетчики DNS-SD-сервера.

отднссджетнексткуери

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

Получает следующий запрос на сервере DNS-SD.

Подробности
Параметры	[in] aInstance Структура экземпляра OpenThread. [in] aQuery Указатель запроса. Передайте NULL, чтобы получить первый запрос.
Возврат	Указатель на запрос или NULL, если запросов больше нет.

отднссджеткуеритипеандаме

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

Получает тип и имя запроса DNS-SD для конкретного запроса.

Подробности
Параметры	[in] aQuery Указатель запроса, полученный из otDnssdGetNextQuery . [out] aNameOutput Буфер вывода имени, длина которого должна составлять OT_DNS_MAX_NAME_SIZE байт.
Возврат	Тип запроса DNS-SD.

отднссдкуериехандледисковередхост

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

Уведомляет обнаруженный хост.

Внешний преобразователь запросов (например, прокси-сервер обнаружения) должен вызвать эту функцию, чтобы уведомить ядро ​​OpenThread о подписанных хостах.

Примечание. aHostInfo не должен содержать неуказанные IP-адреса, локальные, петлевые или многоадресные IP-адреса.

Подробности
Параметры	[in] aInstance Структура экземпляра OpenThread. [in] aHostFullName Полное имя хоста, завершающееся нулем. [in] aHostInfo Указатель на обнаруженную информацию об экземпляре службы.

отднссдкуерихандледисковерсервицеинстанце

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

Уведомляет обнаруженный экземпляр службы.

Внешний преобразователь запросов (например, прокси-сервер обнаружения) должен вызвать эту функцию, чтобы уведомить ядро ​​OpenThread о подписанных службах или экземплярах служб.

Примечание. aInstanceInfo не должен содержать неуказанные IP-адреса, локальные, петлевые или многоадресные IP-адреса.

Подробности
Параметры	[in] aInstance Структура экземпляра OpenThread. [in] aServiceFullName Полное имя службы, завершающееся нулем. [in] aInstanceInfo Указатель на обнаруженную информацию об экземпляре службы.

отднссдкуериесетколлбэкс

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

Устанавливает обратные вызовы запроса сервера DNS-SD.

Сервер DNS-SD вызывает aSubscribe , чтобы подписаться на службу или экземпляр службы для разрешения запроса DNS-SD, и aUnsubscribe , чтобы отказаться от подписки, когда запрос решен или истекло время ожидания.

Примечание. aSubscribe и aUnsubscribe должны быть установлены или отключены.

Подробности
Параметры	[in] aInstance Структура экземпляра OpenThread. [in] aSubscribe Указатель на функцию обратного вызова для подписки на службу или экземпляр службы. [in] aUnsubscribe Указатель на функцию обратного вызова для отмены подписки на услугу или экземпляр службы. [in] aContext Указатель на контекст конкретного приложения.

отднссдупстримкуерисенаблед

bool otDnssdUpstreamQueryIsEnabled(
  otInstance *aInstance
)

Возвращает, будет ли сервер DNSSD пересылать DNS-запросы в восходящий API DNS платформы.

Доступно, если включен OPENTHREAD_CONFIG_DNS_UPSTREAM_QUERY_ENABLE .

Подробности
Параметры	[in] aInstance Указатель на экземпляр OpenThread.
Возвращаемые значения	TRUE Если сервер DNSSD будет пересылать DNS-запросы. FALSE Если сервер DNSSD не будет пересылать DNS-запросы.

Смотрите также:
отднссдупстримекуериесенаблед

отднссдупстримекуериесенаблед

void otDnssdUpstreamQuerySetEnabled(
  otInstance *aInstance,
  bool aEnabled
)

Включите или отключите пересылку DNS-запросов в восходящий API DNS платформы.

Доступно, если включен OPENTHREAD_CONFIG_DNS_UPSTREAM_QUERY_ENABLE .

Подробности
Параметры	[in] aInstance Указатель на экземпляр OpenThread. [in] aEnabled Логическое значение для включения/выключения пересылки DNS-запросов в восходящий поток.

Смотрите также:
отПлатДнсстартупстримкуери
отПлатДнсканселапстримкуери
отПлатДнсупстримкуеридоне

Ресурсы

Справочные разделы API OpenThread взяты из исходного кода, доступного на GitHub . Для получения дополнительной информации или внесения вклада в нашу документацию обратитесь к Ресурсам .