معیارهای پیوند

این ماژول شامل توابعی است که پروتکل Link Metrics را کنترل می کند.

خلاصه

شمارش ها

otLinkMetricsEnhAckFlags {
OT_LINK_METRICS_ENH_ACK_CLEAR = 0,
OT_LINK_METRICS_ENH_ACK_REGISTER = 1
}		 enum
پرچم های پیشرفته-ACK.
otLinkMetricsStatus enum
مقادیر وضعیت معیارهای پیوند.

Typedefs

otLinkMetricsEnhAckFlags typedef
پرچم های پیشرفته-ACK.
otLinkMetricsEnhAckProbingIeReportCallback )(otShortAddress aShortAddress, const otExtAddress *aExtAddress, const otLinkMetricsValues *aMetricsValues, void *aContext) typedef
void(*
هنگامی که Enh-ACK Probing IE دریافت می شود، اشاره گر فراخوانی می شود.
otLinkMetricsMgmtResponseCallback )(const otIp6Address *aSource, otLinkMetricsStatus aStatus, void *aContext) typedef
void(*
هنگامی که یک پاسخ مدیریت متریک لینک دریافت می شود، اشاره گر فراخوانی می شود.
otLinkMetricsReportCallback )(const otIp6Address *aSource, const otLinkMetricsValues *aMetricsValues, otLinkMetricsStatus aStatus, void *aContext) typedef
void(*
هنگامی که گزارش Link Metrics دریافت می شود، اشاره گر فراخوانی می شود.
otLinkMetricsSeriesFlags typedef
نشان‌دهنده این است که کدام فریم‌ها در یک سری پیگیری پیش‌رو به حساب می‌آیند.
otLinkMetricsStatus typedef
مقادیر وضعیت معیارهای پیوند.
otLinkMetricsValues typedef
نشان دهنده نتیجه (مقدار) یک جستجوی Link Metrics است.

کارکرد

otLinkMetricsConfigEnhAckProbing ( otInstance *aInstance, const otIp6Address *aDestination, otLinkMetricsEnhAckFlags aEnhAckFlags, const otLinkMetrics *aLinkMetricsFlags, otLinkMetricsMgmtResponseCallback aCallback, void *aCallbackContext, otLinkMetricsEnhAckProbingIeReportCallback aEnhAckCallback, void *aEnhAckCallbackContext)
یک درخواست مدیریت متریک MLE Link برای پیکربندی/پاک کردن یک کاوش مبتنی بر ACK پیشرفته ارسال می‌کند.
otLinkMetricsConfigForwardTrackingSeries ( otInstance *aInstance, const otIp6Address *aDestination, uint8_t aSeriesId, otLinkMetricsSeriesFlags aSeriesFlags, const otLinkMetrics *aLinkMetricsFlags, otLinkMetricsMgmtResponseCallback aCallback, void *aCallbackContext)
یک درخواست مدیریت متریک MLE Link برای پیکربندی یا پاک کردن یک سری ردیابی رو به جلو ارسال می کند.
otLinkMetricsManagerGetMetricsValueByExtAddr ( otInstance *aInstance, const otExtAddress *aExtAddress, otLinkMetricsValues *aLinkMetricsValues)
داده های Link Metrics یک همسایه را با آدرس گسترده آن دریافت کنید.
otLinkMetricsManagerSetEnabled ( otInstance *aInstance, bool aEnable)
void
فعال یا غیرفعال کردن Link Metrics Manager.
otLinkMetricsQuery ( otInstance *aInstance, const otIp6Address *aDestination, uint8_t aSeriesId, const otLinkMetrics *aLinkMetricsFlags, otLinkMetricsReportCallback aCallback, void *aCallbackContext)
یک درخواست داده MLE برای پرس و جو از معیارهای پیوند ارسال می کند.
otLinkMetricsSendLinkProbe ( otInstance *aInstance, const otIp6Address *aDestination, uint8_t aSeriesId, uint8_t aLength)
یک پیام MLE Link Probe ارسال می کند.

سازه ها

otLinkMetricsSeriesFlags

نشان‌دهنده این است که کدام فریم‌ها در یک سری پیگیری پیش‌رو به حساب می‌آیند.

otLinkMetricsValues

نشان دهنده نتیجه (مقدار) یک جستجوی Link Metrics است.

شمارش ها

otLinkMetricsEnhAckFlags

 otLinkMetricsEnhAckFlags

پرچم های پیشرفته-ACK.

این ها در کاوش مبتنی بر ACK برای نشان دادن ثبت یا پاک کردن کاوش استفاده می شوند.

خواص
OT_LINK_METRICS_ENH_ACK_CLEAR

پاک کردن

OT_LINK_METRICS_ENH_ACK_REGISTER

ثبت نام.

وضعیت otLinkMetrics

 otLinkMetricsStatus

مقادیر وضعیت معیارهای پیوند.

Typedefs

otLinkMetricsEnhAckFlags

enum otLinkMetricsEnhAckFlags otLinkMetricsEnhAckFlags

پرچم های پیشرفته-ACK.

این ها در کاوش مبتنی بر ACK برای نشان دادن ثبت یا پاک کردن کاوش استفاده می شوند.

otLinkMetricsEnhAckProbingIeReportCallback

void(* otLinkMetricsEnhAckProbingIeReportCallback)(otShortAddress aShortAddress, const otExtAddress *aExtAddress, const otLinkMetricsValues *aMetricsValues, void *aContext)

هنگامی که Enh-ACK Probing IE دریافت می شود، اشاره گر فراخوانی می شود.

جزئیات
مولفه های
[in] aShortAddress
مک آدرس کوتاه موضوع کاوشگر.
[in] aExtAddress
یک اشاره گر به آدرس توسعه یافته مک موضوع کاوشگر.
[in] aMetricsValues
یک اشاره گر به مقادیر Link Metrics به دست آمده از IE.
[in] aContext
اشاره‌ای به زمینه خاص برنامه.

otLinkMetricsMgmtResponseCallback

void(* otLinkMetricsMgmtResponseCallback)(const otIp6Address *aSource, otLinkMetricsStatus aStatus, void *aContext)

هنگامی که یک پاسخ مدیریت متریک لینک دریافت می شود، اشاره گر فراخوانی می شود.

جزئیات
مولفه های
[in] aSource
اشاره گر به آدرس منبع
[in] aStatus
کد وضعیت در پاسخ.
[in] aContext
اشاره‌ای به زمینه خاص برنامه.

otLinkMetricsReportCallback

void(* otLinkMetricsReportCallback)(const otIp6Address *aSource, const otLinkMetricsValues *aMetricsValues, otLinkMetricsStatus aStatus, void *aContext)

هنگامی که گزارش Link Metrics دریافت می شود، اشاره گر فراخوانی می شود.

جزئیات
مولفه های
[in] aSource
اشاره گر به آدرس منبع
[in] aMetricsValues
اشاره گر به مقادیر Link Metrics (نتیجه پرس و جو).
[in] aStatus
کد وضعیت در گزارش (فقط زمانی مفید است که aMetricsValues ​​NULL باشد).
[in] aContext
اشاره‌ای به زمینه خاص برنامه.

otLinkMetricsSeriesFlags

struct otLinkMetricsSeriesFlags otLinkMetricsSeriesFlags

نشان‌دهنده این است که کدام فریم‌ها در یک سری پیگیری پیش‌رو به حساب می‌آیند.

وضعیت otLinkMetrics

enum otLinkMetricsStatus otLinkMetricsStatus

مقادیر وضعیت معیارهای پیوند.

otLinkMetricsValues

struct otLinkMetricsValues otLinkMetricsValues

نشان دهنده نتیجه (مقدار) یک جستجوی Link Metrics است.

کارکرد

otLinkMetricsConfigEnhAckProbing

otError otLinkMetricsConfigEnhAckProbing(
  otInstance *aInstance,
  const otIp6Address *aDestination,
  otLinkMetricsEnhAckFlags aEnhAckFlags,
  const otLinkMetrics *aLinkMetricsFlags,
  otLinkMetricsMgmtResponseCallback aCallback,
  void *aCallbackContext,
  otLinkMetricsEnhAckProbingIeReportCallback aEnhAckCallback,
  void *aEnhAckCallbackContext
)

یک درخواست مدیریت متریک MLE Link برای پیکربندی/پاک کردن یک کاوش مبتنی بر ACK پیشرفته ارسال می‌کند.

این عملکرد نیاز به فعال کردن ویژگی OT_LINK_METRICS_INITIATOR دارد.

جزئیات
مولفه های
[in] aInstance
اشاره گر به یک نمونه OpenThread.
[in] aDestination
اشاره گر به آدرس مقصد
[in] aEnhAckFlags
پرچم های Enh-ACK برای نشان دادن ثبت یا پاک کردن کاوش. 0 برای پاک کردن و 1 برای ثبت نام. سایر مقادیر محفوظ است.
[in] aLinkMetricsFlags
یک اشاره گر به پرچم هایی که مشخص می کند چه معیارهایی باید پرس و جو شود. وقتی aEnhAckFlags 0 باشد باید NULL باشد.
[in] aCallback
اشاره‌گر به تابعی که هنگام دریافت Ack پیشرفته با معیارهای پیوند فراخوانی می‌شود.
[in] aCallbackContext
اشاره‌ای به زمینه خاص برنامه.
ارزش های بازگشتی
OT_ERROR_NONE
یک پیام درخواست مدیریت متریک پیوند با موفقیت ارسال شد.
OT_ERROR_NO_BUFS
بافرهای ناکافی برای ایجاد پیام درخواست مدیریت متریک MLE Link.
OT_ERROR_INVALID_ARGS
aEnhAckFlags یک مقدار معتبر نیست یا aLinkMetricsFlags صحیح نیست.
OT_ERROR_UNKNOWN_NEIGHBOR
aDestination پیوند محلی نیست یا همسایه پیدا نشده است.
OT_ERROR_NOT_CAPABLE
همسایه یک دستگاه Thread 1.2 نیست و از Link Metrics پشتیبانی نمی کند.

otLinkMetricsConfigForwardTrackingSeries

otError otLinkMetricsConfigForwardTrackingSeries(
  otInstance *aInstance,
  const otIp6Address *aDestination,
  uint8_t aSeriesId,
  otLinkMetricsSeriesFlags aSeriesFlags,
  const otLinkMetrics *aLinkMetricsFlags,
  otLinkMetricsMgmtResponseCallback aCallback,
  void *aCallbackContext
)

یک درخواست مدیریت متریک MLE Link برای پیکربندی یا پاک کردن یک سری ردیابی رو به جلو ارسال می کند.

جزئیات
مولفه های
[in] aInstance
اشاره گر به یک نمونه OpenThread.
[in] aDestination
اشاره گر به آدرس مقصد
[in] aSeriesId
شناسه سری برای کار با.
[in] aSeriesFlags
پرچم‌های سری که مشخص می‌کند کدام فریم‌ها باید حساب شوند.
[in] aLinkMetricsFlags
یک اشاره گر به پرچم هایی که مشخص می کند چه معیارهایی باید پرس و جو شود. وقتی aSeriesFlags 0 باشد باید NULL باشد.
[in] aCallback
اشاره گر به تابعی که هنگام دریافت پاسخ مدیریت متریک لینک فراخوانی می شود.
[in] aCallbackContext
اشاره‌ای به زمینه خاص برنامه.
ارزش های بازگشتی
OT_ERROR_NONE
یک پیام درخواست مدیریت متریک پیوند با موفقیت ارسال شد.
OT_ERROR_NO_BUFS
بافرهای ناکافی برای ایجاد پیام درخواست مدیریت متریک MLE Link.
OT_ERROR_INVALID_ARGS
aSeriesId در محدوده معتبر نیست.
OT_ERROR_UNKNOWN_NEIGHBOR
aDestination پیوند محلی نیست یا همسایه پیدا نشده است.
OT_ERROR_NOT_CAPABLE
همسایه یک دستگاه Thread 1.2 نیست و از Link Metrics پشتیبانی نمی کند.

otLinkMetricsManagerGetMetricsValueByExtAddr

otError otLinkMetricsManagerGetMetricsValueByExtAddr(
  otInstance *aInstance,
  const otExtAddress *aExtAddress,
  otLinkMetricsValues *aLinkMetricsValues
)

داده های Link Metrics یک همسایه را با آدرس گسترده آن دریافت کنید.

جزئیات
مولفه های
[in] aInstance
اشاره گر به یک نمونه OpenThread.
[in] aExtAddress
یک اشاره گر به آدرس توسعه یافته مک موضوع کاوشگر.
[out] aLinkMetricsValues
اشاره گر به مقادیر Link Metrics موضوع.
ارزش های بازگشتی
OT_ERROR_NONE
داده های Link Metrics با موفقیت دریافت شد.
OT_ERROR_INVALID_ARGS
استدلال ها نامعتبر است.
OT_ERROR_NOT_FOUND
هیچ همسایه ای با آدرس گسترده داده شده یافت نشد.

otLinkMetricsManagerSetEnabled

void otLinkMetricsManagerSetEnabled(
  otInstance *aInstance,
  bool aEnable
)

فعال یا غیرفعال کردن Link Metrics Manager.

جزئیات
مولفه های
[in] aInstance
اشاره گر به یک نمونه OpenThread.
[in] aEnable
یک بولی که نشان دهنده فعال یا غیرفعال کردن است.

otLinkMetricsQuery

otError otLinkMetricsQuery(
  otInstance *aInstance,
  const otIp6Address *aDestination,
  uint8_t aSeriesId,
  const otLinkMetrics *aLinkMetricsFlags,
  otLinkMetricsReportCallback aCallback,
  void *aCallbackContext
)

یک درخواست داده MLE برای پرس و جو از معیارهای پیوند ارسال می کند.

این می تواند یا Single Probe یا Forward Tracking Series باشد.

جزئیات
مولفه های
[in] aInstance
اشاره گر به یک نمونه OpenThread.
[in] aDestination
اشاره گر به آدرس مقصد
[in] aSeriesId
شناسه سری برای درخواست، 0 برای Single Probe.
[in] aLinkMetricsFlags
یک اشاره گر به پرچم هایی که مشخص می کند چه معیارهایی باید پرس و جو شود.
[in] aCallback
اشاره گر به تابعی که هنگام دریافت گزارش Link Metrics فراخوانی می شود.
[in] aCallbackContext
اشاره‌ای به زمینه خاص برنامه.
ارزش های بازگشتی
OT_ERROR_NONE
پیام جستجوی Link Metrics با موفقیت ارسال شد.
OT_ERROR_NO_BUFS
بافرهای ناکافی برای ایجاد پیام درخواست داده MLE.
OT_ERROR_UNKNOWN_NEIGHBOR
aDestination پیوند محلی نیست یا همسایه پیدا نشده است.
OT_ERROR_NOT_CAPABLE
همسایه یک دستگاه Thread 1.2 نیست و از Link Metrics پشتیبانی نمی کند.

otLinkMetricsSendLinkProbe

otError otLinkMetricsSendLinkProbe(
  otInstance *aInstance,
  const otIp6Address *aDestination,
  uint8_t aSeriesId,
  uint8_t aLength
)

یک پیام MLE Link Probe ارسال می کند.

جزئیات
مولفه های
[in] aInstance
اشاره گر به یک نمونه OpenThread.
[in] aDestination
اشاره گر به آدرس مقصد
[in] aSeriesId
شناسه سری [1, 254] که پیام Probe آن را هدف قرار می دهد.
[in] aLength
طول محموله داده در Link Probe TLV، 0، 64 .
ارزش های بازگشتی
OT_ERROR_NONE
یک پیام پروب پیوند با موفقیت ارسال شد.
OT_ERROR_NO_BUFS
بافرهای کافی برای ایجاد پیام MLE Link Probe وجود ندارد.
OT_ERROR_INVALID_ARGS
aSeriesId یا aLength در محدوده معتبر نیست.
OT_ERROR_UNKNOWN_NEIGHBOR
aDestination پیوند محلی نیست یا همسایه پیدا نشده است.
OT_ERROR_NOT_CAPABLE
همسایه یک دستگاه Thread 1.2 نیست و از Link Metrics پشتیبانی نمی کند.

منابع

موضوعات مرجع OpenThread API از کد منبع موجود در GitHub سرچشمه می گیرند. برای اطلاعات بیشتر، یا مشارکت در اسناد ما، به منابع مراجعه کنید.