Serwer DNS-SD

Ten moduł zawiera interfejsy API serwera DNS-SD.

Podsumowanie

Wyliczenia

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 | typ wyliczeniowy
Określa typ zapytania DNS-SD.

Definicje typów

otDnssdCounters typedef
Zawiera liczniki serwera DNS-SD.
otDnssdHostInfo typedef
Reprezentuje informacje o wykrytym hoście dla zapytania DNS-SD.
otDnssdQuery typedef
void
Ten nieprzejrzysty typ reprezentuje zapytanie DNS-SD.
otDnssdQuerySubscribeCallback)(void *aContext, const char *aFullName) typedef
void(*
Jest wywoływane, gdy zapytanie DNS-SD subskrybuje jedno z tych elementów:
otDnssdQueryUnsubscribeCallback)(void *aContext, const char *aFullName) typedef
void(*
Jest wywoływane, gdy zapytanie DNS-SD anuluje subskrypcję:
otDnssdServiceInstanceInfo typedef
Reprezentuje informacje o wykrytej instancji usługi dla zapytania DNS-SD.

Funkcje

otDnssdGetCounters(otInstance *aInstance)
const otDnssdCounters *
Zwraca liczniki serwera DNS-SD.
otDnssdGetNextQuery(otInstance *aInstance, const otDnssdQuery *aQuery)
const otDnssdQuery *
Przetwarza następne zapytanie na serwerze DNS-SD.
otDnssdGetQueryTypeAndName(const otDnssdQuery *aQuery, char(*) aNameOutput[OT_DNS_MAX_NAME_SIZE])
Pozyskuje typ zapytania DNS-SD i nazwę konkretnego zapytania.
otDnssdQueryHandleDiscoveredHost(otInstance *aInstance, const char *aHostFullName, otDnssdHostInfo *aHostInfo)
void
Powiadamia wykrytego hosta.
otDnssdQueryHandleDiscoveredServiceInstance(otInstance *aInstance, const char *aServiceFullName, otDnssdServiceInstanceInfo *aInstanceInfo)
void
Powiadamia wykrytą instancję usługi.
otDnssdQuerySetCallbacks(otInstance *aInstance, otDnssdQuerySubscribeCallback aSubscribe, otDnssdQueryUnsubscribeCallback aUnsubscribe, void *aContext)
void
Ustawia wywołania zwrotne zapytania serwera DNS-SD.
otDnssdUpstreamQueryIsEnabled(otInstance *aInstance)
bool
Zwraca, czy serwer DNSSD przekierowuje zapytania DNS do nadrzędnego interfejsu API DNS platformy.
otDnssdUpstreamQuerySetEnabled(otInstance *aInstance, bool aEnabled)
void
Włącz lub wyłącz przekierowanie zapytań DNS do interfejsu API platformy DNS na platformie.

Konstrukcja

otDnssdCounters

Zawiera liczniki serwera DNS-SD.

otDnssdHostInfo

Reprezentuje informacje o wykrytym hoście dla zapytania DNS-SD.

otDnssdServiceInstanceInfo

Reprezentuje informacje o wykrytej instancji usługi dla zapytania DNS-SD.

Wyliczenia

otDnssdQueryType

 otDnssdQueryType

Określa typ zapytania DNS-SD.

Właściwości
OT_DNSSD_QUERY_TYPE_BROWSE

Usługa przeglądania typu usługi.

OT_DNSSD_QUERY_TYPE_NONE

Nie określono typu usługi.

OT_DNSSD_QUERY_TYPE_RESOLVE

Typ usługi rozstrzygaj instancję usługi.

OT_DNSSD_QUERY_TYPE_RESOLVE_HOST

Typ usługi jest rozpoznawany nazwę hosta.

Definicje typów

otDnssdCounters

struct otDnssdCounters otDnssdCounters

Zawiera liczniki serwera DNS-SD.

otDnssdHostInfo

struct otDnssdHostInfo otDnssdHostInfo

Reprezentuje informacje o wykrytym hoście dla zapytania DNS-SD.

otDnssdQuery

void otDnssdQuery

Ten nieprzejrzysty typ reprezentuje zapytanie DNS-SD.

otDnssdQuerySubscribeCallback

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

Jest wywoływane, gdy zapytanie DNS-SD subskrybuje jedno z tych elementów:

  1. nazwę usługi.
  2. nazwę instancji usługi.
  3. nazwę hosta.

Implementacja zapytania DNS-SD odpowiada za identyfikację aFullName. Jeśli aFullName jest nazwą usługi lub instancji usługi, implementacja zapytania DNS-SD powinna wykryć odpowiednie informacje o instancji usługi i powiadomić serwer DNS-SD za pomocą otDnssdQueryHandleDiscoveredServiceInstance. Jeśli aFullName jest nazwą hosta, implementacja zapytania DNS-SD powinna wykryć informacje o hoście i powiadomić serwer DNS-SD za pomocą otDnssdQueryHandleDiscoveredHost.

Szczegóły
Parametry
[in] aContext
Wskaźnik do kontekstu aplikacji.
[in] aFullName
Pełna nazwa usługi zakończona wartością null (np. „_ipps._tcp.default.service.arpa.”) lub pełna nazwa instancji usługi (np. „OpenThread._ipps._tcp.default.service.arpa.”) lub pełna nazwa hosta (np. „ot-host.default.service.arpa.”).
Zobacz też:
otDnssdQueryHandleDiscoveredServiceInstance
otDnssdQueryHandleDiscoveredHost

otDnssdQueryUnsubscribeCallback

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

Jest wywoływane, gdy zapytanie DNS-SD anuluje subskrypcję:

  1. nazwę usługi.
  2. nazwę instancji usługi.
  3. nazwę hosta.

Implementacja zapytań DNS-SD odpowiada za określenie, czym jest aFullName.

Szczegóły
Parametry
[in] aContext
Wskaźnik do kontekstu aplikacji.
[in] aFullName
Pełna nazwa usługi zakończona wartością null (np. „_ipps._tcp.default.service.arpa.”) lub pełna nazwa instancji usługi (np. „OpenThread._ipps._tcp.default.service.arpa.”).

otDnssdServiceInstanceInfo

struct otDnssdServiceInstanceInfo otDnssdServiceInstanceInfo

Reprezentuje informacje o wykrytej instancji usługi dla zapytania DNS-SD.

Funkcje

otDnssdGetCounters

const otDnssdCounters * otDnssdGetCounters(
  otInstance *aInstance
)

Zwraca liczniki serwera DNS-SD.

Szczegóły
Parametry
[in] aInstance
Struktura instancji OpenThread.
Zwroty
Wskaźnik do liczników serwera DNS-SD.

otDnssdGetNextQuery

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

Przetwarza następne zapytanie na serwerze DNS-SD.

Szczegóły
Parametry
[in] aInstance
Struktura instancji OpenThread.
[in] aQuery
Wskaźnik zapytania. Aby uzyskać pierwsze zapytanie, przekaż wartość NULL.
Zwroty
Wskaźnik do zapytania lub wartość NULL, jeśli nie ma więcej zapytań.

otDnssdGetQueryTypeAndName

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

Pozyskuje typ zapytania DNS-SD i nazwę konkretnego zapytania.

Szczegóły
Parametry
[in] aQuery
Wskaźnik zapytania pobrany z otDnssdGetNextQuery.
[out] aNameOutput
Bufor danych wyjściowych nazwy, który powinien mieć OT_DNS_MAX_NAME_SIZE bajtów.
Zwroty
Typ zapytania DNS-SD.

otDnssdQueryHandleDiscoveredHost

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

Powiadamia wykrytego hosta.

Zewnętrzny program do rozpoznawania zapytań (np. serwer proxy wykrywania) powinien wywoływać tę funkcję, aby powiadomić rdzeń OpenThread o subskrybowanych hostach.

Szczegóły
Parametry
[in] aInstance
Struktura instancji OpenThread.
[in] aHostFullName
Pełna nazwa hosta zakończona wartością null.
[in] aHostInfo
Wskaźnik do informacji o wykrytej instancji usługi.

otDnssdQueryHandleDiscoveredServiceInstance

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

Powiadamia wykrytą instancję usługi.

Zewnętrzny program do rozpoznawania zapytań (np. serwer proxy wykrywania) powinien wywoływać tę funkcję, aby powiadomić rdzenia OpenThread o subskrybowanych usługach lub instancjach usług.

Szczegóły
Parametry
[in] aInstance
Struktura instancji OpenThread.
[in] aServiceFullName
Pełna nazwa usługi zakończona wartością null.
[in] aInstanceInfo
Wskaźnik do informacji o wykrytej instancji usługi.

otDnssdQuerySetCallbacks

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

Ustawia wywołania zwrotne zapytania serwera DNS-SD.

Serwer DNS-SD wywołuje metodę aSubscribe, aby zasubskrybować usługę lub instancję usługi, aby rozwiązać zapytanie DNS-SD, i aUnsubscribe, aby anulować subskrypcję po zakończeniu zapytania lub po upływie limitu czasu.

Szczegóły
Parametry
[in] aInstance
Struktura instancji OpenThread.
[in] aSubscribe
Wskaźnik do funkcji wywołania zwrotnego, która umożliwia subskrybowanie usługi lub jej instancji.
[in] aUnsubscribe
Wskaźnik do funkcji wywołania zwrotnego, która umożliwia anulowanie subskrypcji usługi lub instancji usługi.
[in] aContext
Wskaźnik do kontekstu aplikacji.

otDnssdUpstreamQueryIsEnabled

bool otDnssdUpstreamQueryIsEnabled(
  otInstance *aInstance
)

Zwraca, czy serwer DNSSD przekierowuje zapytania DNS do nadrzędnego interfejsu API DNS platformy.

Dostępne, gdy włączono OPENTHREAD_CONFIG_DNS_UPSTREAM_QUERY_ENABLE.

Szczegóły
Parametry
[in] aInstance
Wskaźnik do instancji OpenThread.
Zwracane wartości
TRUE
Czy serwer DNSSD przekazuje zapytania DNS.
FALSE
Jeśli serwer DNSSD nie przekierowuje zapytań DNS:
Zobacz też:
otDnssdUpstreamQuerySetEnabled

otDnssdUpstreamQuerySetEnabled

void otDnssdUpstreamQuerySetEnabled(
  otInstance *aInstance,
  bool aEnabled
)

Włącz lub wyłącz przekierowanie zapytań DNS do interfejsu API platformy DNS na platformie.

Dostępne, gdy włączono OPENTHREAD_CONFIG_DNS_UPSTREAM_QUERY_ENABLE.

Szczegóły
Parametry
[in] aInstance
Wskaźnik do instancji OpenThread.
[in] aEnabled
Wartość logiczna służąca do włączania/wyłączania przekazywania zapytań DNS na serwer nadrzędny.
Zobacz też:
otPlatDnsStartUpstreamQuery
otPlatDnsCancelUpstreamQuery
otPlatDnsUpstreamQueryDone

Zasoby

Tematy referencyjne interfejsu OpenThread API pochodzą z kodu źródłowego dostępnego w GitHub. Aby dowiedzieć się więcej lub dołączyć do naszej dokumentacji, skorzystaj z sekcji Zasoby.