เมตริกลิงก์

โมดูลนี้มีฟังก์ชันที่ควบคุมโปรโตคอลเมตริกลิงก์

สรุป

คําอธิบาย
otLinkMetricsEnhAckFlags{
  OT_LINK_METRICS_ENH_ACK_CLEAR = 0,
  OT_LINK_METRICS_ENH_ACK_REGISTER = 1
} 		enum
แฟล็กที่ปรับปรุงแล้ว
otLinkMetricsStatus enum
ค่าสถานะเมตริกเมตริก

พิมพ์ดีด
otLinkMetricsEnhAckFlags typedef
แฟล็กที่ปรับปรุงแล้ว
otLinkMetricsEnhAckProbingIeReportCallback)(otShortAddress aShortAddress, const otExtAddress *aExtAddress, const otLinkMetricsValues *aMetricsValues, void *aContext) typedef
void(*
ระบบจะเรียกตัวชี้ฟังก์ชันนี้เมื่อได้รับ Enh-ACK Probing IE
otLinkMetricsMgmtResponseCallback)(const otIp6Address *aSource, uint8_t aStatus, void *aContext) typedef
void(*
ระบบจะเรียกใช้ตัวชี้ฟังก์ชันนี้เมื่อได้รับการตอบกลับการจัดการเมตริกลิงก์
otLinkMetricsReportCallback)(const otIp6Address *aSource, const otLinkMetricsValues *aMetricsValues, uint8_t aStatus, void *aContext) typedef
void(*
ระบบจะเรียกตัวชี้ฟังก์ชันนี้เมื่อได้รับรายงานเมตริกลิงก์
otLinkMetricsSeriesFlags typedef
โครงสร้างนี้เป็นเฟรมที่นํามาพิจารณาในชุดการติดตามแบบส่งต่อ
otLinkMetricsStatus typedef
ค่าสถานะเมตริกเมตริก
otLinkMetricsValues typedef
โครงสร้างนี้แสดงผลการค้นหา (ค่า) สําหรับการค้นหาเมตริกลิงก์

ฟังก์ชัน
otLinkMetricsConfigEnhAckProbing(otInstance *aInstance, const otIp6Address *aDestination, otLinkMetricsEnhAckFlags aEnhAckFlags, const otLinkMetrics *aLinkMetricsFlags, otLinkMetricsMgmtResponseCallback aCallback, void *aCallbackContext, otLinkMetricsEnhAckProbingIeReportCallback aEnhAckCallback, void *aEnhAckCallbackContext)
ฟังก์ชันนี้ส่งคําขอการจัดการเมตริกลิงก์ MLE เพื่อกําหนดค่า/ล้างการตรวจสอบแบบขั้นสูง
otLinkMetricsConfigForwardTrackingSeries(otInstance *aInstance, const otIp6Address *aDestination, uint8_t aSeriesId, otLinkMetricsSeriesFlags aSeriesFlags, const otLinkMetrics *aLinkMetricsFlags, otLinkMetricsMgmtResponseCallback aCallback, void *aCallbackContext)
ฟังก์ชันนี้ส่งคําขอการจัดการเมตริกลิงก์ MLE เพื่อกําหนดค่า/ล้างชุดการติดตามไปข้างหน้า
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)
ฟังก์ชันนี้จะส่งข้อความ Probe ของ MLE ลิงก์

โครงสร้าง
otLinkMetricsSeriesFlags

โครงสร้างนี้เป็นเฟรมที่นํามาพิจารณาในชุดการติดตามแบบส่งต่อ

otLinkMetricsValues

โครงสร้างนี้แสดงผลการค้นหา (ค่า) สําหรับการค้นหาเมตริกลิงก์

คําอธิบาย

otLinkMetricsEnhAckFlags

 otLinkMetricsEnhAckFlags

แฟล็กที่ปรับปรุงแล้ว

ค่าเหล่านี้ที่ใช้ในการตรวจสอบที่ปรับปรุงแล้ว

พร็อพเพอร์ตี้
OT_LINK_METRICS_ENH_ACK_CLEAR

ล้าง

OT_LINK_METRICS_ENH_ACK_REGISTER

ลงทะเบียน

สถานะ otLinkMetrics

 otLinkMetricsStatus

ค่าสถานะเมตริกเมตริก

พิมพ์ดีด

otLinkMetricsEnhAckFlags

enum otLinkMetricsEnhAckFlags otLinkMetricsEnhAckFlags

แฟล็กที่ปรับปรุงแล้ว

ค่าเหล่านี้ที่ใช้ในการตรวจสอบที่ปรับปรุงแล้ว

otLinkMetricsEnhAckProbingIeReportCallback

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

ระบบจะเรียกตัวชี้ฟังก์ชันนี้เมื่อได้รับ Enh-ACK Probing IE

รายละเอียด
พารามิเตอร์
[in] aShortAddress
ที่อยู่สั้นๆ ของเครื่อง Mac ของ Probing Subject
[in] aExtAddress
ตัวชี้ไปยังที่อยู่แบบขยายของ Mac ของ Probing Subject
[in] aMetricsValues
ตัวชี้ไปยังค่าเมตริกลิงก์ที่ได้รับจาก IE
[in] aContext
ตัวชี้ไปยังบริบทเฉพาะแอปพลิเคชัน

otLinkMetricsMgmtResponseCallback

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

ระบบจะเรียกใช้ตัวชี้ฟังก์ชันนี้เมื่อได้รับการตอบกลับการจัดการเมตริกลิงก์

รายละเอียด
พารามิเตอร์
[in] aSource
ตัวชี้ไปยังที่อยู่ต้นทาง
[in] aStatus
รหัสสถานะในการตอบกลับ
[in] aContext
ตัวชี้ไปยังบริบทเฉพาะแอปพลิเคชัน

otLinkMetrics รายงานการโทรกลับ

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

ระบบจะเรียกตัวชี้ฟังก์ชันนี้เมื่อได้รับรายงานเมตริกลิงก์

รายละเอียด
พารามิเตอร์
[in] aSource
ตัวชี้ไปยังที่อยู่ต้นทาง
[in] aMetricsValues
ตัวชี้ไปยังค่าเมตริกของลิงก์ (ผลการค้นหา)
[in] aStatus
รหัสสถานะในรายงาน (มีประโยชน์เมื่อ aMetricsValues เป็น NULL)
[in] aContext
ตัวชี้ไปยังบริบทเฉพาะแอปพลิเคชัน

แฟล็ก OTLinkMetricsSeries

struct otLinkMetricsSeriesFlags otLinkMetricsSeriesFlags

โครงสร้างนี้เป็นเฟรมที่นํามาพิจารณาในชุดการติดตามแบบส่งต่อ

สถานะ otLinkMetrics

enum otLinkMetricsStatus otLinkMetricsStatus

ค่าสถานะเมตริกเมตริก

otLinkMetricsValues

struct otLinkMetricsValues otLinkMetricsValues

โครงสร้างนี้แสดงผลการค้นหา (ค่า) สําหรับการค้นหาเมตริกลิงก์

ฟังก์ชัน

otLinkMetricsConfigEnhAckProbing

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

ฟังก์ชันนี้ส่งคําขอการจัดการเมตริกลิงก์ MLE เพื่อกําหนดค่า/ล้างการตรวจสอบแบบขั้นสูง

ฟังก์ชันนี้ต้องเปิดใช้ฟีเจอร์ OT_LINK_METRICS_InitialTOR

รายละเอียด
พารามิเตอร์
[in] aInstance
ตัวชี้ไปยังอินสแตนซ์ OpenThread
[in] aDestination
ตัวชี้ไปยังที่อยู่ปลายทาง
[in] aEnhAckFlags
แฟล็ก Enh-ACK เพื่อระบุว่าควรลงทะเบียนหรือล้างการตรวจสอบ 0 เพื่อล้างข้อมูลและ 1 เพื่อลงทะเบียน ส่วนค่าอื่นๆ ที่สงวนไว้
[in] aLinkMetricsFlags
ตัวชี้ไปยังธงเพื่อแจ้งเมตริกที่ต้องการค้นหา ควรเป็น NULL เมื่อ aEnhAckFlags เท่ากับ 0
[in] aCallback
ตัวชี้ไปยังฟังก์ชันที่เรียกใช้เมื่อได้รับเมตริกที่ปรับปรุงแล้วพร้อมเมตริกลิงก์
[in] aCallbackContext
ตัวชี้ไปยังบริบทเฉพาะแอปพลิเคชัน
แสดงผลค่า
OT_ERROR_NONE
ส่งข้อความคําขอการจัดการเมตริกลิงก์เรียบร้อยแล้ว
OT_ERROR_NO_BUFS
บัฟเฟอร์ไม่เพียงพอที่จะสร้างข้อความคําขอการจัดการเมตริก MLE ลิงก์
OT_ERROR_INVALID_ARGS
aEnhAckFlags ไม่ใช่ค่าที่ถูกต้อง หรือ aLinkMetricsFlags ไม่ถูกต้อง
OT_ERROR_UNKNOWN_NEIGHBOR
aDestination ไม่ใช่ลิงก์ภายในเครื่องหรือไม่พบเพื่อนบ้าน
OT_ERROR_NOT_CAPABLE
เพื่อนบ้านไม่ใช่อุปกรณ์เทรด 1.2 และไม่รองรับเมตริกลิงก์

otLinkMetricsConfigForwardTrackingSeries

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

ฟังก์ชันนี้ส่งคําขอการจัดการเมตริกลิงก์ MLE เพื่อกําหนดค่า/ล้างชุดการติดตามไปข้างหน้า

รายละเอียด
พารามิเตอร์
[in] aInstance
ตัวชี้ไปยังอินสแตนซ์ OpenThread
[in] aDestination
ตัวชี้ไปยังที่อยู่ปลายทาง
[in] aSeriesId
รหัสซีรีส์ที่จะดําเนินการด้วย
[in] aSeriesFlags
แฟล็กซีรี่ส์ที่ระบุว่าเฟรมใดที่ต้องนํามาพิจารณา
[in] aLinkMetricsFlags
ตัวชี้ไปยังธงเพื่อแจ้งเมตริกที่ต้องการค้นหา ควรเป็น NULL เมื่อ aSeriesFlags เท่ากับ 0
[in] aCallback
ตัวชี้ไปยังฟังก์ชันที่เรียกเมื่อได้รับการตอบกลับการจัดการเมตริกลิงก์
[in] aCallbackContext
ตัวชี้ไปยังบริบทเฉพาะแอปพลิเคชัน
แสดงผลค่า
OT_ERROR_NONE
ส่งข้อความคําขอการจัดการเมตริกลิงก์เรียบร้อยแล้ว
OT_ERROR_NO_BUFS
บัฟเฟอร์ไม่เพียงพอที่จะสร้างข้อความคําขอการจัดการเมตริก MLE ลิงก์
OT_ERROR_INVALID_ARGS
aSeriesId ไม่ได้อยู่ในช่วงที่ถูกต้อง
OT_ERROR_UNKNOWN_NEIGHBOR
aDestination ไม่ใช่ลิงก์ภายในเครื่องหรือไม่พบเพื่อนบ้าน
OT_ERROR_NOT_CAPABLE
เพื่อนบ้านไม่ใช่อุปกรณ์เทรด 1.2 และไม่รองรับเมตริกลิงก์

otLinkMetricsQuery

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

ฟังก์ชันนี้ส่งคําขอข้อมูล MLE เพื่อค้นหาเมตริกลิงก์

ซึ่งอาจเป็นชุดการตรวจสอบเดี่ยวหรือชุดการส่งต่อ

รายละเอียด
พารามิเตอร์
[in] aInstance
ตัวชี้ไปยังอินสแตนซ์ OpenThread
[in] aDestination
ตัวชี้ไปยังที่อยู่ปลายทาง
[in] aSeriesId
รหัสชุดที่จะค้นหาเป็น 0 สําหรับการตรวจสอบครั้งเดียว
[in] aLinkMetricsFlags
ตัวชี้ไปยังธงเพื่อแจ้งเมตริกที่ต้องการค้นหา
[in] aCallback
ตัวชี้ไปยังฟังก์ชันที่จะทํางานเมื่อได้รับรายงานเมตริกลิงก์
[in] aCallbackContext
ตัวชี้ไปยังบริบทเฉพาะแอปพลิเคชัน
แสดงผลค่า
OT_ERROR_NONE
ส่งข้อความค้นหาเมตริกเมตริกเรียบร้อยแล้ว
OT_ERROR_NO_BUFS
บัฟเฟอร์ไม่เพียงพอที่จะสร้างข้อความคําขอข้อมูล MLE
OT_ERROR_UNKNOWN_NEIGHBOR
aDestination ไม่ใช่ลิงก์ภายในเครื่องหรือไม่พบเพื่อนบ้าน
OT_ERROR_NOT_CAPABLE
เพื่อนบ้านไม่ใช่อุปกรณ์เทรด 1.2 และไม่รองรับเมตริกลิงก์

otLinkMetricsSendLinkProbe

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

ฟังก์ชันนี้จะส่งข้อความ Probe ของ MLE ลิงก์

รายละเอียด
พารามิเตอร์
[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
OT_ERROR_INVALID_ARGS
aSeriesId หรือ aLength ไม่อยู่ในช่วงที่ถูกต้อง
OT_ERROR_UNKNOWN_NEIGHBOR
aDestination ไม่ใช่ลิงก์ภายในเครื่องหรือไม่พบเพื่อนบ้าน
OT_ERROR_NOT_CAPABLE
เพื่อนบ้านไม่ใช่อุปกรณ์เทรด 1.2 และไม่รองรับเมตริกลิงก์

ทรัพยากร

หัวข้อการอ้างอิง OpenThread API มาจากซอร์สโค้ดซึ่งมีอยู่ใน GitHub โปรดดูข้อมูลเพิ่มเติมในหรือไปที่เอกสารประกอบที่แหล่งข้อมูล