Server DNS-SD

Modul ini mencakup API untuk server DNS-SD.

Ringkasan

Enumerasi
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
Menentukan jenis kueri DNS-SD.

Typedef
otDnssdCounters typedef
Berisi penghitung server DNS-SD.
otDnssdHostInfo typedef
Menampilkan informasi dari host yang ditemukan untuk kueri DNS-SD.
otDnssdQuery typedef
void
Tipe buram ini mewakili kueri DNS-SD.
otDnssdQuerySubscribeCallback)(void *aContext, const char *aFullName) typedef
void(*
Dipanggil ketika kueri DNS-SD berlangganan salah satu dari:
otDnssdQueryUnsubscribeCallback)(void *aContext, const char *aFullName) typedef
void(*
Dipanggil saat kueri DNS-SD menghentikan langganan salah satu dari:
otDnssdServiceInstanceInfo typedef
Menampilkan informasi instance layanan yang ditemukan untuk kueri DNS-SD.

Fungsi
otDnssdGetCounters(otInstance *aInstance)
const otDnssdCounters *
Menampilkan penghitung server DNS-SD.
otDnssdGetNextQuery(otInstance *aInstance, const otDnssdQuery *aQuery)
const otDnssdQuery *
Memperoleh kueri berikutnya di server DNS-SD.
otDnssdGetQueryTypeAndName(const otDnssdQuery *aQuery, char(*) aNameOutput[OT_DNS_MAX_NAME_SIZE])
Memperoleh jenis dan nama kueri DNS-SD untuk kueri tertentu.
otDnssdQueryHandleDiscoveredHost(otInstance *aInstance, const char *aHostFullName, otDnssdHostInfo *aHostInfo)
void
Memberi tahu host yang ditemukan.
otDnssdQueryHandleDiscoveredServiceInstance(otInstance *aInstance, const char *aServiceFullName, otDnssdServiceInstanceInfo *aInstanceInfo)
void
Memberi tahu instance layanan yang ditemukan.
otDnssdQuerySetCallbacks(otInstance *aInstance, otDnssdQuerySubscribeCallback aSubscribe, otDnssdQueryUnsubscribeCallback aUnsubscribe, void *aContext)
void
Menyetel callback kueri server DNS-SD.
otDnssdUpstreamQueryIsEnabled(otInstance *aInstance)
bool
Menampilkan apakah server DNSSD akan meneruskan kueri DNS ke API upstream DNS platform.
otDnssdUpstreamQuerySetEnabled(otInstance *aInstance, bool aEnabled)
void
Mengaktifkan atau menonaktifkan penerusan kueri DNS ke API upstream DNS platform.

Struct
otDnssdCounters

Berisi penghitung server DNS-SD.

otDnssdHostInfo

Menampilkan informasi dari host yang ditemukan untuk kueri DNS-SD.

otDnssdServiceInstanceInfo

Menampilkan informasi instance layanan yang ditemukan untuk kueri DNS-SD.

Enumerasi

otDnssdQueryType

 otDnssdQueryType

Menentukan jenis kueri DNS-SD.

Properti
OT_DNSSD_QUERY_TYPE_BROWSE

Layanan penjelajahan jenis layanan.

OT_DNSSD_QUERY_TYPE_NONE

Jenis layanan belum ditetapkan.

OT_DNSSD_QUERY_TYPE_RESOLVE

Jenis layanan menyelesaikan instance layanan.

OT_DNSSD_QUERY_TYPE_RESOLVE_HOST

Jenis layanan me-resolve nama host.

Typedef

otDnssdCounters

struct otDnssdCounters otDnssdCounters

Berisi penghitung server DNS-SD.

otDnssdHostInfo

struct otDnssdHostInfo otDnssdHostInfo

Menampilkan informasi dari host yang ditemukan untuk kueri DNS-SD.

otDnssdQuery

void otDnssdQuery

Tipe buram ini mewakili kueri DNS-SD.

otDnssdQuerySubscribeCallback

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

Dipanggil ketika kueri DNS-SD berlangganan salah satu dari:

  1. nama layanan.
  2. nama instance layanan.
  3. nama {i>host<i}.

Implementasi kueri DNS-SD bertanggung jawab untuk mengidentifikasi apa yang dimaksud dengan aFullName. Jika aFullName adalah nama layanan atau nama instance layanan, implementasi kueri DNS-SD harus menemukan informasi instance layanan yang sesuai dan memberi tahu server DNS-SD menggunakan otDnssdQueryHandleDiscoveredServiceInstance. Jika aFullName adalah nama host, implementasi kueri DNS-SD harus menemukan informasi host dan memberi tahu server DNS-SD menggunakan otDnssdQueryHandleDiscoveredHost.

Detail
Parameter
[in] aContext
Pointer ke konteks khusus aplikasi.
[in] aFullName
Nama layanan lengkap yang diakhiri dengan null (misalnya "_ipps._tcp.default.service.arpa."), atau nama instance layanan lengkap (misalnya "OpenThread._ipps._tcp.default.service.arpa."), atau nama host lengkap (misalnya "ot-host.default.service.arpa.").
Lihat juga:
otDnssdQueryHandleDiscoveredServiceInstance
otDnssdQueryHandleDiscoveredHost

otDnssdQueryUnsubscribeCallback

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

Dipanggil saat kueri DNS-SD menghentikan langganan salah satu dari:

  1. nama layanan.
  2. nama instance layanan.
  3. nama {i>host<i}.

Implementasi kueri DNS-SD bertanggung jawab untuk mengidentifikasi aFullName.

Detail
Parameter
[in] aContext
Pointer ke konteks khusus aplikasi.
[in] aFullName
Nama layanan lengkap yang diakhiri dengan null (misalnya "_ipps._tcp.default.service.arpa."), atau nama instance layanan lengkap (misalnya, "OpenThread._ipps._tcp.default.service.arpa.").

otDnssdServiceInstanceInfo

struct otDnssdServiceInstanceInfo otDnssdServiceInstanceInfo

Menampilkan informasi instance layanan yang ditemukan untuk kueri DNS-SD.

Fungsi

otDnssdGetCounters

const otDnssdCounters * otDnssdGetCounters(
  otInstance *aInstance
)

Menampilkan penghitung server DNS-SD.

Detail
Parameter
[in] aInstance
Struktur instance OpenThread.
Hasil
Pointer ke penghitung server DNS-SD.

otDnssdGetNextQuery

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

Memperoleh kueri berikutnya di server DNS-SD.

Detail
Parameter
[in] aInstance
Struktur instance OpenThread.
[in] aQuery
Pointer kueri. Teruskan NULL untuk mendapatkan kueri pertama.
Hasil
Pointer ke kueri atau NULL jika tidak ada lagi kueri.

otDnssdGetQueryTypeAndName

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

Memperoleh jenis dan nama kueri DNS-SD untuk kueri tertentu.

Detail
Parameter
[in] aQuery
Pointer kueri yang diperoleh dari otDnssdGetNextQuery.
[out] aNameOutput
Buffering output nama, yang panjangnya harus OT_DNS_MAX_NAME_SIZE byte.
Hasil
Jenis kueri DNS-SD.

otDnssdQueryHandleDiscoveredHost

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

Memberi tahu host yang ditemukan.

Resolver kueri eksternal (misalnya, Discovery Proxy) harus memanggil fungsi ini untuk memberi tahu inti OpenThread tentang host yang berlangganan.

Detail
Parameter
[in] aInstance
Struktur instance OpenThread.
[in] aHostFullName
Nama host lengkap yang dihentikan null.
[in] aHostInfo
Pointer ke informasi instance layanan yang ditemukan.

otDnssdQueryHandleDiscoveredServiceInstance

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

Memberi tahu instance layanan yang ditemukan.

Resolver kueri eksternal (misalnya, Discovery Proxy) harus memanggil fungsi ini untuk memberi tahu inti OpenThread mengenai layanan atau instance layanan yang berlangganan.

Detail
Parameter
[in] aInstance
Struktur instance OpenThread.
[in] aServiceFullName
Nama layanan lengkap yang dihentikan null.
[in] aInstanceInfo
Pointer ke informasi instance layanan yang ditemukan.

otDnssdQuerySetCallbacks

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

Menyetel callback kueri server DNS-SD.

Server DNS-SD memanggil aSubscribe untuk berlangganan instance layanan atau layanan guna menyelesaikan kueri DNS-SD dan aUnsubscribe untuk berhenti berlangganan saat kueri diselesaikan atau waktu tunggu habis.

Detail
Parameter
[in] aInstance
Struktur instance OpenThread.
[in] aSubscribe
Pointer ke fungsi callback untuk berlangganan instance layanan atau layanan.
[in] aUnsubscribe
Pointer ke fungsi callback untuk menghentikan langganan instance layanan atau layanan.
[in] aContext
Pointer ke konteks khusus aplikasi.

otDnssdUpstreamQueryIsEnabled

bool otDnssdUpstreamQueryIsEnabled(
  otInstance *aInstance
)

Menampilkan apakah server DNSSD akan meneruskan kueri DNS ke API upstream DNS platform.

Tersedia jika OPENTHREAD_CONFIG_DNS_UPSTREAM_QUERY_ENABLE diaktifkan.

Detail
Parameter
[in] aInstance
Pointer ke instance OpenThread.
Nilai Pengembalian
TRUE
Jika server DNSSD akan meneruskan kueri DNS.
FALSE
Jika server DNSSD tidak akan meneruskan kueri DNS.
Lihat juga:
otDnssdUpstreamQuerySetEnabled

otDnssdUpstreamQuerySetEnabled

void otDnssdUpstreamQuerySetEnabled(
  otInstance *aInstance,
  bool aEnabled
)

Mengaktifkan atau menonaktifkan penerusan kueri DNS ke API upstream DNS platform.

Tersedia jika OPENTHREAD_CONFIG_DNS_UPSTREAM_QUERY_ENABLE diaktifkan.

Detail
Parameter
[in] aInstance
Pointer ke instance OpenThread.
[in] aEnabled
Boolean untuk mengaktifkan/menonaktifkan penerusan kueri DNS ke upstream.
Lihat juga:
otPlatDnsStartUpstreamQuery
otPlatDnsCancelUpstreamQuery
otPlatDnsUpstreamQueryDone

Referensi

Topik Referensi OpenThread API berasal dari kode sumber yang tersedia di GitHub. Untuk informasi selengkapnya, atau untuk berkontribusi pada dokumentasi kami, lihat Referensi.