Router graniczny

Ten moduł zawiera funkcje zarządzania danymi o sieci lokalnej za pomocą routera granicznego OpenThread.

Podsumowanie

Definicja typów
otBorderRouterNetDataFullCallback)(void *aContext) definicja typu
void(*
Wywołanie wskaźnika funkcji jest wywoływane, gdy dane sieciowe (lokalne lub lidera) są pełne.

Funkcje
otBorderRouterAddOnMeshPrefix(otInstance *aInstance, const otBorderRouterConfig *aConfig)
Dodaj konfigurację routera granicznego do danych sieci lokalnej.
otBorderRouterAddRoute(otInstance *aInstance, const otExternalRouteConfig *aConfig)
dodać zewnętrzną konfigurację tras do danych w sieci lokalnej,
otBorderRouterGetNetData(otInstance *aInstance, bool aStable, uint8_t *aData, uint8_t *aDataLength)
Zapewnia pełną lub stabilną kopię danych z sieci lokalnej.
otBorderRouterGetNextOnMeshPrefix(otInstance *aInstance, otNetworkDataIterator *aIterator, otBorderRouterConfig *aConfig)
Pobiera następny prefiks On Mesh w danych sieci lokalnej.
otBorderRouterGetNextRoute(otInstance *aInstance, otNetworkDataIterator *aIterator, otExternalRouteConfig *aConfig)
Pobiera następną trasę zewnętrzną w danych sieci lokalnej.
otBorderRouterRegister(otInstance *aInstance)
Od razu zarejestruj dane sieci lokalnej w liderze.
otBorderRouterRemoveOnMeshPrefix(otInstance *aInstance, const otIp6Prefix *aPrefix)
Usuń konfigurację routera granicznego z danych sieci lokalnej.
otBorderRouterRemoveRoute(otInstance *aInstance, const otIp6Prefix *aPrefix)
Usuń konfigurację trasy zewnętrznej z danych sieci lokalnej.
otBorderRouterSetNetDataFullCallback(otInstance *aInstance, otBorderRouterNetDataFullCallback aCallback, void *aContext)
void
Ustawia wywołanie zwrotne wskazujące, że dane sieci są pełne.

Definicja typów

Funkcja otBorderRouterNetDataFullCallback

void(* otBorderRouterNetDataFullCallback)(void *aContext)

Wywołanie wskaźnika funkcji jest wywoływane, gdy dane sieciowe (lokalne lub lidera) są pełne.

Szczegóły
Parametry
[in] aContext
Wskaźnik do dowolnych informacji kontekstowych.

Funkcje

OTBorderRouterAddOnMeshPrefiks

otError otBorderRouterAddOnMeshPrefix(
  otInstance *aInstance,
  const otBorderRouterConfig *aConfig
)

Dodaj konfigurację routera granicznego do danych sieci lokalnej.

Szczegóły
Parametry
[in] aInstance
Wskaźnik do instancji OpenThread.
[in] aConfig
Wskaźnik do konfiguracji routera granicznego.
Wartości zwracane
OT_ERROR_NONE
Konfiguracja została dodana do danych sieci lokalnej.
OT_ERROR_INVALID_ARGS
Co najmniej 1 parametr konfiguracji jest nieprawidłowy.
OT_ERROR_NO_BUFS
Za mało miejsca, aby dodać konfigurację do danych sieci lokalnej.
Zobacz też:
otBorderRouterRemoveOnMeshPrefiks
otBorderRouterRegister

TrasaBotBorderRouterAddRoute

otError otBorderRouterAddRoute(
  otInstance *aInstance,
  const otExternalRouteConfig *aConfig
)

dodać zewnętrzną konfigurację tras do danych w sieci lokalnej,

Szczegóły
Parametry
[in] aInstance
Wskaźnik do instancji OpenThread.
[in] aConfig
Wskaźnik zewnętrznej konfiguracji trasy.
Wartości zwracane
OT_ERROR_NONE
Konfiguracja została dodana do danych sieci lokalnej.
OT_ERROR_INVALID_ARGS
Co najmniej 1 parametr konfiguracji jest nieprawidłowy.
OT_ERROR_NO_BUFS
Za mało miejsca, aby dodać konfigurację do danych sieci lokalnej.
Zobacz też:
otBorderRouterRemoveRoute
otBorderRouterRegister

OtBorderRouterGetNetData

otError otBorderRouterGetNetData(
  otInstance *aInstance,
  bool aStable,
  uint8_t *aData,
  uint8_t *aDataLength
)

Zapewnia pełną lub stabilną kopię danych z sieci lokalnej.

Szczegóły
Parametry
[in] aInstance
Wskaźnik do instancji OpenThread.
[in] aStable
TRUE podczas kopiowania wersji stabilnej, a FALSE w przypadku kopiowania pełnej wersji.
[out] aData
Wskaźnik do bufora danych.
[in,out] aDataLength
Rozmiar bufora danych podany przez aData. Przy wyjściu wyświetlana jest liczba skopiowanych bajtów.

OTBorderRouterGetNextOnMeshPrefiks

otError otBorderRouterGetNextOnMeshPrefix(
  otInstance *aInstance,
  otNetworkDataIterator *aIterator,
  otBorderRouterConfig *aConfig
)

Pobiera następny prefiks On Mesh w danych sieci lokalnej.

Szczegóły
Parametry
[in] aInstance
Wskaźnik do instancji OpenThread.
[in,out] aIterator
Wskazanie kontekstu iteratora danych sieci. Aby uzyskać pierwszy wpis w sieci typu mesh, ustaw go na OT_NETWORK_DATA_ITERATOR_INIT.
[out] aConfig
Wskaźnik do informacji o prefiksie sieci typu mesh.
Wartości zwracane
OT_ERROR_NONE
Następny prefiks w sieci typu mesh został znaleziony.
OT_ERROR_NOT_FOUND
W danych sieci dotyczących wątków nie ma takiego prefiksu.

TrasaBotBorderRouterGetNextRoute

otError otBorderRouterGetNextRoute(
  otInstance *aInstance,
  otNetworkDataIterator *aIterator,
  otExternalRouteConfig *aConfig
)

Pobiera następną trasę zewnętrzną w danych sieci lokalnej.

Szczegóły
Parametry
[in] aInstance
Wskaźnik do instancji OpenThread.
[in,out] aIterator
Wskazanie kontekstu iteratora danych sieci. Aby uzyskać pierwszy wpis z trasą zewnętrzną, ustaw go na OT_NETWORK_DATA_ITERATOR_INIT.
[out] aConfig
Wskaźnik do informacji o trasie zewnętrznej.
Wartości zwracane
OT_ERROR_NONE
Udało się znaleźć następną trasę zewnętrzną.
OT_ERROR_NOT_FOUND
Brak danych dotyczących dalszych tras zewnętrznych w danych sieci dotyczących wątków.

TrasaBotBorderRouterRegister

otError otBorderRouterRegister(
  otInstance *aInstance
)

Od razu zarejestruj dane sieci lokalnej w liderze.

Szczegóły
Parametry
[in] aInstance
Wskaźnik do instancji OpenThread.
Wartości zwracane
OT_ERROR_NONE
Umieszczono w kolejce wiadomość z żądaniami przesłania danych serwera.
Zobacz też:
otBorderRouterAddOnMeshPrefiks
otBorderRouterRemoveOnMeshPrefiks
otBorderRouterAddRoute
otBorderRouterRemoveRoute

OTBorderRouterRemoveOnMeshPrefiks

otError otBorderRouterRemoveOnMeshPrefix(
  otInstance *aInstance,
  const otIp6Prefix *aPrefix
)

Usuń konfigurację routera granicznego z danych sieci lokalnej.

Szczegóły
Parametry
[in] aInstance
Wskaźnik do instancji OpenThread.
[in] aPrefix
Wskaźnik określający prefiks IPv6.
Wartości zwracane
OT_ERROR_NONE
Konfiguracja została usunięta z danych sieci lokalnej.
OT_ERROR_NOT_FOUND
Nie można znaleźć wpisu routera granicznego.
Zobacz też:
otBorderRouterAddOnMeshPrefiks
otBorderRouterRegister

TrasaBotBorderRouterRemoveRoute

otError otBorderRouterRemoveRoute(
  otInstance *aInstance,
  const otIp6Prefix *aPrefix
)

Usuń konfigurację trasy zewnętrznej z danych sieci lokalnej.

Szczegóły
Parametry
[in] aInstance
Wskaźnik do instancji OpenThread.
[in] aPrefix
Wskaźnik określający prefiks IPv6.
Wartości zwracane
OT_ERROR_NONE
Konfiguracja została usunięta z danych sieci lokalnej.
OT_ERROR_NOT_FOUND
Nie można znaleźć wpisu routera granicznego.
Zobacz też:
otBorderRouterAddRoute
otBorderRouterRegister

OTBorderRouterSetNetDataFullCallback

void otBorderRouterSetNetDataFullCallback(
  otInstance *aInstance,
  otBorderRouterNetDataFullCallback aCallback,
  void *aContext
)

Ustawia wywołanie zwrotne wskazujące, że dane sieci są pełne.

Wymagane: OPENTHREAD_CONFIG_BORDER_ROUTER_SIGNAL_NETWORK_DATA_FULL.

Wywołanie zwrotne jest wywoływane zawsze, gdy:

  • Urządzenie działa jako lider i otrzymuje z sieci routera granicznego rejestrację danych sieciowych, których nie może dodać do danych sieciowych (braku miejsca).
  • Urządzenie działa jako BR i nie można dodawać nowych wpisów do danych lokalnych sieci.
  • Urządzenie działa jak BR i próbuje zarejestrować swoje wpisy danych lokalnych sieci u lidera, ale stwierdza, że wpisy lokalne nie będą pasować.

Szczegóły
Parametry
[in] aInstance
Wskaźnik do instancji OpenThread.
[in] aCallback
Oddzwonienie.
[in] aContext
Wskaźnik do dowolnych informacji kontekstowych używanych w narzędziu aCallback.

Zasoby

Tematy referencyjne interfejsu API OpenThread pochodzą z kodu źródłowego dostępnego w GitHub. Aby dowiedzieć się więcej lub dodać treści do naszej dokumentacji, zapoznaj się z materiałami.