Google は、黒人コミュニティのための人種的公平の促進に取り組んでいます。詳細をご覧ください。

DNS-SD サーバー

このモジュールには、DNS-SD サーバー用の API が含まれています。

概要

列挙型

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 クエリタイプを指定します。

Typedef

otDnssdHostInfo typedef
この構造は、DNS-SD クエリ用に検出されたホストの情報を表します。
otDnssdQuery typedef
void
この不透明型は、DNS-SD クエリを表します。
otDnssdQuerySubscribeCallback)(void *aContext, const char *aFullName) typedef
void(*
この関数は、DNS-SD クエリが次のいずれかにサブスクライブしたときに呼び出されます。
otDnssdQueryUnsubscribeCallback)(void *aContext, const char *aFullName) typedef
void(*
この関数は、DNS-SD クエリにより次のいずれかが登録解除されたときに呼び出されます。
otDnssdServiceInstanceInfo typedef
この構造は、DNS-SD クエリ用に検出されたサービス インスタンスの情報を表します。

関数

otDnssdGetNextQuery(otInstance *aInstance, const otDnssdQuery *aQuery)
const otDnssdQuery *
この関数は、DNS-SD サーバーで次のクエリを取得します。
otDnssdGetQueryTypeAndName(const otDnssdQuery *aQuery, char(*) aNameOutput[OT_DNS_MAX_NAME_SIZE])
この関数は、特定のクエリの 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 サーバー クエリ コールバックを設定します。

構造体

otDnssdHostInfo

この構造は、DNS-SD クエリ用に検出されたホストの情報を表します。

otDnssdServiceInstanceInfo

この構造は、DNS-SD クエリ用に検出されたサービス インスタンスの情報を表します。

列挙型

otDnssdQueryType

 otDnssdQueryType

この列挙型は、DNS-SD クエリタイプを指定します。

プロパティ
OT_DNSSD_QUERY_TYPE_BROWSE

サービスタイプ閲覧サービス。

OT_DNSSD_QUERY_TYPE_NONE

サービスタイプの指定なし。

OT_DNSSD_QUERY_TYPE_RESOLVE

サービスタイプによりサービス インスタンスが解決されます。

OT_DNSSD_QUERY_TYPE_RESOLVE_HOST

Service タイプがホスト名を解決します。

Typedef

otDnssdHostInfo

struct otDnssdHostInfo otDnssdHostInfo

この構造は、DNS-SD クエリ用に検出されたホストの情報を表します。

otDnssdQuery

void otDnssdQuery

この不透明型は、DNS-SD クエリを表します。

otDnssdQuerySubscribeCallback(コールバック)

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

この関数は、DNS-SD クエリが次のいずれかにサブスクライブしたときに呼び出されます。

  1. サービス名。
  2. サービス インスタンス名。
  3. ホスト名。

DNS-SD クエリの実装では、aFullName を識別する必要があります。 aFullName がサービス名またはサービス インスタンス名の場合、DNS-SD クエリの実装では、対応するサービス インスタンス情報が検出され、otDnssdQueryHandleDiscoveredServiceInstance を使用して DNS-SD サーバーに通知される必要があります。aFullName がホスト名の場合、DNS-SD クエリの実装でホスト情報が検出され、otDnssdQueryHandleDiscoveredHost を使用して DNS-SD サーバーに通知されます。

詳細
パラメータ
[in] aContext
アプリ固有のコンテキストへのポインタ。
[in] aFullName
null で終わる完全なサービス名(「_ipps._tcp.default.service.arpa.」など)、完全なサービス インスタンス名(「OpenThread._ipps._tcp.default.service.arpa.」など)、または完全なホスト名「ot-host.default.service.arpa」など。
関連項目:
otDnssdQueryHandleDiscoveredServiceInstance
otDnssdQueryHandleDiscoveredHost

otDnssdQueryPlaceholderCallback

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

この関数は、DNS-SD クエリにより次のいずれかが登録解除されたときに呼び出されます。

  1. サービス名。
  2. サービス インスタンス名。
  3. ホスト名。

DNS-SD クエリの実装では、aFullName を識別する必要があります。

詳細
パラメータ
[in] aContext
アプリ固有のコンテキストへのポインタ。
[in] aFullName
null で終わる完全なサービス名(「_ipps._tcp.default.service.arpa」など)、または完全なサービス インスタンス名(「OpenThread._ipps._tcp.default.service.arpa.」など)。

otDnssdServiceInstanceInfo のいずれか

struct otDnssdServiceInstanceInfo otDnssdServiceInstanceInfo

この構造は、DNS-SD クエリ用に検出されたサービス インスタンスの情報を表します。

関数

otDnssdGetNextQuery

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

この関数は、DNS-SD サーバーで次のクエリを取得します。

詳細
パラメータ
[in] aInstance
OpenThread インスタンス構造。
[in] aQuery
クエリポインタ。最初のクエリを取得するには NULL を渡します。
戻り値
クエリへのポインタ。クエリがそれ以上ない場合は NULL。

otDnssdGetQueryTypeAndName

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 クエリタイプ。

otDnssdQueryHandleDiscoveredHost(OTDnssQueryQueryHandleDiscoveredHost)

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

この関数は、検出されたホストに通知します。

外部クエリ リゾルバ(Discovery Proxy など)はこの関数を呼び出して、登録されたホストの OpenThread コアに通知する必要があります。

詳細
パラメータ
[in] aInstance
OpenThread インスタンス構造。
[in] aHostFullName
null で終わる完全なホスト名。
[in] aHostInfo
検出されたサービス インスタンス情報へのポインタ。

otDnssdQueryHandleDiscoveredServiceInstance

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

この関数は、検出されたサービス インスタンスに通知します。

外部クエリ リゾルバ(Discovery Proxy など)はこの関数を呼び出して、サブスクライブされたサービスまたはサービス インスタンスを OpenThread コアに通知する必要があります。

詳細
パラメータ
[in] aInstance
OpenThread インスタンス構造。
[in] aServiceFullName
null で終わる完全なサービス名。
[in] aInstanceInfo
検出されたサービス インスタンス情報へのポインタ。

otDnssdQuerySetCallbacks(英語)

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

この関数は、DNS-SD サーバー クエリ コールバックを設定します。

DNS-SD サーバーは、サービス インスタンスまたはサービス インスタンスに登録して DNS-SD クエリを解決するために aSubscribe を呼び出し、クエリの解決またはタイムアウト時に aUnsubscribe を呼び出して登録解除します。

詳細
パラメータ
[in] aInstance
OpenThread インスタンス構造。
[in] aSubscribe
サービスまたはサービス インスタンスに登録するためのコールバック関数へのポインタ。
[in] aUnsubscribe
サービスまたはサービス インスタンスを登録解除するためのコールバック関数へのポインタ。
[in] aContext
アプリ固有のコンテキストへのポインタ。

リソース

OpenThread API リファレンスのトピックは、GitHub で入手可能なソースコードに基づいています。 詳細またはドキュメントへの投稿については、リソースをご覧ください。