Contoh
Modul ini mencakup fungsi yang mengontrol OpenThread Instance.
Ringkasan
Typedefs | |
---|---|
otChangedFlags | typedefuint32_t Jenis ini mewakili bit-field yang menunjukkan status / konfigurasi tertentu yang telah berubah. |
otInstance | typedefstruct otInstance Struktur ini mewakili struktur instance OpenThread. |
otStateChangedCallback )(otChangedFlags aFlags, void *aContext) | typedefvoid(* Penunjuk fungsi ini dipanggil untuk memberi tahu konfigurasi atau perubahan status tertentu dalam OpenThread. |
Fungsi | |
---|---|
otGetRadioVersionString ( otInstance *aInstance) | const char * Fungsi ini mendapatkan string versi radio OpenThread. |
otGetVersionString (void) | const char * Fungsi ini mendapatkan string versi OpenThread. |
otInstanceErasePersistentInfo ( otInstance *aInstance) | Fungsi ini menghapus semua info persisten OpenThread (pengaturan jaringan) yang disimpan di memori non-volatile. |
otInstanceFactoryReset ( otInstance *aInstance) | void Metode ini menghapus semua pengaturan yang disimpan di memori non-volatile, dan kemudian memicu reset platform. |
otInstanceFinalize ( otInstance *aInstance) | void Fungsi ini menonaktifkan pustaka OpenThread. |
otInstanceInit (void *aInstanceBuffer, size_t *aInstanceBufferSize) | Fungsi ini menginisialisasi pustaka OpenThread. |
otInstanceInitSingle (void) | Fungsi ini menginisialisasi instance tunggal statis dari pustaka OpenThread. |
otInstanceIsInitialized ( otInstance *aInstance) | bool Fungsi ini menunjukkan apakah instance tersebut valid / diinisialisasi atau tidak. |
otInstanceReset ( otInstance *aInstance) | void Metode ini memicu penyetelan ulang platform. |
otRemoveStateChangeCallback ( otInstance *aInstance, otStateChangedCallback aCallback, void *aContext) | void Fungsi ini menghapus callback untuk menunjukkan kapan konfigurasi atau status tertentu berubah dalam OpenThread. |
otSetStateChangedCallback ( otInstance *aInstance, otStateChangedCallback aCallback, void *aContext) | Fungsi ini mendaftarkan panggilan balik untuk menunjukkan ketika konfigurasi atau status tertentu berubah dalam OpenThread. |
Pencacahan
enum anonim
anonymous enum
otStateChangedCallback
ini mendefinisikan tanda yang diteruskan sebagai bagian dari otStateChangedCallback
.
Typedefs
otChangedFlags
uint32_t otChangedFlags
Tipe ini mewakili bit-field yang menunjukkan status / konfigurasi tertentu yang telah berubah.
Lihat definisi OT_CHANGED_*
.
otStateChangedCallback
void(* otStateChangedCallback)(otChangedFlags aFlags, void *aContext)
Penunjuk fungsi ini dipanggil untuk memberi tahu konfigurasi atau perubahan status tertentu dalam OpenThread.
Detail | |||||
---|---|---|---|---|---|
Parameter |
|
Fungsi
otGetRadioVersionString
const char * otGetRadioVersionString( otInstance *aInstance )
Fungsi ini mendapatkan string versi radio OpenThread.
Detail | |||
---|---|---|---|
Parameter |
| ||
Kembali | Penunjuk ke versi radio OpenThread. |
otGetVersionString
const char * otGetVersionString( void )
Fungsi ini mendapatkan string versi OpenThread.
Detail | |
---|---|
Kembali | Penunjuk ke versi OpenThread. |
otInstanceErasePersistentInfo
otError otInstanceErasePersistentInfo( otInstance *aInstance )
Fungsi ini menghapus semua info persisten OpenThread (pengaturan jaringan) yang disimpan di memori non-volatile.
Penghapusan berhasil hanya jika perangkat dalam status / peran disabled
.
Detail | |||||
---|---|---|---|---|---|
Parameter |
| ||||
Kembalikan Nilai |
|
otInstanceFactoryReset
void otInstanceFactoryReset( otInstance *aInstance )
Metode ini menghapus semua pengaturan yang disimpan di memori non-volatile, dan kemudian memicu reset platform.
Detail | |||
---|---|---|---|
Parameter |
|
otInstanceFinalize
void otInstanceFinalize( otInstance *aInstance )
Fungsi ini menonaktifkan pustaka OpenThread.
Panggil fungsi ini saat OpenThread tidak lagi digunakan.
Detail | |||
---|---|---|---|
Parameter |
|
otInstanceInit
otInstance * otInstanceInit( void *aInstanceBuffer, size_t *aInstanceBufferSize )
Fungsi ini menginisialisasi pustaka OpenThread.
Fungsi ini menginisialisasi OpenThread dan mempersiapkannya untuk panggilan API OpenThread berikutnya. Fungsi ini harus dipanggil sebelum panggilan lain ke OpenThread.
Fungsi ini tersedia dan hanya dapat digunakan jika dukungan untuk beberapa instans OpenThread diaktifkan.
Detail | |||||
---|---|---|---|---|---|
Parameter |
| ||||
Kembali | Penunjuk ke instance OpenThread baru. |
otInstanceFinalize
otInstanceInitSingle
otInstance * otInstanceInitSingle( void )
Fungsi ini menginisialisasi instance tunggal statis dari pustaka OpenThread.
Fungsi ini menginisialisasi OpenThread dan mempersiapkannya untuk panggilan API OpenThread berikutnya. Fungsi ini harus dipanggil sebelum panggilan lain ke OpenThread.
Fungsi ini tersedia dan hanya dapat digunakan jika dukungan untuk beberapa instans OpenThread dinonaktifkan.
Detail | |
---|---|
Kembali | Penunjuk ke satu instance OpenThread. |
otInstanceIsInitialized
bool otInstanceIsInitialized( otInstance *aInstance )
Fungsi ini menunjukkan apakah instance tersebut valid / diinisialisasi atau tidak.
Instance dianggap valid jika diperoleh dan diinisialisasi menggunakan otInstanceInitSingle()
(dalam kasus instans tunggal) atau otInstanceInit()
(dalam kasus multi instans). Panggilan berikutnya ke otInstanceFinalize()
menyebabkan instance dianggap tidak diinisialisasi.
Detail | |||
---|---|---|---|
Parameter |
| ||
Kembali | TRUE jika contoh yang diberikan valid / diinisialisasi, FALSE sebaliknya. |
otInstanceReset
void otInstanceReset( otInstance *aInstance )
Metode ini memicu penyetelan ulang platform.
Proses reset memastikan bahwa semua status / info OpenThread (disimpan dalam memori volatile) dihapus. Perhatikan bahwa otPlatformReset
tidak menghapus status / info persisten yang disimpan di memori non-volatile.
Detail | |||
---|---|---|---|
Parameter |
|
otRemoveStateChangeCallback
void otRemoveStateChangeCallback( otInstance *aInstance, otStateChangedCallback aCallback, void *aContext )
Fungsi ini menghapus callback untuk menunjukkan kapan konfigurasi atau status tertentu berubah dalam OpenThread.
Detail | |||||||
---|---|---|---|---|---|---|---|
Parameter |
|
otSetStateChangedCallback
otError otSetStateChangedCallback( otInstance *aInstance, otStateChangedCallback aCallback, void *aContext )
Fungsi ini mendaftarkan panggilan balik untuk menunjukkan ketika konfigurasi atau status tertentu berubah dalam OpenThread.
Detail | |||||||
---|---|---|---|---|---|---|---|
Parameter |
| ||||||
Kembalikan Nilai |
|