Ejemplo
Este módulo incluye funciones que controlan la instancia OpenThread.
Resumen
Typedefs | |
---|---|
otChangedFlags | typedefuint32_t Este tipo representa un campo de bits que indica el estado / configuración específicos que ha cambiado. |
otInstance | typedefstruct otInstance Esta estructura representa la estructura de instancia de OpenThread. |
otStateChangedCallback )(otChangedFlags aFlags, void *aContext) | typedefvoid(* Este puntero de función se llama para notificar ciertos cambios de configuración o estado dentro de OpenThread. |
Funciones | |
---|---|
otGetRadioVersionString ( otInstance *aInstance) | const char * Esta función obtiene la cadena de versión de radio de OpenThread. |
otGetVersionString (void) | const char * Esta función obtiene la cadena de versión de OpenThread. |
otInstanceErasePersistentInfo ( otInstance *aInstance) | Esta función borra toda la información persistente de OpenThread (configuración de red) almacenada en la memoria no volátil. |
otInstanceFactoryReset ( otInstance *aInstance) | void Este método elimina todas las configuraciones almacenadas en la memoria no volátil y luego activa el restablecimiento de la plataforma. |
otInstanceFinalize ( otInstance *aInstance) | void Esta función desactiva la biblioteca OpenThread. |
otInstanceInit (void *aInstanceBuffer, size_t *aInstanceBufferSize) | Esta función inicializa la biblioteca OpenThread. |
otInstanceInitSingle (void) | Esta función inicializa la instancia única estática de la biblioteca OpenThread. |
otInstanceIsInitialized ( otInstance *aInstance) | bool Esta función indica si la instancia es válida / inicializada. |
otInstanceReset ( otInstance *aInstance) | void Este método desencadena un reinicio de la plataforma. |
otRemoveStateChangeCallback ( otInstance *aInstance, otStateChangedCallback aCallback, void *aContext) | void Esta función elimina una devolución de llamada para indicar cuándo cambia cierta configuración o estado dentro de OpenThread. |
otSetStateChangedCallback ( otInstance *aInstance, otStateChangedCallback aCallback, void *aContext) | Esta función registra una devolución de llamada para indicar cuando cierta configuración o estado cambia dentro de OpenThread. |
Enumeraciones
enumeración anónima
anonymous enum
Esta enumeración define los indicadores que se pasan como parte de otStateChangedCallback
.
Typedefs
otChangedFlags
uint32_t otChangedFlags
Este tipo representa un campo de bits que indica el estado / configuración específicos que ha cambiado.
Consulte las definiciones de OT_CHANGED_*
.
otInstance
struct otInstance otInstance
Esta estructura representa la estructura de instancia de OpenThread.
otStateChangedCallback
void(* otStateChangedCallback)(otChangedFlags aFlags, void *aContext)
Este puntero de función se llama para notificar ciertos cambios de configuración o estado dentro de OpenThread.
Detalles | |||||
---|---|---|---|---|---|
Parámetros |
|
Funciones
otGetRadioVersionString
const char * otGetRadioVersionString( otInstance *aInstance )
Esta función obtiene la cadena de versión de radio de OpenThread.
Detalles | |||
---|---|---|---|
Parámetros |
| ||
Devoluciones | Un puntero a la versión de radio OpenThread. |
otGetVersionString
const char * otGetVersionString( void )
Esta función obtiene la cadena de versión de OpenThread.
Detalles | |
---|---|
Devoluciones | Un puntero a la versión OpenThread. |
otInstanceErasePersistentInfo
otError otInstanceErasePersistentInfo( otInstance *aInstance )
Esta función borra toda la información persistente de OpenThread (configuración de red) almacenada en la memoria no volátil.
El borrado es exitoso solo si el dispositivo está en estado / función disabled
.
Detalles | |||||
---|---|---|---|---|---|
Parámetros |
| ||||
Valores devueltos |
|
otInstanceFactoryReset
void otInstanceFactoryReset( otInstance *aInstance )
Este método elimina todas las configuraciones almacenadas en la memoria no volátil y luego activa el restablecimiento de la plataforma.
Detalles | |||
---|---|---|---|
Parámetros |
|
otInstanceFinalize
void otInstanceFinalize( otInstance *aInstance )
Esta función desactiva la biblioteca OpenThread.
Llame a esta función cuando OpenThread ya no esté en uso.
Detalles | |||
---|---|---|---|
Parámetros |
|
otInstanceInit
otInstance * otInstanceInit( void *aInstanceBuffer, size_t *aInstanceBufferSize )
Esta función inicializa la biblioteca OpenThread.
Esta función inicializa OpenThread y lo prepara para las siguientes llamadas a la API de OpenThread. Esta función debe llamarse antes que cualquier otra llamada a OpenThread.
Esta función está disponible y solo se puede utilizar cuando la compatibilidad con varias instancias de OpenThread está habilitada.
Detalles | |||||
---|---|---|---|---|---|
Parámetros |
| ||||
Devoluciones | Un puntero a la nueva instancia de OpenThread. |
otInstanceFinalize
otInstanceInitSingle
otInstance * otInstanceInitSingle( void )
Esta función inicializa la instancia única estática de la biblioteca OpenThread.
Esta función inicializa OpenThread y lo prepara para las siguientes llamadas a la API de OpenThread. Esta función debe llamarse antes que cualquier otra llamada a OpenThread.
Esta función está disponible y solo se puede utilizar cuando la compatibilidad con varias instancias de OpenThread está deshabilitada.
Detalles | |
---|---|
Devoluciones | Un puntero a la única instancia de OpenThread. |
otInstanceIsInitialized
bool otInstanceIsInitialized( otInstance *aInstance )
Esta función indica si la instancia es válida / inicializada.
La instancia se considera válida si se adquiere e inicializa utilizando otInstanceInitSingle()
(en el caso de una sola instancia) u otInstanceInit()
(en el caso de varias instancias). Una llamada posterior a otInstanceFinalize()
hace que la instancia se considere no inicializada.
Detalles | |||
---|---|---|---|
Parámetros |
| ||
Devoluciones | VERDADERO si la instancia dada es válida / inicializada, FALSO en caso contrario. |
otInstanceReset
void otInstanceReset( otInstance *aInstance )
Este método desencadena un reinicio de la plataforma.
El proceso de reinicio garantiza que se borre todo el estado / información de OpenThread (almacenado en la memoria volátil). Tenga en cuenta que otPlatformReset
no borra ningún estado / información persistente guardado en la memoria no volátil.
Detalles | |||
---|---|---|---|
Parámetros |
|
otRemoveStateChangeCallback
void otRemoveStateChangeCallback( otInstance *aInstance, otStateChangedCallback aCallback, void *aContext )
Esta función elimina una devolución de llamada para indicar cuándo cambia cierta configuración o estado dentro de OpenThread.
Detalles | |||||||
---|---|---|---|---|---|---|---|
Parámetros |
|
otSetStateChangedCallback
otError otSetStateChangedCallback( otInstance *aInstance, otStateChangedCallback aCallback, void *aContext )
Esta función registra una devolución de llamada para indicar cuando cierta configuración o estado cambia dentro de OpenThread.
Detalles | |||||||
---|---|---|---|---|---|---|---|
Parámetros |
| ||||||
Valores devueltos |
|