Instancja

Moduł ten zawiera funkcje, które kontrolują OpenThread instancji.

Podsumowanie

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 }	enum To wyliczenie określa flagi, które są przekazywane w ramach `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 
 }

enum

To wyliczenie określa flagi, które są przekazywane w ramach otStateChangedCallback .

typedefs
`otChangedFlags`	typedef `uint32_t` Ten typ reprezentuje bit-pole wskazujące konkretny stan / konfiguracji, które zmieniły.
`otInstance`	typedef `struct otInstance` Ta struktura odpowiada strukturze OpenThread wystąpienia.
`otStateChangedCallback )(otChangedFlags aFlags, void *aContext)`	typedef `void(*` Ten wskaźnik jest wywoływana zgłaszania niektórych konfiguracji lub państwowych zmian w OpenThread.

Funkcje
`otGetRadioVersionString ( otInstance *aInstance)`	`const char *` Funkcja ta pobiera OpenThread wersji radiowej ciąg.
`otGetVersionString (void)`	`const char *` Funkcja ta pobiera wersji ciąg OpenThread.
`otInstanceErasePersistentInfo ( otInstance *aInstance)`	`otError` Funkcja ta powoduje usunięcie wszystkich OpenThread uporczywy Info (ustawienia sieci) przechowywane w pamięci nieulotnej.
`otInstanceFactoryReset ( otInstance *aInstance)`	`void` Metoda ta powoduje usunięcie wszystkich ustawień zapisanych w pamięci nieulotnej, a następnie uruchamia resetu platformy.
`otInstanceFinalize ( otInstance *aInstance)`	`void` Funkcja ta wyłącza bibliotekę OpenThread.
`otInstanceInit (void aInstanceBuffer, size_t aInstanceBufferSize)`	`otInstance *` Funkcja ta inicjuje bibliotekę OpenThread.
`otInstanceInitSingle (void)`	`otInstance *` Funkcja ta inicjuje statycznego pojedynczą instancję biblioteki OpenThread.
`otInstanceIsInitialized ( otInstance *aInstance)`	`bool` Ta funkcja wskazuje czy wystąpienie jest ważne / inicjowany.
`otInstanceReset ( otInstance *aInstance)`	`void` Metoda ta powoduje reset platformy.
`otRemoveStateChangeCallback ( otInstance aInstance, otStateChangedCallback aCallback, void aContext)`	`void` Ta funkcja usuwa oddzwanianie do wskazania, kiedy pewne konfiguracyjnych lub zmian w OpenThread państwowych.
`otSetStateChangedCallback ( otInstance aInstance, otStateChangedCallback aCallback, void aContext)`	`otError` Ta funkcja rejestruje wywołania zwrotnego do wskazania, kiedy pewne konfiguracyjnych lub zmian w OpenThread państwowych.

wyliczenia

anonimowy enum

 anonymous enum

To wyliczenie określa flagi, które są przekazywane w ramach otStateChangedCallback .

Nieruchomości
`OT_CHANGED_CHANNEL_MANAGER_NEW_CHANNEL`	Menedżer kanałów nowy kanał oczekiwaniu Temat zmieniony.
`OT_CHANGED_COMMISSIONER_STATE`	Komisarz stan zmienić.
`OT_CHANGED_IP6_ADDRESS_ADDED`	dodano adres IPv6.
`OT_CHANGED_IP6_ADDRESS_REMOVED`	Adres IPv6 został usunięty.
`OT_CHANGED_IP6_MULTICAST_SUBSCRIBED`	Abonamentu na adres IPv6 multicast.
`OT_CHANGED_IP6_MULTICAST_UNSUBSCRIBED`	Wypisany z IPv6 multicast adres.
`OT_CHANGED_JOINER_STATE`	stan Joiner zmieniło.
`OT_CHANGED_MASTER_KEY`	klucz główny zmieniło.
`OT_CHANGED_PSKC`	PSKc zmieniło.
`OT_CHANGED_SECURITY_POLICY`	Polityka bezpieczeństwa zmieniło.
`OT_CHANGED_SUPPORTED_CHANNEL_MASK`	Obsługiwane maska kanał zmieniło.
`OT_CHANGED_THREAD_BACKBONE_ROUTER_LOCAL`	Lokalna konfiguracja Router Backbone zmieniło.
`OT_CHANGED_THREAD_BACKBONE_ROUTER_STATE`	Router Backbone stan zmienić.
`OT_CHANGED_THREAD_CHANNEL`	Wątek kanał sieć zmieniło.
`OT_CHANGED_THREAD_CHILD_ADDED`	Dziecko zostało dodane.
`OT_CHANGED_THREAD_CHILD_REMOVED`	Dziecko zostało usunięte.
`OT_CHANGED_THREAD_EXT_PANID`	Sieć gwint przedłużony PAN ID zmieniło.
`OT_CHANGED_THREAD_KEY_SEQUENCE_COUNTER`	Wątek klawiszowy zmieniło.
`OT_CHANGED_THREAD_LL_ADDR`	Adres link-local zmieniło.
`OT_CHANGED_THREAD_ML_ADDR`	Adres mesh-local zmieniło.
`OT_CHANGED_THREAD_NETDATA`	Gwint Data Network zmieniło.
`OT_CHANGED_THREAD_NETIF_STATE`	Stan interfejsu sieciowego wątek zmieniło.
`OT_CHANGED_THREAD_NETWORK_NAME`	Wątek nazwa sieci zmieniło.
`OT_CHANGED_THREAD_PANID`	Sieć wątek PAN Id zmieniło.
`OT_CHANGED_THREAD_PARTITION_ID`	Partition ID zmieniło.
`OT_CHANGED_THREAD_RLOC_ADDED`	RLOC dodano.
`OT_CHANGED_THREAD_RLOC_REMOVED`	RLOC usunięto.
`OT_CHANGED_THREAD_ROLE`	Rola (wyłączone, indywidualny, dziecko, router, lider) zmieniło.

typedefs

otChangedFlags

uint32_t otChangedFlags

Ten typ reprezentuje bit-pole wskazujące konkretny stan / konfiguracji, które zmieniły.

Zobacz OT_CHANGED_* definicje.

otInstance

struct otInstance otInstance

Ta struktura odpowiada strukturze OpenThread wystąpienia.

otStateChangedCallback

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

Ten wskaźnik jest wywoływana zgłaszania niektórych konfiguracji lub państwowych zmian w OpenThread.

Detale

parametry

`[in] aFlags`	Trochę pola wskazując, że stan uległ zmianie specyficzny. Zobacz `OT_CHANGED_*` definicje.
`[in] aContext`	Wskaźnik do kontekstu aplikacji.

Funkcje

otGetRadioVersionString

const char * otGetRadioVersionString(
  otInstance *aInstance
)

Funkcja ta pobiera OpenThread wersji radiowej ciąg.

Detale

parametry

[in] aInstance

Wskaźnik do instancji OpenThread.

Zwroty

Wskaźnik do wersji radiowej OpenThread.

otGetVersionString

const char * otGetVersionString(
  void
)

Funkcja ta pobiera wersji ciąg OpenThread.

Detale
Zwroty	Wskaźnik do wersji OpenThread.

otInstanceErasePersistentInfo

 otError otInstanceErasePersistentInfo(
  otInstance *aInstance
)

Funkcja ta powoduje usunięcie wszystkich OpenThread uporczywy Info (ustawienia sieci) przechowywane w pamięci nieulotnej.

Erase jest skuteczne tylko wtedy, gdy urządzenie znajduje się w disabled stanu / roli.

Detale

parametry

[in] aInstance

Wskaźnik do instancji OpenThread.

Zwracane wartości

`OT_ERROR_NONE`	Wszystko trwałe info / państwo zostało usunięte pomyślnie.
`OT_ERROR_INVALID_STATE`	Urządzenie nie jest w `disabled` stanu / roli.

otInstanceFactoryReset

void otInstanceFactoryReset(
  otInstance *aInstance
)

Metoda ta powoduje usunięcie wszystkich ustawień zapisanych w pamięci nieulotnej, a następnie uruchamia resetu platformy.

Detale

parametry

[in] aInstance

Wskaźnik do instancji OpenThread.

otInstanceFinalize

void otInstanceFinalize(
  otInstance *aInstance
)

Funkcja ta wyłącza bibliotekę OpenThread.

Wywołanie tej funkcji, gdy OpenThread nie jest już w użyciu.

Detale

parametry

[in] aInstance

Wskaźnik do instancji OpenThread.

otInstanceInit

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

Funkcja ta inicjuje bibliotekę OpenThread.

Funkcja ta inicjuje OpenThread i przygotowuje ją do kolejnych OpenThread API. Funkcja ta musi być wywołana przed jakimikolwiek innymi wywołań OpenThread.

Funkcja ta jest dostępna i może być stosowany tylko wtedy, gdy jest włączona obsługa wielu przypadkach OpenThread.

Detale

parametry

`[in] aInstanceBuffer`	Bufor do OpenThread użyć do przydzielania strukturę otInstance.
`[in,out] aInstanceBufferSize`	Na wejściu, wielkość aInstanceBuffer. Na wyjściu, jeśli nie wystarczająco dużo miejsca dla otInstance, liczba bajtów potrzebnych do otInstance.

Zwroty

Wskaźnik do nowej instancji OpenThread.

Zobacz też:
otInstanceFinalize

otInstanceInitSingle

 otInstance * otInstanceInitSingle(
  void
)

Funkcja ta inicjuje statycznego pojedynczą instancję biblioteki OpenThread.

Funkcja ta inicjuje OpenThread i przygotowuje ją do kolejnych OpenThread API. Funkcja ta musi być wywołana przed jakimikolwiek innymi wywołań OpenThread.

Funkcja ta jest dostępna i może być stosowany tylko wtedy, gdy obsługa wielu przypadkach OpenThread jest wyłączona.

Detale
Zwroty	Wskaźnik do jednej instancji OpenThread.

otInstanceIsInitialized

bool otInstanceIsInitialized(
  otInstance *aInstance
)

Ta funkcja wskazuje czy wystąpienie jest ważne / inicjowany.

Wystąpienie jest uznany za ważny, jeśli uzyskuje się przy użyciu i inicjalizowane otInstanceInitSingle() (w pojedynczym przypadku wystąpienie) lub otInstanceInit() (w przypadku wielu przykład). Kolejne wywołanie otInstanceFinalize() powoduje wystąpienie należy uznać za zainicjalizowana.

Detale

parametry

[in] aInstance

Wskaźnik do instancji OpenThread.

Zwroty

PRAWDA Jeżeli danym wypadku jest ważne / inicjowany FAŁSZ inaczej.

otInstanceReset

void otInstanceReset(
  otInstance *aInstance
)

Metoda ta powoduje reset platformy.

Reset, zapewnia, że cały proces OpenThread stan / info (przechowywane w pamięci ulotnej) zostanie skasowana. Należy zauważyć, że otPlatformReset nie kasuje żadnych uporczywy stan / informacje zapisane 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 oddzwanianie do wskazania, kiedy pewne konfiguracyjnych lub zmian w OpenThread państwowych.

Detale

parametry

`[in] aInstance`	Wskaźnik do instancji OpenThread.
`[in] aCallback`	Wskaźnik do funkcji, która jest wywoływana z niektórych zmian konfiguracyjnych lub państwowych.
`[in] aContext`	Wskaźnik do kontekstu aplikacji.

otSetStateChangedCallback

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

Ta funkcja rejestruje wywołania zwrotnego do wskazania, kiedy pewne konfiguracyjnych lub zmian w OpenThread państwowych.

Detale

parametry

`[in] aInstance`	Wskaźnik do instancji OpenThread.
`[in] aCallback`	Wskaźnik do funkcji, która jest wywoływana z niektórych zmian konfiguracyjnych lub państwowych.
`[in] aContext`	Wskaźnik do kontekstu aplikacji.

Zwracane wartości

`OT_ERROR_NONE`	Dodano oddzwanianie do listy wywołań zwrotnych.
`OT_ERROR_ALREADY`	Callback został już zarejestrowany.
`OT_ERROR_NO_BUFS`	Nie udało się dodać zwrotnego z powodu ograniczonych zasobów.