שרת 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
} 		טיפוסים בני מנייה (enum)
מציינת סוג שאילתה מסוג DNS-SD.

ערכי דף
otDnssdCounters typedef
מכיל את המונים של שרת DNS-SD.
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.

פונקציות
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])
מקבל את השם ואת סוג השאילתה 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
מגדיר קריאות חוזרות (callback) של שאילתת שרת DNS-SD.
otDnssdUpstreamQueryIsEnabled(otInstance *aInstance)
bool
מחזירה אם שרת DNSSD יעביר שאילתות DNS אל הפלטפורמה DNS upstream API.
otDnssdUpstreamQuerySetEnabled(otInstance *aInstance, bool aEnabled)
void
הפעלה או השבתה של העברת שאילתות DNS לפלטפורמה מסוג DNS upstream API.

מבנים
otDnssdCounters

מכיל את המונים של שרת 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

סוג השירות משנה את שם המארח.

ערכי דף

otDnssdCounters

struct otDnssdCounters otDnssdCounters

מכיל את המונים של שרת DNS-SD.

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 צריכה לגלות את פרטי מופע השירות המתאים ולהודיע לשרת DNS-SD באמצעות otDnssdQueryHandleDiscoveredServiceInstance. אם aFullName הוא שם מארח, הטמעת שאילתת DNS-SD אמורה לגלות את פרטי המארח ולהודיע לשרת DNS-SD באמצעות otDnssdQueryHandleDiscoveredHost.

פרטים
פרמטרים
[in] aContext
הצבעה להקשר הספציפי לאפליקציה.
[in] aFullName
שם השירות המלא עם הסיומת null (למשל "_ipps._tcp.default.service.arpa."), או שם המופע של השירות המלא (למשל "OpenThread._ipps._tcp.default.service.arpa."), או שם המארח המלא (למשל "ot-host.default.service.arpa.").
מידע נוסף מופיע גם:
otDnssdQueryHandleDiscoveredServiceInstance
otDnssdQueryHandleDiscoveredHost

otDnssdQueryUnsubscribeCallback

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.

פונקציות

otDnssdGetCounters

const otDnssdCounters * otDnssdGetCounters(
  otInstance *aInstance
)

מחזירה את המונים של שרת DNS-SD.

פרטים
פרמטרים
[in] aInstance
מבנה המכונה של OpenThread.
החזרות
מצביע על המונים של שרת 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

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

מודיעה למארח שנמצא.

מקודד השאילתות החיצוני (למשל Discovery Proxy) צריך להפעיל את הפונקציה הזו כדי ליידע את OpenThread הליבה של המארחים הרשומים.

פרטים
פרמטרים
[in] aInstance
מבנה המכונה של OpenThread.
[in] aHostFullName
שם המארח המלא שנסגר.
[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
)

מגדיר קריאות חוזרות (callback) של שאילתת שרת DNS-SD.

שרת ה-DNS-SD קורא ל-aSubscribe להירשם לשירות או למופע של שירות כדי לטפל בשאילתת DNS-SD ול-aUnsubscribe כדי לבטל את הרישום כשהבעיה נפתרת או שמסתיימת הזמן הקצוב לתפוגה.

פרטים
פרמטרים
[in] aInstance
מבנה המכונה של OpenThread.
[in] aSubscribe
מצביע על כך לפונקציית קריאה חוזרת כדי להירשם למינוי של שירות או מופע של שירות.
[in] aUnsubscribe
מעבר לפונקציית הקריאה החוזרת כדי לבטל את ההרשמה למופע של שירות או שירות.
[in] aContext
הצבעה להקשר הספציפי לאפליקציה.

otDnssdUpstreamQueryIsEnabled

bool otDnssdUpstreamQueryIsEnabled(
  otInstance *aInstance
)

מחזירה אם שרת DNSSD יעביר שאילתות DNS אל הפלטפורמה DNS upstream API.

זמין כאשר OPENTHREAD_CONFIG_DNS_UPSTREAM_QUERY_ENABLE מופעל.

פרטים
פרמטרים
[in] aInstance
מצביע למופע של OpenThread.
ערכים מוחזרים
TRUE
אם שרת DNSSD יעביר שאילתות DNS.
FALSE
אם שרת DNSSD לא יעביר שאילתות DNS.
מידע נוסף מופיע גם:
otDnssdUpstreamQuerySetEnabled

otDnssdUpstreamQuerySetEnabled

void otDnssdUpstreamQuerySetEnabled(
  otInstance *aInstance,
  bool aEnabled
)

הפעלה או השבתה של העברת שאילתות DNS לפלטפורמה מסוג DNS upstream API.

זמין כאשר OPENTHREAD_CONFIG_DNS_UPSTREAM_QUERY_ENABLE מופעל.

פרטים
פרמטרים
[in] aInstance
מצביע למופע של OpenThread.
[in] aEnabled
ערך בוליאני להפעלה או להשבתה של העברה של שאילתות DNS אל upstream.
מידע נוסף מופיע גם:
otPlatDnsStartUpstreamQuery
otPlatDnsCancelUpstreamQuery
otPlatDnsUpstreamQueryDone

מקורות מידע

המקור של נושאי העזר של OpenThread API הוא קוד המקור, שזמין ב-GitHub. אפשר לקרוא מידע נוסף או לתרום למסמכי התיעוד שלנו בדף מקורות מידע.