Metrik Link

Modul ini mencakup fungsi yang mengontrol protokol Metrik Link.

Ringkasan

Enumerasi
otLinkMetricsEnhAckFlags{
  OT_LINK_METRICS_ENH_ACK_CLEAR = 0,
  OT_LINK_METRICS_ENH_ACK_REGISTER = 1
} 		enum
Tanda Enhanced-ACK.
otLinkMetricsStatus enum
Nilai Status Metrik Link.

Typedef
otLinkMetricsEnhAckFlags typedef
Tanda Enhanced-ACK.
otLinkMetricsEnhAckProbingIeReportCallback)(otShortAddress aShortAddress, const otExtAddress *aExtAddress, const otLinkMetricsValues *aMetricsValues, void *aContext) typedef
void(*
Pointer dipanggil ketika Enh-ACK Probing IE diterima.
otLinkMetricsMgmtResponseCallback)(const otIp6Address *aSource, otLinkMetricsStatus aStatus, void *aContext) typedef
void(*
Pointer dipanggil saat Respons Pengelolaan Metrik Link diterima.
otLinkMetricsReportCallback)(const otIp6Address *aSource, const otLinkMetricsValues *aMetricsValues, otLinkMetricsStatus aStatus, void *aContext) typedef
void(*
Pointer dipanggil saat laporan Metrik Link diterima.
otLinkMetricsSeriesFlags typedef
Mewakili frame yang diperhitungkan dalam Forward Tracking Series.
otLinkMetricsStatus typedef
Nilai Status Metrik Link.
otLinkMetricsValues typedef
Mewakili hasil (nilai) untuk kueri Metrik Link.

Fungsi
otLinkMetricsConfigEnhAckProbing(otInstance *aInstance, const otIp6Address *aDestination, otLinkMetricsEnhAckFlags aEnhAckFlags, const otLinkMetrics *aLinkMetricsFlags, otLinkMetricsMgmtResponseCallback aCallback, void *aCallbackContext, otLinkMetricsEnhAckProbingIeReportCallback aEnhAckCallback, void *aEnhAckCallbackContext)
Mengirimkan Permintaan Pengelolaan Metrik Link MLE untuk mengonfigurasi/menghapus Pemeriksaan Berbasis Enhanced-ACK.
otLinkMetricsConfigForwardTrackingSeries(otInstance *aInstance, const otIp6Address *aDestination, uint8_t aSeriesId, otLinkMetricsSeriesFlags aSeriesFlags, const otLinkMetrics *aLinkMetricsFlags, otLinkMetricsMgmtResponseCallback aCallback, void *aCallbackContext)
Mengirimkan Permintaan Pengelolaan Metrik Link MLE untuk mengonfigurasi atau menghapus Rangkaian Pelacakan Teruskan.
otLinkMetricsManagerGetMetricsValueByExtAddr(otInstance *aInstance, const otExtAddress *aExtAddress, otLinkMetricsValues *aLinkMetricsValues)
Mendapatkan data Metrik Link tetangga berdasarkan alamat diperluasnya.
otLinkMetricsManagerSetEnabled(otInstance *aInstance, bool aEnable)
void
Aktifkan atau nonaktifkan Pengelola Metrik Link.
otLinkMetricsQuery(otInstance *aInstance, const otIp6Address *aDestination, uint8_t aSeriesId, const otLinkMetrics *aLinkMetricsFlags, otLinkMetricsReportCallback aCallback, void *aCallbackContext)
Mengirim Permintaan Data MLE untuk mengkueri Metrik Link.
otLinkMetricsSendLinkProbe(otInstance *aInstance, const otIp6Address *aDestination, uint8_t aSeriesId, uint8_t aLength)
Mengirim pesan Pemeriksaan Link MLE.

Struct
otLinkMetricsSeriesFlags

Mewakili frame yang diperhitungkan dalam Forward Tracking Series.

otLinkMetricsValues

Mewakili hasil (nilai) untuk kueri Metrik Link.

Enumerasi

otLinkMetricsEnhAckFlags

 otLinkMetricsEnhAckFlags

Tanda Enhanced-ACK.

Ini digunakan dalam Probing Berbasis Enhanced-ACK untuk menunjukkan apakah akan mendaftarkan atau menghapus pemeriksaan.

Properti
OT_LINK_METRICS_ENH_ACK_CLEAR

Jelas.

OT_LINK_METRICS_ENH_ACK_REGISTER

Daftar.

otLinkMetricsStatus

 otLinkMetricsStatus

Nilai Status Metrik Link.

Typedef

otLinkMetricsEnhAckFlags

enum otLinkMetricsEnhAckFlags otLinkMetricsEnhAckFlags

Tanda Enhanced-ACK.

Ini digunakan dalam Probing Berbasis Enhanced-ACK untuk menunjukkan apakah akan mendaftarkan atau menghapus pemeriksaan.

otLinkMetricsEnhAckProbingIeReportCallback

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

Pointer dipanggil ketika Enh-ACK Probing IE diterima.

Detail
Parameter
[in] aShortAddress
Alamat singkat Mac dari Subjek Pemeriksaan.
[in] aExtAddress
Penunjuk ke alamat MAC yang diperluas dari Subjek Pemeriksaan.
[in] aMetricsValues
Pointer ke nilai Metrik Link yang diperoleh dari IE.
[in] aContext
Pointer ke konteks khusus aplikasi.

otLinkMetricsMgmtResponseCallback

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

Pointer dipanggil saat Respons Pengelolaan Metrik Link diterima.

Detail
Parameter
[in] aSource
Pointer ke alamat sumber.
[in] aStatus
Kode status dalam respons.
[in] aContext
Pointer ke konteks khusus aplikasi.

otLinkMetricsReportCallback

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

Pointer dipanggil saat laporan Metrik Link diterima.

Detail
Parameter
[in] aSource
Pointer ke alamat sumber.
[in] aMetricsValues
Pointer ke nilai Metrik Link (hasil kueri).
[in] aStatus
Kode status dalam laporan (hanya berguna jika aMetricsValues adalah NULL).
[in] aContext
Pointer ke konteks khusus aplikasi.

otLinkMetricsSeriesFlags

struct otLinkMetricsSeriesFlags otLinkMetricsSeriesFlags

Mewakili frame yang diperhitungkan dalam Forward Tracking Series.

otLinkMetricsStatus

enum otLinkMetricsStatus otLinkMetricsStatus

Nilai Status Metrik Link.

otLinkMetricsValues

struct otLinkMetricsValues otLinkMetricsValues

Mewakili hasil (nilai) untuk kueri Metrik Link.

Fungsi

otLinkMetricsConfigEnhAckProbing

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

Mengirimkan Permintaan Pengelolaan Metrik Link MLE untuk mengonfigurasi/menghapus Pemeriksaan Berbasis Enhanced-ACK.

Fungsi ini mengharuskan fitur OT_LINK_METRICS_INITIATOR diaktifkan.

Detail
Parameter
[in] aInstance
Pointer ke instance OpenThread.
[in] aDestination
Pointer ke alamat tujuan.
[in] aEnhAckFlags
Tanda Enh-ACK untuk menunjukkan apakah akan mendaftarkan atau menghapus pemeriksaan. 0 untuk dihapus dan 1 untuk mendaftar. Nilai lainnya dicadangkan.
[in] aLinkMetricsFlags
Pointer ke flag yang menentukan metrik apa yang akan dikueri. Harus NULL jika aEnhAckFlags adalah 0.
[in] aCallback
Pointer ke fungsi yang dipanggil saat Metrik Link yang Ditingkatkan dengan Link diterima.
[in] aCallbackContext
Pointer ke konteks khusus aplikasi.
Nilai Pengembalian
OT_ERROR_NONE
Berhasil mengirim pesan Permintaan Pengelolaan Metrik Link.
OT_ERROR_NO_BUFS
Buffer tidak cukup untuk membuat pesan Permintaan Pengelolaan Metrik Link MLE.
OT_ERROR_INVALID_ARGS
aEnhAckFlags bukan nilai yang valid atau aLinkMetricsFlags tidak benar.
OT_ERROR_UNKNOWN_NEIGHBOR
aDestination bukan link-local atau tetangganya tidak ditemukan.
OT_ERROR_NOT_CAPABLE
Tetangga bukan perangkat Thread 1.2 dan tidak mendukung Metrik Link.

otLinkMetricsConfigForwardTrackingSeries

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

Mengirimkan Permintaan Pengelolaan Metrik Link MLE untuk mengonfigurasi atau menghapus Rangkaian Pelacakan Teruskan.

Detail
Parameter
[in] aInstance
Pointer ke instance OpenThread.
[in] aDestination
Pointer ke alamat tujuan.
[in] aSeriesId
ID Serial yang akan digunakan.
[in] aSeriesFlags
Flag Seri yang menentukan frame yang akan diperhitungkan.
[in] aLinkMetricsFlags
Pointer ke flag yang menentukan metrik apa yang akan dikueri. Harus NULL jika aSeriesFlags adalah 0.
[in] aCallback
Pointer ke fungsi yang dipanggil saat Respons Pengelolaan Metrik Link diterima.
[in] aCallbackContext
Pointer ke konteks khusus aplikasi.
Nilai Pengembalian
OT_ERROR_NONE
Berhasil mengirim pesan Permintaan Pengelolaan Metrik Link.
OT_ERROR_NO_BUFS
Buffer tidak cukup untuk membuat pesan Permintaan Pengelolaan Metrik Link MLE.
OT_ERROR_INVALID_ARGS
aSeriesId tidak berada dalam rentang yang valid.
OT_ERROR_UNKNOWN_NEIGHBOR
aDestination bukan link-local atau tetangganya tidak ditemukan.
OT_ERROR_NOT_CAPABLE
Tetangga bukan perangkat Thread 1.2 dan tidak mendukung Metrik Link.

otLinkMetricsManagerGetMetricsValueByExtAddr

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

Mendapatkan data Metrik Link tetangga berdasarkan alamat diperluasnya.

Detail
Parameter
[in] aInstance
Pointer ke instance OpenThread.
[in] aExtAddress
Penunjuk ke alamat MAC yang diperluas dari Subjek Pemeriksaan.
[out] aLinkMetricsValues
Pointer ke nilai Metrik Link subjek.
Nilai Pengembalian
OT_ERROR_NONE
Berhasil mendapatkan data Metrik Link.
OT_ERROR_INVALID_ARGS
Argumen tidak valid.
OT_ERROR_NOT_FOUND
Tidak ada tetangga dengan alamat lengkap yang diberikan.

otLinkMetricsManagerSetEnabled

void otLinkMetricsManagerSetEnabled(
  otInstance *aInstance,
  bool aEnable
)

Aktifkan atau nonaktifkan Pengelola Metrik Link.

Detail
Parameter
[in] aInstance
Pointer ke instance OpenThread.
[in] aEnable
Boolean yang menunjukkan untuk mengaktifkan atau menonaktifkan.

otLinkMetricsQuery

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

Mengirim Permintaan Data MLE untuk mengkueri Metrik Link.

Bisa jadi Satu Probe atau Rangkaian Pelacakan Teruskan.

Detail
Parameter
[in] aInstance
Pointer ke instance OpenThread.
[in] aDestination
Pointer ke alamat tujuan.
[in] aSeriesId
ID Serial yang akan dikueri, 0 untuk Satu Probe.
[in] aLinkMetricsFlags
Pointer ke flag yang menentukan metrik apa yang akan dikueri.
[in] aCallback
Pointer ke fungsi yang dipanggil saat laporan Metrik Link diterima.
[in] aCallbackContext
Pointer ke konteks khusus aplikasi.
Nilai Pengembalian
OT_ERROR_NONE
Berhasil mengirim pesan kueri Metrik Link.
OT_ERROR_NO_BUFS
Buffering tidak cukup untuk menghasilkan pesan Permintaan Data MLE.
OT_ERROR_UNKNOWN_NEIGHBOR
aDestination bukan link-local atau tetangganya tidak ditemukan.
OT_ERROR_NOT_CAPABLE
Tetangga bukan perangkat Thread 1.2 dan tidak mendukung Metrik Link.

otLinkMetricsSendLinkProbe

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

Mengirim pesan Pemeriksaan Link MLE.

Detail
Parameter
[in] aInstance
Pointer ke instance OpenThread.
[in] aDestination
Pointer ke alamat tujuan.
[in] aSeriesId
ID Seri [1, 254] yang menjadi tujuan pesan Probe.
[in] aLength
Panjang payload data di Link Probe TLV, 0, 64.
Nilai Pengembalian
OT_ERROR_NONE
Berhasil mengirim pesan Pemeriksaan Link.
OT_ERROR_NO_BUFS
Buffering tidak cukup untuk menghasilkan pesan Probe Link MLE.
OT_ERROR_INVALID_ARGS
aSeriesId atau aLength tidak berada dalam rentang yang valid.
OT_ERROR_UNKNOWN_NEIGHBOR
aDestination bukan link-local atau tetangganya tidak ditemukan.
OT_ERROR_NOT_CAPABLE
Tetangga bukan perangkat Thread 1.2 dan tidak mendukung Metrik Link.

Referensi

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