Mensaje
Este módulo incluye funciones que manipulan los búferes de mensajes de OpenThread.
Resumen
enumeraciones | |
---|---|
otMessagePriority { | enumeración Esta enumeración define los niveles de prioridad del mensaje OpenThread. |
definiciones de tipo | |
---|---|
otBufferInfo | definición de tipostruct otBufferInfo Esta estructura representa la información del búfer de mensajes para diferentes colas utilizadas por la pila OpenThread. |
otMessage | definición de tipostruct otMessage Este tipo es una representación opaca de un búfer de mensajes OpenThread. |
otMessagePriority | definición de tipoenum otMessagePriority Esta enumeración define los niveles de prioridad del mensaje OpenThread. |
otMessageQueueInfo | definición de tipostruct otMessageQueueInfo Esta estructura representa información sobre una cola de mensajes. |
otMessageSettings | definición de tipostruct otMessageSettings Esta estructura representa la configuración de un mensaje. |
Funciones | |
---|---|
otMessageAppend ( otMessage *aMessage, const void *aBuf, uint16_t aLength) | Agregar bytes a un mensaje. |
otMessageFree ( otMessage *aMessage) | void Libera un búfer de mensajes asignado. |
otMessageGetBufferInfo ( otInstance *aInstance, otBufferInfo *aBufferInfo) | void Obtenga la información del búfer de mensajes. |
otMessageGetLength (const otMessage *aMessage) | uint16_t Obtenga la longitud del mensaje en bytes. |
otMessageGetOffset (const otMessage *aMessage) | uint16_t Obtenga el desplazamiento del mensaje en bytes. |
otMessageGetRss (const otMessage *aMessage) | int8_t Esta función devuelve el RSS promedio (intensidad de la señal recibida) asociado con el mensaje. |
otMessageIsLinkSecurityEnabled (const otMessage *aMessage) | bool Esta función indica si la seguridad del enlace está habilitada o no para el mensaje. |
otMessageQueueDequeue ( otMessageQueue *aQueue, otMessage *aMessage) | void Esta función elimina un mensaje de la cola de mensajes dada. |
otMessageQueueEnqueue ( otMessageQueue *aQueue, otMessage *aMessage) | void Esta función agrega un mensaje al final de la cola de mensajes dada. |
otMessageQueueEnqueueAtHead ( otMessageQueue *aQueue, otMessage *aMessage) | void Esta función agrega un mensaje al principio o al frente de la cola de mensajes dada. |
otMessageQueueGetHead ( otMessageQueue *aQueue) | Esta función devuelve un puntero al mensaje al principio de la cola. |
otMessageQueueGetNext ( otMessageQueue *aQueue, const otMessage *aMessage) | Esta función devuelve un puntero al siguiente mensaje en la cola al iterar hacia adelante (de la cabeza a la cola). |
otMessageQueueInit ( otMessageQueue *aQueue) | void Inicialice la cola de mensajes. |
otMessageRead (const otMessage *aMessage, uint16_t aOffset, void *aBuf, uint16_t aLength) | uint16_t Leer bytes de un mensaje. |
otMessageSetDirectTransmission ( otMessage *aMessage, bool aEnabled) | void Esta función configura/fuerza el reenvío del mensaje mediante transmisión directa. |
otMessageSetLength ( otMessage *aMessage, uint16_t aLength) | Establezca la longitud del mensaje en bytes. |
otMessageSetOffset ( otMessage *aMessage, uint16_t aOffset) | void Establezca el desplazamiento del mensaje en bytes. |
otMessageWrite ( otMessage *aMessage, uint16_t aOffset, const void *aBuf, uint16_t aLength) | int Escribe bytes en un mensaje. |
estructuras | |
---|---|
otBufferInfo | Esta estructura representa la información del búfer de mensajes para diferentes colas utilizadas por la pila OpenThread. |
otMessageQueue | Esta estructura representa una cola de mensajes OpenThread. |
otMessageQueueInfo | Esta estructura representa información sobre una cola de mensajes. |
otConfiguración de mensajes | Esta estructura representa la configuración de un mensaje. |
enumeraciones
otMensajePrioridad
otMessagePriority
definiciones de tipo
otBufferInfo
struct otBufferInfo otBufferInfo
Esta estructura representa la información del búfer de mensajes para diferentes colas utilizadas por la pila OpenThread.
otMensaje
struct otMessage otMessage
Este tipo es una representación opaca de un búfer de mensajes OpenThread.
otMensajePrioridad
enum otMessagePriority otMessagePriority
Esta enumeración define los niveles de prioridad del mensaje OpenThread.
otMessageQueueInfo
struct otMessageQueueInfo otMessageQueueInfo
Esta estructura representa información sobre una cola de mensajes.
otConfiguración de mensajes
struct otMessageSettings otMessageSettings
Esta estructura representa la configuración de un mensaje.
Funciones
otMensajeAnexar
otError otMessageAppend( otMessage *aMessage, const void *aBuf, uint16_t aLength )
Agregar bytes a un mensaje.
Detalles | |||||||
---|---|---|---|---|---|---|---|
Parámetros |
| ||||||
Valores devueltos |
|
otMensaje Gratis
otMessageGetLength
otMessageSetLength
otMessageGetOffset
otMessageSetOffset
otMensajeLeído
otMensajeEscribir
otMensaje Gratis
void otMessageFree( otMessage *aMessage )
Libera un búfer de mensajes asignado.
Detalles | |||
---|---|---|---|
Parámetros |
|
otMensajeAnexar
otMessageGetLength
otMessageSetLength
otMessageGetOffset
otMessageSetOffset
otMensajeLeído
otMensajeEscribir
otMessageGetBufferInfo
void otMessageGetBufferInfo( otInstance *aInstance, otBufferInfo *aBufferInfo )
Obtenga la información del búfer de mensajes.
Detalles | |||||
---|---|---|---|---|---|
Parámetros |
|
otMessageGetLength
uint16_t otMessageGetLength( const otMessage *aMessage )
Obtenga la longitud del mensaje en bytes.
Detalles | |||
---|---|---|---|
Parámetros |
| ||
Devoluciones | La longitud del mensaje en bytes. |
otMensaje Gratis
otMensajeAnexar
otMessageSetLength
otMessageGetOffset
otMessageSetOffset
otMensajeLeído
otMensajeEscribir
otMessageSetLength
otMessageGetOffset
uint16_t otMessageGetOffset( const otMessage *aMessage )
Obtenga el desplazamiento del mensaje en bytes.
Detalles | |||
---|---|---|---|
Parámetros |
| ||
Devoluciones | El valor de desplazamiento del mensaje. |
otMensaje Gratis
otMensajeAnexar
otMessageGetLength
otMessageSetLength
otMessageSetOffset
otMensajeLeído
otMensajeEscribir
otMessageGetRss
int8_t otMessageGetRss( const otMessage *aMessage )
Esta función devuelve el RSS promedio (intensidad de la señal recibida) asociado con el mensaje.
Detalles | |
---|---|
Devoluciones | El valor promedio de RSS (en dBm) o OT_RADIO_RSSI_INVALID si no hay un promedio de RSS disponible. |
otMessageIsLinkSecurityEnabled
bool otMessageIsLinkSecurityEnabled( const otMessage *aMessage )
Esta función indica si la seguridad del enlace está habilitada o no para el mensaje.
Detalles | |||||
---|---|---|---|---|---|
Parámetros |
| ||||
Valores devueltos |
|
otMessageQueueDequeue
void otMessageQueueDequeue( otMessageQueue *aQueue, otMessage *aMessage )
Esta función elimina un mensaje de la cola de mensajes dada.
Detalles | |||||
---|---|---|---|---|---|
Parámetros |
|
otMessageQueueEnqueue
void otMessageQueueEnqueue( otMessageQueue *aQueue, otMessage *aMessage )
Esta función agrega un mensaje al final de la cola de mensajes dada.
Detalles | |||||
---|---|---|---|---|---|
Parámetros |
|
otMessageQueueEnqueueAtHead
void otMessageQueueEnqueueAtHead( otMessageQueue *aQueue, otMessage *aMessage )
Esta función agrega un mensaje al principio o al frente de la cola de mensajes dada.
Detalles | |||||
---|---|---|---|---|---|
Parámetros |
|
otMessageQueueGetHead
otMessage * otMessageQueueGetHead( otMessageQueue *aQueue )
Esta función devuelve un puntero al mensaje al principio de la cola.
Detalles | |||
---|---|---|---|
Parámetros |
| ||
Devoluciones | Un puntero al mensaje al principio de la cola o NULL si la cola está vacía. |
otMessageQueueGetNext
otMessage * otMessageQueueGetNext( otMessageQueue *aQueue, const otMessage *aMessage )
Esta función devuelve un puntero al siguiente mensaje en la cola al iterar hacia adelante (de la cabeza a la cola).
Detalles | |||||
---|---|---|---|---|---|
Parámetros |
| ||||
Devoluciones | Un puntero al siguiente mensaje en la cola después de aMessage o NULL si aMessage is the tail of queue. NULL is returned if aMessage is not in the queue aQueue`. |
otMessageQueueInit
void otMessageQueueInit( otMessageQueue *aQueue )
Inicialice la cola de mensajes.
Esta función DEBE llamarse una vez y solo una vez para una instancia de otMessageQueue
antes que cualquier otra función otMessageQueue
. El comportamiento no está definido si se utilizan otras API de cola con otMessageQueue
antes de que se inicialice o si se inicializa más de una vez.
Detalles | |||
---|---|---|---|
Parámetros |
|
otMensajeLeído
uint16_t otMessageRead( const otMessage *aMessage, uint16_t aOffset, void *aBuf, uint16_t aLength )
Leer bytes de un mensaje.
Detalles | |||||||||
---|---|---|---|---|---|---|---|---|---|
Parámetros |
| ||||||||
Devoluciones | El número de bytes leídos. |
otMensaje Gratis
otMensajeAnexar
otMessageGetLength
otMessageSetLength
otMessageGetOffset
otMessageSetOffset
otMensajeEscribir
otMessageSetDirectTransmission
void otMessageSetDirectTransmission( otMessage *aMessage, bool aEnabled )
Esta función configura/fuerza el reenvío del mensaje mediante transmisión directa.
La configuración predeterminada para un nuevo mensaje es false
.
Detalles | |||||
---|---|---|---|---|---|
Parámetros |
|
otMessageSetLength
otError otMessageSetLength( otMessage *aMessage, uint16_t aLength )
Establezca la longitud del mensaje en bytes.
Detalles | |||||
---|---|---|---|---|---|
Parámetros |
| ||||
Valores devueltos |
|
otMensaje Gratis
otMensajeAnexar
otMessageGetLength
otMessageGetOffset
otMessageSetOffset
otMensajeLeído
otMensajeEscribir
otMessageSetOffset
void otMessageSetOffset( otMessage *aMessage, uint16_t aOffset )
Establezca el desplazamiento del mensaje en bytes.
Detalles | |||||
---|---|---|---|---|---|
Parámetros |
|
otMensaje Gratis
otMensajeAnexar
otMessageGetLength
otMessageSetLength
otMessageGetOffset
otMensajeLeído
otMensajeEscribir
otMensajeEscribir
int otMessageWrite( otMessage *aMessage, uint16_t aOffset, const void *aBuf, uint16_t aLength )
Escribe bytes en un mensaje.
Detalles | |||||||||
---|---|---|---|---|---|---|---|---|---|
Parámetros |
| ||||||||
Devoluciones | El número de bytes escritos. |
otMensaje Gratis
otMensajeAnexar
otMessageGetLength
otMessageSetLength
otMessageGetOffset
otMessageSetOffset
otMensajeLeído
Recursos
Los temas de referencia de la API OpenThread se originan en el código fuente, disponible en GitHub . Para obtener más información o contribuir a nuestra documentación, consulte Recursos .