Dane linku

Ten moduł obejmuje funkcje, które kontrolują protokół Link Metrics.

Podsumowanie

Wyliczenia
otLinkMetricsEnhAckFlags{
  OT_LINK_METRICS_ENH_ACK_CLEAR = 0,
  OT_LINK_METRICS_ENH_ACK_REGISTER = 1
} 		enum | typ wyliczeniowy
Flagi rozszerzonego potwierdzenia.
otLinkMetricsStatus enum | typ wyliczeniowy
Wartości stanu danych połączenia.

Definicje typów
otLinkMetricsEnhAckFlags typedef
Flagi rozszerzonego potwierdzenia.
otLinkMetricsEnhAckProbingIeReportCallback)(otShortAddress aShortAddress, const otExtAddress *aExtAddress, const otLinkMetricsValues *aMetricsValues, void *aContext) typedef
void(*
Wskaźnik jest wywoływany po otrzymaniu kodu Enh-ACK Probing IE.
otLinkMetricsMgmtResponseCallback)(const otIp6Address *aSource, otLinkMetricsStatus aStatus, void *aContext) typedef
void(*
Wskaźnik jest wywoływany po otrzymaniu odpowiedzi zarządzania wskaźnikami linków.
otLinkMetricsReportCallback)(const otIp6Address *aSource, const otLinkMetricsValues *aMetricsValues, otLinkMetricsStatus aStatus, void *aContext) typedef
void(*
Wskaźnik jest wywoływany po odebraniu raportu Dane linku.
otLinkMetricsSeriesFlags typedef
Reprezentuje, które klatki są uwzględniane w serii śledzenia zapowiedzi.
otLinkMetricsStatus typedef
Wartości stanu danych połączenia.
otLinkMetricsValues typedef
Reprezentuje wynik (wartość) zapytania w usłudze Link Metrics.

Funkcje
otLinkMetricsConfigEnhAckProbing(otInstance *aInstance, const otIp6Address *aDestination, otLinkMetricsEnhAckFlags aEnhAckFlags, const otLinkMetrics *aLinkMetricsFlags, otLinkMetricsMgmtResponseCallback aCallback, void *aCallbackContext, otLinkMetricsEnhAckProbingIeReportCallback aEnhAckCallback, void *aEnhAckCallbackContext)
Wysyła żądanie zarządzania wskaźnikami linków MLE w celu skonfigurowania/usunięcia sondowania opartego na potwierdzeniu potwierdzenia.
otLinkMetricsConfigForwardTrackingSeries(otInstance *aInstance, const otIp6Address *aDestination, uint8_t aSeriesId, otLinkMetricsSeriesFlags aSeriesFlags, const otLinkMetrics *aLinkMetricsFlags, otLinkMetricsMgmtResponseCallback aCallback, void *aCallbackContext)
Wysyła żądanie zarządzania wskaźnikami połączeń MLE w celu skonfigurowania lub wyczyszczenia serii śledzenia Forward.
otLinkMetricsManagerGetMetricsValueByExtAddr(otInstance *aInstance, const otExtAddress *aExtAddress, otLinkMetricsValues *aLinkMetricsValues)
Pobieranie danych wskaźników linków sąsiada na podstawie jego rozszerzonego adresu.
otLinkMetricsManagerSetEnabled(otInstance *aInstance, bool aEnable)
void
Włącz lub wyłącz menedżera wskaźników połączeń.
otLinkMetricsQuery(otInstance *aInstance, const otIp6Address *aDestination, uint8_t aSeriesId, const otLinkMetrics *aLinkMetricsFlags, otLinkMetricsReportCallback aCallback, void *aCallbackContext)
Wysyła żądanie danych MLE, aby wysyłać zapytania dotyczące wskaźników linku.
otLinkMetricsSendLinkProbe(otInstance *aInstance, const otIp6Address *aDestination, uint8_t aSeriesId, uint8_t aLength)
Wysyła wiadomość sondy linku MLE.

Konstrukcja
otLinkMetricsSeriesFlags

Reprezentuje, które klatki są uwzględniane w serii śledzenia zapowiedzi.

otLinkMetricsValues

Reprezentuje wynik (wartość) zapytania w usłudze Link Metrics.

Wyliczenia

otLinkMetricsEnhAckFlags

 otLinkMetricsEnhAckFlags

Flagi rozszerzonego potwierdzenia.

Są one używane w sondowaniu na podstawie rozszerzonego potwierdzenia do wskazywania, czy należy zarejestrować, czy wyczyścić sondowanie.

Właściwości
OT_LINK_METRICS_ENH_ACK_CLEAR

Przejrzystość.

OT_LINK_METRICS_ENH_ACK_REGISTER

Zarejestruj się.

otLinkMetricsStatus

 otLinkMetricsStatus

Wartości stanu danych połączenia.

Definicje typów

otLinkMetricsEnhAckFlags

enum otLinkMetricsEnhAckFlags otLinkMetricsEnhAckFlags

Flagi rozszerzonego potwierdzenia.

Są one używane w sondowaniu na podstawie rozszerzonego potwierdzenia do wskazywania, czy należy zarejestrować, czy wyczyścić sondowanie.

otLinkMetricsEnhAckProbingIeReportCallback

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

Wskaźnik jest wywoływany po otrzymaniu kodu Enh-ACK Probing IE.

Szczegóły
Parametry
[in] aShortAddress
Krótki adres MAC tematu badania.
[in] aExtAddress
Wskaźnik do rozszerzonego adresu Mac podmiotu sondacyjnego.
[in] aMetricsValues
Wskaźnik do wartości danych linków uzyskanych z IE.
[in] aContext
Wskaźnik do kontekstu aplikacji.

otLinkMetricsMgmtResponseCallback

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

Wskaźnik jest wywoływany po otrzymaniu odpowiedzi zarządzania wskaźnikami linków.

Szczegóły
Parametry
[in] aSource
Wskaźnik do adresu źródłowego.
[in] aStatus
Kod stanu w odpowiedzi.
[in] aContext
Wskaźnik do kontekstu aplikacji.

otLinkMetricsReportCallback

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

Wskaźnik jest wywoływany po odebraniu raportu Dane linku.

Szczegóły
Parametry
[in] aSource
Wskaźnik do adresu źródłowego.
[in] aMetricsValues
Wskaźnik do wartości Połącz dane (wyniku zapytania).
[in] aStatus
Kod stanu w raporcie (przydatny tylko wtedy, gdy aMetricsValues ma wartość NULL).
[in] aContext
Wskaźnik do kontekstu aplikacji.

otLinkMetricsSeriesFlags

struct otLinkMetricsSeriesFlags otLinkMetricsSeriesFlags

Reprezentuje, które klatki są uwzględniane w serii śledzenia zapowiedzi.

otLinkMetricsStatus

enum otLinkMetricsStatus otLinkMetricsStatus

Wartości stanu danych połączenia.

otLinkMetricsValues

struct otLinkMetricsValues otLinkMetricsValues

Reprezentuje wynik (wartość) zapytania w usłudze Link Metrics.

Funkcje

otLinkMetricsConfigEnhAckProbing

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

Wysyła żądanie zarządzania wskaźnikami linków MLE w celu skonfigurowania/usunięcia sondowania opartego na potwierdzeniu potwierdzenia.

Ta funkcja wymaga włączonej funkcji OT_LINK_METRICS_INITIATOR.

Szczegóły
Parametry
[in] aInstance
Wskaźnik do instancji OpenThread.
[in] aDestination
Wskaźnik do adresu docelowego.
[in] aEnhAckFlags
Flagi Enh-ACK wskazujące, czy należy zarejestrować, czy wyczyścić sondowanie. 0 do wyczyszczenia i 1, aby się zarejestrować. Inne wartości są zastrzeżone.
[in] aLinkMetricsFlags
Wskaźnik do flag określających wskaźniki, których ma dotyczyć zapytanie. Wartość powinna wynosić NULL, gdy aEnhAckFlags ma wartość 0.
[in] aCallback
Wskaźnik do funkcji, która jest wywoływana po odebraniu ulepszonego potwierdzenia ze wskaźnikami połączeń.
[in] aCallbackContext
Wskaźnik do kontekstu aplikacji.
Zwracane wartości
OT_ERROR_NONE
Wysłano wiadomość z prośbą o zarządzanie wskaźnikami połączenia.
OT_ERROR_NO_BUFS
Niewystarczająca ilość buforów, aby wygenerować komunikat żądania zarządzania wskaźnikami połączeń MLE.
OT_ERROR_INVALID_ARGS
aEnhAckFlags nie jest prawidłową wartością lub aLinkMetricsFlags nie jest poprawna.
OT_ERROR_UNKNOWN_NEIGHBOR
aDestination nie ma wartości link-local lub nie znaleziono sąsiada.
OT_ERROR_NOT_CAPABLE
Sąsiad nie jest urządzeniem z Thread 1.2 i nie obsługuje wskaźników linków.

otLinkMetricsConfigForwardTrackingSeries

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

Wysyła żądanie zarządzania wskaźnikami połączeń MLE w celu skonfigurowania lub wyczyszczenia serii śledzenia Forward.

Szczegóły
Parametry
[in] aInstance
Wskaźnik do instancji OpenThread.
[in] aDestination
Wskaźnik do adresu docelowego.
[in] aSeriesId
Identyfikator serii, którego ma dotyczyć operacja.
[in] aSeriesFlags
Flagi serii określające klatki, które mają być uwzględniane.
[in] aLinkMetricsFlags
Wskaźnik do flag określających wskaźniki, których ma dotyczyć zapytanie. Wartość powinna wynosić NULL, gdy aSeriesFlags ma wartość 0.
[in] aCallback
Wskaźnik do funkcji, która jest wywoływana po otrzymaniu odpowiedzi zarządzania wskaźnikami linków.
[in] aCallbackContext
Wskaźnik do kontekstu aplikacji.
Zwracane wartości
OT_ERROR_NONE
Wysłano wiadomość z prośbą o zarządzanie wskaźnikami połączenia.
OT_ERROR_NO_BUFS
Niewystarczająca ilość buforów, aby wygenerować komunikat żądania zarządzania wskaźnikami połączeń MLE.
OT_ERROR_INVALID_ARGS
aSeriesId jest poza dozwolonym zakresem.
OT_ERROR_UNKNOWN_NEIGHBOR
aDestination nie ma wartości link-local lub nie znaleziono sąsiada.
OT_ERROR_NOT_CAPABLE
Sąsiad nie jest urządzeniem z Thread 1.2 i nie obsługuje wskaźników linków.

otLinkMetricsManagerGetMetricsValueByExtAddr

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

Pobieranie danych wskaźników linków sąsiada na podstawie jego rozszerzonego adresu.

Szczegóły
Parametry
[in] aInstance
Wskaźnik do instancji OpenThread.
[in] aExtAddress
Wskaźnik do rozszerzonego adresu Mac podmiotu sondacyjnego.
[out] aLinkMetricsValues
Wskaźnik do wartości danych linku podmiotu.
Zwracane wartości
OT_ERROR_NONE
Udało się pobrać dane dotyczące linków.
OT_ERROR_INVALID_ARGS
Argumenty są nieprawidłowe.
OT_ERROR_NOT_FOUND
Nie znaleziono sąsiada o podanym adresie rozszerzonym.

otLinkMetricsManagerSetEnabled

void otLinkMetricsManagerSetEnabled(
  otInstance *aInstance,
  bool aEnable
)

Włącz lub wyłącz menedżera wskaźników połączeń.

Szczegóły
Parametry
[in] aInstance
Wskaźnik do instancji OpenThread.
[in] aEnable
Wartość logiczna wskazująca, że należy włączyć lub wyłączyć urządzenie.

otLinkMetricsQuery

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

Wysyła żądanie danych MLE, aby wysyłać zapytania dotyczące wskaźników linku.

Może to być jedna sonda lub serie śledzenia wyprzedzające.

Szczegóły
Parametry
[in] aInstance
Wskaźnik do instancji OpenThread.
[in] aDestination
Wskaźnik do adresu docelowego.
[in] aSeriesId
Identyfikator serii, której dotyczy zapytanie, 0 dla pojedynczej sond.
[in] aLinkMetricsFlags
Wskaźnik do flag określających wskaźniki, których ma dotyczyć zapytanie.
[in] aCallback
Wskaźnik do funkcji, która jest wywoływana po odebraniu raportu Dane linku.
[in] aCallbackContext
Wskaźnik do kontekstu aplikacji.
Zwracane wartości
OT_ERROR_NONE
Wysłano zapytanie dotyczące wskaźników linków.
OT_ERROR_NO_BUFS
Niewystarczająca ilość buforów, by wygenerować komunikat żądania danych MLE.
OT_ERROR_UNKNOWN_NEIGHBOR
aDestination nie ma wartości link-local lub nie znaleziono sąsiada.
OT_ERROR_NOT_CAPABLE
Sąsiad nie jest urządzeniem z Thread 1.2 i nie obsługuje wskaźników linków.

otLinkMetricsSendLinkProbe

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

Wysyła wiadomość sondy linku MLE.

Szczegóły
Parametry
[in] aInstance
Wskaźnik do instancji OpenThread.
[in] aDestination
Wskaźnik do adresu docelowego.
[in] aSeriesId
Identyfikator serii [1, 254], do którego skierowana jest wiadomość sondy.
[in] aLength
Długość ładunku danych w sondzie link TLV, 0, 64.
Zwracane wartości
OT_ERROR_NONE
Wysłano wiadomość sondy połączenia.
OT_ERROR_NO_BUFS
Niewystarczająca ilość buforów, aby wygenerować komunikat sondy linku MLE.
OT_ERROR_INVALID_ARGS
aSeriesId lub aLength jest poza dozwolonym zakresem.
OT_ERROR_UNKNOWN_NEIGHBOR
aDestination nie ma wartości link-local lub nie znaleziono sąsiada.
OT_ERROR_NOT_CAPABLE
Sąsiad nie jest urządzeniem z Thread 1.2 i nie obsługuje wskaźników linków.

Zasoby

Tematy referencyjne interfejsu OpenThread API pochodzą z kodu źródłowego dostępnego w GitHub. Aby dowiedzieć się więcej lub dołączyć do naszej dokumentacji, skorzystaj z sekcji Zasoby.