Contoh

Modul ini mencakup fungsi yang mengontrol OpenThread Instance.

Ringkasan

enumerations
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 Pencacahan ini mendefinisikan bendera yang disahkan sebagai bagian dari `otStateChangedCallback` .

enumerations

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

Pencacahan ini mendefinisikan bendera yang disahkan sebagai bagian dari otStateChangedCallback .

typedef
`otChangedFlags`	typedef `uint32_t` Tipe ini merupakan sedikit-bidang yang menunjukkan negara / konfigurasi spesifik yang telah berubah.
`otInstance`	typedef `struct otInstance` Struktur ini merupakan struktur contoh OpenThread.
`otStateChangedCallback )(otChangedFlags aFlags, void *aContext)`	typedef `void(*` Fungsi pointer ini disebut untuk memberitahu konfigurasi atau negara perubahan tertentu dalam OpenThread.

fungsi
`otGetRadioVersionString ( otInstance *aInstance)`	`const char *` Fungsi ini mendapat OpenThread versi radio tali.
`otGetVersionString (void)`	`const char *` Fungsi ini mendapat OpenThread string versi.
`otInstanceErasePersistentInfo ( otInstance *aInstance)`	`otError` Fungsi ini menghapus semua OpenThread persisten info (pengaturan jaringan) yang tersimpan pada memori non-volatile.
`otInstanceFactoryReset ( otInstance *aInstance)`	`void` Metode ini akan menghapus semua pengaturan tersimpan pada memori non-volatile, dan kemudian memicu Platform ulang.
`otInstanceFinalize ( otInstance *aInstance)`	`void` Fungsi ini menonaktifkan perpustakaan OpenThread.
`otInstanceInit (void aInstanceBuffer, size_t aInstanceBufferSize)`	`otInstance *` Fungsi ini menginisialisasi perpustakaan OpenThread.
`otInstanceInitSingle (void)`	`otInstance *` Fungsi ini menginisialisasi satu contoh statis perpustakaan OpenThread.
`otInstanceIsInitialized ( otInstance *aInstance)`	`bool` Fungsi ini menunjukkan apakah atau tidak contoh yang / valid diinisialisasi.
`otInstanceReset ( otInstance *aInstance)`	`void` Metode ini memicu reset platform yang.
`otRemoveStateChangeCallback ( otInstance aInstance, otStateChangedCallback aCallback, void aContext)`	`void` Fungsi ini menghapus callback untuk menunjukkan bila konfigurasi atau negara perubahan tertentu dalam OpenThread.
`otSetStateChangedCallback ( otInstance aInstance, otStateChangedCallback aCallback, void aContext)`	`otError` Fungsi ini register panggilan balik untuk menunjukkan bila konfigurasi atau negara perubahan tertentu dalam OpenThread.

enumerations

anonim enum

 anonymous enum

Pencacahan ini mendefinisikan bendera yang disahkan sebagai bagian dari otStateChangedCallback .

properti
`OT_CHANGED_CHANNEL_MANAGER_NEW_CHANNEL`	Channel Manager baru tertunda saluran Thread berubah.
`OT_CHANGED_COMMISSIONER_STATE`	negara Komisaris berubah.
`OT_CHANGED_IP6_ADDRESS_ADDED`	alamat IPv6 telah ditambahkan.
`OT_CHANGED_IP6_ADDRESS_REMOVED`	alamat IPv6 telah dihapus.
`OT_CHANGED_IP6_MULTICAST_SUBSCRIBED`	Berlangganan ke alamat multicast IPv6.
`OT_CHANGED_IP6_MULTICAST_UNSUBSCRIBED`	Berhenti berlangganan dari alamat multicast IPv6.
`OT_CHANGED_JOINER_STATE`	negara Joiner berubah.
`OT_CHANGED_MASTER_KEY`	Master key berubah.
`OT_CHANGED_PSKC`	PSKc berubah.
`OT_CHANGED_SECURITY_POLICY`	Kebijakan keamanan berubah.
`OT_CHANGED_SUPPORTED_CHANNEL_MASK`	Didukung saluran topeng berubah.
`OT_CHANGED_THREAD_BACKBONE_ROUTER_LOCAL`	Backbone lokal Router konfigurasi berubah.
`OT_CHANGED_THREAD_BACKBONE_ROUTER_STATE`	Backbone negara Router berubah.
`OT_CHANGED_THREAD_CHANNEL`	saluran jaringan benang berubah.
`OT_CHANGED_THREAD_CHILD_ADDED`	Anak ditambahkan.
`OT_CHANGED_THREAD_CHILD_REMOVED`	Anak telah dihapus.
`OT_CHANGED_THREAD_EXT_PANID`	jaringan benang diperpanjang PAN ID berubah.
`OT_CHANGED_THREAD_KEY_SEQUENCE_COUNTER`	Thread Key Urutan berubah.
`OT_CHANGED_THREAD_LL_ADDR`	Alamat link-lokal berubah.
`OT_CHANGED_THREAD_ML_ADDR`	Alamat mesh lokal berubah.
`OT_CHANGED_THREAD_NETDATA`	Thread Jaringan Data berubah.
`OT_CHANGED_THREAD_NETIF_STATE`	negara antarmuka jaringan benang berubah.
`OT_CHANGED_THREAD_NETWORK_NAME`	Thread nama jaringan berubah.
`OT_CHANGED_THREAD_PANID`	jaringan benang PAN Id berubah.
`OT_CHANGED_THREAD_PARTITION_ID`	Partisi ID berubah.
`OT_CHANGED_THREAD_RLOC_ADDED`	RLOC ditambahkan.
`OT_CHANGED_THREAD_RLOC_REMOVED`	RLOC telah dihapus.
`OT_CHANGED_THREAD_ROLE`	Peran (cacat, terpisah, anak, router, pemimpin) berubah.

typedef

otChangedFlags

uint32_t otChangedFlags

Tipe ini merupakan sedikit-bidang yang menunjukkan negara / konfigurasi spesifik yang telah berubah.

Lihat OT_CHANGED_* definisi.

otInstance

struct otInstance otInstance

Struktur ini merupakan struktur contoh OpenThread.

otStateChangedCallback

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

Fungsi pointer ini disebut untuk memberitahu konfigurasi atau negara perubahan tertentu dalam OpenThread.

rincian

parameter

`[in] aFlags`	Sedikit-bidang yang menunjukkan negara tertentu yang telah berubah. Lihat `OT_CHANGED_*` definisi.
`[in] aContext`	Sebuah pointer ke konteks aplikasi-spesifik.

fungsi

otGetRadioVersionString

const char * otGetRadioVersionString(
  otInstance *aInstance
)

Fungsi ini mendapat OpenThread versi radio tali.

rincian

parameter

[in] aInstance

Sebuah pointer ke sebuah contoh OpenThread.

Pengembalian

Sebuah pointer ke versi radio OpenThread.

otGetVersionString

const char * otGetVersionString(
  void
)

Fungsi ini mendapat OpenThread string versi.

rincian
Pengembalian	Sebuah pointer ke versi OpenThread.

otInstanceErasePersistentInfo

 otError otInstanceErasePersistentInfo(
  otInstance *aInstance
)

Fungsi ini menghapus semua OpenThread persisten info (pengaturan jaringan) yang tersimpan pada memori non-volatile.

Erase berhasil hanya jika perangkat dalam disabled negara / peran.

rincian

parameter

[in] aInstance

Sebuah pointer ke sebuah contoh OpenThread.

Nilai Kembali

`OT_ERROR_NONE`	Semua gigih info / negara berhasil terhapus.
`OT_ERROR_INVALID_STATE`	Perangkat tidak dalam `disabled` negara / peran.

otInstanceFactoryReset

void otInstanceFactoryReset(
  otInstance *aInstance
)

Metode ini akan menghapus semua pengaturan tersimpan pada memori non-volatile, dan kemudian memicu Platform ulang.

rincian

parameter

[in] aInstance

Sebuah pointer ke sebuah contoh OpenThread.

otInstanceFinalize

void otInstanceFinalize(
  otInstance *aInstance
)

Fungsi ini menonaktifkan perpustakaan OpenThread.

Memanggil fungsi ini ketika OpenThread tidak lagi digunakan.

rincian

parameter

[in] aInstance

Sebuah pointer ke sebuah contoh OpenThread.

otInstanceInit

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

Fungsi ini menginisialisasi perpustakaan OpenThread.

Fungsi ini menginisialisasi OpenThread dan mempersiapkan untuk selanjutnya OpenThread API panggilan. Fungsi ini harus dipanggil sebelum panggilan lain untuk OpenThread.

Fungsi ini tersedia dan hanya bisa digunakan ketika dukungan untuk beberapa contoh OpenThread diaktifkan.

rincian

parameter

`[in] aInstanceBuffer`	Buffer untuk OpenThread digunakan untuk mengalokasikan struktur otInstance.
`[in,out] aInstanceBufferSize`	Pada input, ukuran aInstanceBuffer. Pada output, jika tidak cukup ruang untuk otInstance, jumlah byte yang diperlukan untuk otInstance.

Pengembalian

Sebuah pointer ke instance OpenThread baru.

Lihat juga:
otInstanceFinalize

otInstanceInitSingle

 otInstance * otInstanceInitSingle(
  void
)

Fungsi ini menginisialisasi satu contoh statis perpustakaan OpenThread.

Fungsi ini menginisialisasi OpenThread dan mempersiapkan untuk selanjutnya OpenThread API panggilan. Fungsi ini harus dipanggil sebelum panggilan lain untuk OpenThread.

Fungsi ini tersedia dan hanya bisa digunakan ketika dukungan untuk beberapa contoh OpenThread dinonaktifkan.

rincian
Pengembalian	Sebuah pointer ke instance OpenThread tunggal.

otInstanceIsInitialized

bool otInstanceIsInitialized(
  otInstance *aInstance
)

Fungsi ini menunjukkan apakah atau tidak contoh yang / valid diinisialisasi.

Contoh dianggap sah jika diperoleh dan diinisialisasi baik menggunakan otInstanceInitSingle() (dalam hal kasus tunggal) atau otInstanceInit() (dalam hal kasus multifinance). Sebuah panggilan berikutnya untuk otInstanceFinalize() menyebabkan contoh dianggap sebagai diinisiasi.

rincian

parameter

[in] aInstance

Sebuah pointer ke sebuah contoh OpenThread.

Pengembalian

TRUE jika contoh yang diberikan valid / diinisialisasi, SALAH sebaliknya.

otInstanceReset

void otInstanceReset(
  otInstance *aInstance
)

Metode ini memicu reset platform yang.

Proses Memastikan ulang bahwa semua OpenThread negara / info (disimpan dalam memori volatile) terhapus. Perhatikan bahwa otPlatformReset tidak menghapus negara terus-menerus / info disimpan dalam memori non-volatile.

rincian

parameter

[in] aInstance

Sebuah pointer ke sebuah contoh OpenThread.

otRemoveStateChangeCallback

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

Fungsi ini menghapus callback untuk menunjukkan bila konfigurasi atau negara perubahan tertentu dalam OpenThread.

rincian

parameter

`[in] aInstance`	Sebuah pointer ke sebuah contoh OpenThread.
`[in] aCallback`	Sebuah pointer ke fungsi yang disebut dengan konfigurasi atau negara perubahan tertentu.
`[in] aContext`	Sebuah pointer ke konteks aplikasi-spesifik.

otSetStateChangedCallback

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

Fungsi ini register panggilan balik untuk menunjukkan bila konfigurasi atau negara perubahan tertentu dalam OpenThread.

rincian

parameter

`[in] aInstance`	Sebuah pointer ke sebuah contoh OpenThread.
`[in] aCallback`	Sebuah pointer ke fungsi yang disebut dengan konfigurasi atau negara perubahan tertentu.
`[in] aContext`	Sebuah pointer ke konteks aplikasi-spesifik.

Nilai Kembali

`OT_ERROR_NONE`	Ditambahkan callback ke daftar callback.
`OT_ERROR_ALREADY`	callback ini sudah terdaftar.
`OT_ERROR_NO_BUFS`	tidak bisa menambahkan callback karena keterbatasan sumber daya.