Instancja

Ten moduł zawiera funkcje sterujące instancją OpenThread.

streszczenie

Wyliczenia
anonymous enum { OT_CHANGED_IP6_ADDRESS_ADDED = 1 << 0, OT_CHANGED_IP6_ADDRESS_REMOVED = 1 << 1, OT_CHANGED_THREAD_ROLE = 1 << 2, OT_CHANGED_THREAD_LL_ADDR = 1 << 3, OT_CHANGED_THREAD_ML_ADDR = 1 << 4, OT_CHANGED_THREAD_RLOC_ADDED = 1 << 5, OT_CHANGED_THREAD_RLOC_REMOVED = 1 << 6, OT_CHANGED_THREAD_PARTITION_ID = 1 << 7, OT_CHANGED_THREAD_KEY_SEQUENCE_COUNTER = 1 << 8, OT_CHANGED_THREAD_NETDATA = 1 << 9, OT_CHANGED_THREAD_CHILD_ADDED = 1 << 10, OT_CHANGED_THREAD_CHILD_REMOVED = 1 << 11, OT_CHANGED_IP6_MULTICAST_SUBSCRIBED = 1 << 12, OT_CHANGED_IP6_MULTICAST_UNSUBSCRIBED = 1 << 13, OT_CHANGED_THREAD_CHANNEL = 1 << 14, OT_CHANGED_THREAD_PANID = 1 << 15, OT_CHANGED_THREAD_NETWORK_NAME = 1 << 16, OT_CHANGED_THREAD_EXT_PANID = 1 << 17, OT_CHANGED_MASTER_KEY = 1 << 18, OT_CHANGED_PSKC = 1 << 19, OT_CHANGED_SECURITY_POLICY = 1 << 20, OT_CHANGED_CHANNEL_MANAGER_NEW_CHANNEL = 1 << 21, OT_CHANGED_SUPPORTED_CHANNEL_MASK = 1 << 22, OT_CHANGED_COMMISSIONER_STATE = 1 << 23, OT_CHANGED_THREAD_NETIF_STATE = 1 << 24, OT_CHANGED_THREAD_BACKBONE_ROUTER_STATE = 1 << 25, OT_CHANGED_THREAD_BACKBONE_ROUTER_LOCAL = 1 << 26, OT_CHANGED_JOINER_STATE = 1 << 27, OT_CHANGED_ACTIVE_DATASET = 1 << 28, OT_CHANGED_PENDING_DATASET = 1 << 29 }	enum To wyliczenie definiuje flagi, które są przekazywane jako część `otStateChangedCallback` .

Wyliczenia

anonymous enum {
 OT_CHANGED_IP6_ADDRESS_ADDED = 1 << 0,
 OT_CHANGED_IP6_ADDRESS_REMOVED = 1 << 1,
 OT_CHANGED_THREAD_ROLE = 1 << 2,
 OT_CHANGED_THREAD_LL_ADDR = 1 << 3,
 OT_CHANGED_THREAD_ML_ADDR = 1 << 4,
 OT_CHANGED_THREAD_RLOC_ADDED = 1 << 5,
 OT_CHANGED_THREAD_RLOC_REMOVED = 1 << 6,
 OT_CHANGED_THREAD_PARTITION_ID = 1 << 7,
 OT_CHANGED_THREAD_KEY_SEQUENCE_COUNTER = 1 << 8,
 OT_CHANGED_THREAD_NETDATA = 1 << 9,
 OT_CHANGED_THREAD_CHILD_ADDED = 1 << 10,
 OT_CHANGED_THREAD_CHILD_REMOVED = 1 << 11,
 OT_CHANGED_IP6_MULTICAST_SUBSCRIBED = 1 << 12,
 OT_CHANGED_IP6_MULTICAST_UNSUBSCRIBED = 1 << 13,
 OT_CHANGED_THREAD_CHANNEL = 1 << 14,
 OT_CHANGED_THREAD_PANID = 1 << 15,
 OT_CHANGED_THREAD_NETWORK_NAME = 1 << 16,
 OT_CHANGED_THREAD_EXT_PANID = 1 << 17,
 OT_CHANGED_MASTER_KEY = 1 << 18,
 OT_CHANGED_PSKC = 1 << 19,
 OT_CHANGED_SECURITY_POLICY = 1 << 20,
 OT_CHANGED_CHANNEL_MANAGER_NEW_CHANNEL = 1 << 21,
 OT_CHANGED_SUPPORTED_CHANNEL_MASK = 1 << 22,
 OT_CHANGED_COMMISSIONER_STATE = 1 << 23,
 OT_CHANGED_THREAD_NETIF_STATE = 1 << 24,
 OT_CHANGED_THREAD_BACKBONE_ROUTER_STATE = 1 << 25,
 OT_CHANGED_THREAD_BACKBONE_ROUTER_LOCAL = 1 << 26,
 OT_CHANGED_JOINER_STATE = 1 << 27,
 OT_CHANGED_ACTIVE_DATASET = 1 << 28,
 OT_CHANGED_PENDING_DATASET = 1 << 29
 }

enum

To wyliczenie definiuje flagi, które są przekazywane jako część otStateChangedCallback .

Typedefs
`otChangedFlags`	typedef `uint32_t` Ten typ reprezentuje pole bitowe wskazujące określony stan / konfigurację, która uległa zmianie.
`otInstance`	typedef `struct otInstance` Ta struktura reprezentuje strukturę instancji OpenThread.
`otStateChangedCallback )(otChangedFlags aFlags, void *aContext)`	typedef `void(*` Ten wskaźnik funkcji jest wywoływany w celu powiadamiania o pewnych zmianach konfiguracji lub stanu w OpenThread.

Funkcje
`otGetRadioVersionString ( otInstance *aInstance)`	`const char *` Ta funkcja pobiera ciąg wersji radiowej OpenThread.
`otGetVersionString (void)`	`const char *` Ta funkcja pobiera ciąg wersji OpenThread.
`otInstanceErasePersistentInfo ( otInstance *aInstance)`	`otError` Ta funkcja usuwa wszystkie trwałe informacje OpenThread (ustawienia sieciowe) przechowywane w pamięci nieulotnej.
`otInstanceFactoryReset ( otInstance *aInstance)`	`void` Ta metoda usuwa wszystkie ustawienia przechowywane w pamięci nieulotnej, a następnie wyzwala reset platformy.
`otInstanceFinalize ( otInstance *aInstance)`	`void` Ta funkcja wyłącza bibliotekę OpenThread.
`otInstanceInit (void aInstanceBuffer, size_t aInstanceBufferSize)`	`otInstance *` Ta funkcja inicjuje bibliotekę OpenThread.
`otInstanceInitSingle (void)`	`otInstance *` Ta funkcja inicjuje statyczne pojedyncze wystąpienie biblioteki OpenThread.
`otInstanceIsInitialized ( otInstance *aInstance)`	`bool` Ta funkcja wskazuje, czy instancja jest prawidłowa / zainicjowana.
`otInstanceReset ( otInstance *aInstance)`	`void` Ta metoda wyzwala reset platformy.
`otRemoveStateChangeCallback ( otInstance aInstance, otStateChangedCallback aCallback, void aContext)`	`void` Ta funkcja usuwa wywołanie zwrotne, aby wskazać, kiedy określona konfiguracja lub stan zmienia się w OpenThread.
`otSetStateChangedCallback ( otInstance aInstance, otStateChangedCallback aCallback, void aContext)`	`otError` Ta funkcja rejestruje wywołanie zwrotne, aby wskazać, kiedy określona konfiguracja lub stan zmienia się w OpenThread.

Wyliczenia

anonimowe wyliczenie

 anonymous enum

To wyliczenie definiuje flagi, które są przekazywane jako część otStateChangedCallback .

Nieruchomości
`OT_CHANGED_ACTIVE_DATASET`	Aktywny zbiór danych operacyjnych został zmieniony.
`OT_CHANGED_CHANNEL_MANAGER_NEW_CHANNEL`	Kanał nowego oczekującego wątku Channel Manager został zmieniony.
`OT_CHANGED_COMMISSIONER_STATE`	Stan komisarza się zmienił.
`OT_CHANGED_IP6_ADDRESS_ADDED`	Adres IPv6 został dodany.
`OT_CHANGED_IP6_ADDRESS_REMOVED`	Adres IPv6 został usunięty.
`OT_CHANGED_IP6_MULTICAST_SUBSCRIBED`	Zasubskrybowano adres multiemisji IPv6.
`OT_CHANGED_IP6_MULTICAST_UNSUBSCRIBED`	Anulowano subskrypcję adresu multiemisji IPv6.
`OT_CHANGED_JOINER_STATE`	Stan stolarza zmienił się.
`OT_CHANGED_MASTER_KEY`	Klucz główny zmieniony.
`OT_CHANGED_PENDING_DATASET`	Zmieniono oczekujący zestaw danych operacyjnych.
`OT_CHANGED_PSKC`	PSKc się zmieniło.
`OT_CHANGED_SECURITY_POLICY`	Polityka bezpieczeństwa została zmieniona.
`OT_CHANGED_SUPPORTED_CHANNEL_MASK`	Obsługiwana maska kanału została zmieniona.
`OT_CHANGED_THREAD_BACKBONE_ROUTER_LOCAL`	Konfiguracja lokalnego routera szkieletowego została zmieniona.
`OT_CHANGED_THREAD_BACKBONE_ROUTER_STATE`	Stan routera szkieletowego został zmieniony.
`OT_CHANGED_THREAD_CHANNEL`	Kanał sieciowy wątku został zmieniony.
`OT_CHANGED_THREAD_CHILD_ADDED`	Dziecko zostało dodane.
`OT_CHANGED_THREAD_CHILD_REMOVED`	Dziecko zostało usunięte.
`OT_CHANGED_THREAD_EXT_PANID`	Rozszerzony identyfikator PAN sieci wątków został zmieniony.
`OT_CHANGED_THREAD_KEY_SEQUENCE_COUNTER`	Zmieniono sekwencję klucza wątku.
`OT_CHANGED_THREAD_LL_ADDR`	Adres lokalny łącza zmienił się.
`OT_CHANGED_THREAD_ML_ADDR`	Adres lokalny siatki został zmieniony.
`OT_CHANGED_THREAD_NETDATA`	Dane sieci wątku zostały zmienione.
`OT_CHANGED_THREAD_NETIF_STATE`	Zmieniono stan interfejsu sieciowego wątku.
`OT_CHANGED_THREAD_NETWORK_NAME`	Nazwa sieci wątku została zmieniona.
`OT_CHANGED_THREAD_PANID`	Identyfikator PAN sieci wątków został zmieniony.
`OT_CHANGED_THREAD_PARTITION_ID`	Identyfikator partycji został zmieniony.
`OT_CHANGED_THREAD_RLOC_ADDED`	Dodano RLOC.
`OT_CHANGED_THREAD_RLOC_REMOVED`	RLOC został usunięty.
`OT_CHANGED_THREAD_ROLE`	Rola (wyłączona, odłączona, dziecko, router, lider) uległa zmianie.

Typedefs

otChangedFlags

uint32_t otChangedFlags

Ten typ reprezentuje pole bitowe wskazujące określony stan / konfigurację, która uległa zmianie.

Zobacz definicje OT_CHANGED_* .

otInstance

struct otInstance otInstance

Ta struktura reprezentuje strukturę instancji OpenThread.

otStateChangedCallback

void(* otStateChangedCallback)(otChangedFlags aFlags, void *aContext)

Ten wskaźnik funkcji jest wywoływany w celu powiadamiania o pewnych zmianach konfiguracji lub stanu w OpenThread.

Detale

Parametry

`[in] aFlags`	Pole bitowe wskazujące określony stan, który się zmienił. Zobacz definicje `OT_CHANGED_*` .
`[in] aContext`	Wskaźnik do kontekstu specyficznego dla aplikacji.

Funkcje

otGetRadioVersionString

const char * otGetRadioVersionString(
  otInstance *aInstance
)

Ta funkcja pobiera ciąg wersji radiowej OpenThread.

Detale

Parametry

[in] aInstance

Wskaźnik do instancji OpenThread.

Zwroty

Wskaźnik do wersji radiowej OpenThread.

otGetVersionString

const char * otGetVersionString(
  void
)

Ta funkcja pobiera ciąg wersji OpenThread.

Detale
Zwroty	Wskaźnik do wersji OpenThread.

otInstanceErasePersistentInfo

otError otInstanceErasePersistentInfo(
  otInstance *aInstance
)

Ta funkcja usuwa wszystkie trwałe informacje OpenThread (ustawienia sieciowe) przechowywane w pamięci nieulotnej.

Wymazanie powiedzie się tylko wtedy, gdy urządzenie jest w stanie / roli disabled .

Detale

Parametry

[in] aInstance

Wskaźnik do instancji OpenThread.

Zwracane wartości

`OT_ERROR_NONE`	Wszystkie trwałe informacje / stan zostały pomyślnie usunięte.
`OT_ERROR_INVALID_STATE`	Urządzenie nie jest `disabled` stanie / roli.

otInstanceFactoryReset

void otInstanceFactoryReset(
  otInstance *aInstance
)

Ta metoda usuwa wszystkie ustawienia przechowywane w pamięci nieulotnej, a następnie wyzwala reset platformy.

Detale

Parametry

[in] aInstance

Wskaźnik do instancji OpenThread.

otInstanceFinalize

void otInstanceFinalize(
  otInstance *aInstance
)

Ta funkcja wyłącza bibliotekę OpenThread.

Wywołaj tę funkcję, gdy OpenThread nie jest już używany.

Detale

Parametry

[in] aInstance

Wskaźnik do instancji OpenThread.

otInstanceInit

otInstance * otInstanceInit(
  void *aInstanceBuffer,
  size_t *aInstanceBufferSize
)

Ta funkcja inicjuje bibliotekę OpenThread.

Ta funkcja inicjuje OpenThread i przygotowuje go do kolejnych wywołań API OpenThread. Tę funkcję należy wywołać przed jakimikolwiek innymi wywołaniami OpenThread.

Ta funkcja jest dostępna i można jej używać tylko wtedy, gdy włączona jest obsługa wielu instancji OpenThread.

Detale

Parametry

`[in] aInstanceBuffer`	Bufor dla OpenThread, który ma być używany do alokowania struktury otInstance.
`[in,out] aInstanceBufferSize`	Na wejściu rozmiar aInstanceBuffer. Na wyjściu, jeśli nie ma wystarczającej ilości miejsca na otInstance, liczba bajtów wymaganych dla otInstance.

Zwroty

Wskaźnik do nowej instancji OpenThread.

Zobacz też:
otInstanceFinalize

otInstanceInitSingle

otInstance * otInstanceInitSingle(
  void
)

Ta funkcja inicjuje statyczne pojedyncze wystąpienie biblioteki OpenThread.

Ta funkcja inicjuje OpenThread i przygotowuje go do kolejnych wywołań API OpenThread. Tę funkcję należy wywołać przed jakimikolwiek innymi wywołaniami OpenThread.

Ta funkcja jest dostępna i można jej używać tylko wtedy, gdy wyłączona jest obsługa wielu instancji OpenThread.

Detale
Zwroty	Wskaźnik do pojedynczego wystąpienia OpenThread.

otInstanceIsInitialized

bool otInstanceIsInitialized(
  otInstance *aInstance
)

Ta funkcja wskazuje, czy instancja jest prawidłowa / zainicjowana.

Instancja jest uznawana za ważną, jeśli jest pozyskiwana i inicjowana za pomocą otInstanceInitSingle() (w przypadku pojedynczego wystąpienia) lub otInstanceInit() (w przypadku wielu wystąpień). Kolejne wywołanie otInstanceFinalize() powoduje, że instancja jest uważana za niezainicjowaną.

Detale

Parametry

[in] aInstance

Wskaźnik do instancji OpenThread.

Zwroty

TRUE, jeśli dana instancja jest ważna / zainicjowana, FALSE w przeciwnym razie.

otInstanceReset

void otInstanceReset(
  otInstance *aInstance
)

Ta metoda wyzwala reset platformy.

Proces resetowania zapewnia, że cały stan / informacje OpenThread (przechowywane w pamięci ulotnej) zostaną usunięte. Należy zauważyć, że otPlatformReset nie usuwa żadnego trwałego stanu / informacji zapisanych w pamięci nieulotnej.

Detale

Parametry

[in] aInstance

Wskaźnik do instancji OpenThread.

otRemoveStateChangeCallback

void otRemoveStateChangeCallback(
  otInstance *aInstance,
  otStateChangedCallback aCallback,
  void *aContext
)

Ta funkcja usuwa wywołanie zwrotne, aby wskazać, kiedy określona konfiguracja lub stan zmienia się w OpenThread.

Detale

Parametry

`[in] aInstance`	Wskaźnik do instancji OpenThread.
`[in] aCallback`	Wskaźnik do funkcji wywoływanej z pewnymi zmianami konfiguracji lub stanu.
`[in] aContext`	Wskaźnik do kontekstu specyficznego dla aplikacji.

otSetStateChangedCallback

otError otSetStateChangedCallback(
  otInstance *aInstance,
  otStateChangedCallback aCallback,
  void *aContext
)

Ta funkcja rejestruje wywołanie zwrotne, aby wskazać, kiedy określona konfiguracja lub stan zmienia się w OpenThread.

Detale

Parametry

`[in] aInstance`	Wskaźnik do instancji OpenThread.
`[in] aCallback`	Wskaźnik do funkcji wywoływanej z pewnymi zmianami konfiguracji lub stanu.
`[in] aContext`	Wskaźnik do kontekstu specyficznego dla aplikacji.

Zwracane wartości

`OT_ERROR_NONE`	Dodano callback do listy callbacków.
`OT_ERROR_ALREADY`	Oddzwonienie zostało już zarejestrowane.
`OT_ERROR_NO_BUFS`	Nie można dodać wywołania zwrotnego z powodu ograniczeń zasobów.