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 de los mensajes OpenThread. |
Typedefs | |
---|---|
otBufferInfo | typedefstruct otBufferInfo Esta estructura representa la información del búfer de mensajes. |
otMessage | typedefstruct otMessage Esta estructura apunta a un búfer de mensajes OpenThread. |
otMessagePriority | typedefenum otMessagePriority Esta enumeración define los niveles de prioridad de los mensajes OpenThread. |
otMessageSettings | typedefstruct otMessageSettings Esta estructura representa una configuración de mensaje. |
Funciones | |
---|---|
otMessageAppend ( otMessage *aMessage, const void *aBuf, uint16_t aLength) | Agrega 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 (intensidad de la señal recibida) promedio asociado con el mensaje. |
otMessageIsLinkSecurityEnabled (const otMessage *aMessage) | bool Esta función indica si la seguridad de 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 / 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 iterando hacia adelante (de principio a fin). |
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 establece / 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. |
otMessage | Esta estructura apunta a un búfer de mensajes OpenThread. |
otMessageQueue | Esta estructura representa una cola de mensajes OpenThread. |
otMessageSettings | Esta estructura representa una configuración de mensaje. |
Enumeraciones
otMessagePriority
otMessagePriority
Typedefs
otBufferInfo
struct otBufferInfo otBufferInfo
Esta estructura representa la información del búfer de mensajes.
otMessagePriority
enum otMessagePriority otMessagePriority
Esta enumeración define los niveles de prioridad de los mensajes OpenThread.
otMessageSettings
struct otMessageSettings otMessageSettings
Esta estructura representa una configuración de mensaje.
Funciones
otMessageAppend
otError otMessageAppend( otMessage *aMessage, const void *aBuf, uint16_t aLength )
Agrega bytes a un mensaje.
Detalles | |||||||
---|---|---|---|---|---|---|---|
Parámetros |
| ||||||
Valores devueltos |
|
otMessageFree
otMessageGetLength
otMessageSetLength
otMessageGetOffset
otMessageSetOffset
otMessageRead
otMessageWrite
otMessageFree
void otMessageFree( otMessage *aMessage )
Libera un búfer de mensajes asignado.
Detalles | |||
---|---|---|---|
Parámetros |
|
otMessageAppend
otMessageGetLength
otMessageSetLength
otMessageGetOffset
otMessageSetOffset
otMessageRead
otMessageWrite
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. |
otMessageFree
otMessageAppend
otMessageSetLength
otMessageGetOffset
otMessageSetOffset
otMessageRead
otMessageWrite
otMessageSetLength
otMessageGetOffset
uint16_t otMessageGetOffset( const otMessage *aMessage )
Obtenga el desplazamiento del mensaje en bytes.
Detalles | |||
---|---|---|---|
Parámetros |
| ||
Devoluciones | El valor de compensación del mensaje. |
otMessageFree
otMessageAppend
otMessageGetLength
otMessageSetLength
otMessageSetOffset
otMessageRead
otMessageWrite
otMessageGetRss
int8_t otMessageGetRss( const otMessage *aMessage )
Esta función devuelve el RSS (intensidad de la señal recibida) promedio asociado con el mensaje.
Detalles | |
---|---|
Devoluciones | El valor medio de RSS (en dBm) o OT_RADIO_RSSI_INVALID si no hay ningún RSS medio disponible. |
otMessageIsLinkSecurityEnabled
bool otMessageIsLinkSecurityEnabled( const otMessage *aMessage )
Esta función indica si la seguridad de 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 / 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 de la cola iterando hacia adelante (de principio a fin).
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 unMessage 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 de otMessageQueue
. El comportamiento no está definido si se utilizan otras API de cola con un otMessageQueue
antes de que se inicialice o si se inicializa más de una vez.
Detalles | |||
---|---|---|---|
Parámetros |
|
otMessageRead
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. |
otMessageFree
otMessageAppend
otMessageGetLength
otMessageSetLength
otMessageGetOffset
otMessageSetOffset
otMessageWrite
otMessageSetDirectTransmission
void otMessageSetDirectTransmission( otMessage *aMessage, bool aEnabled )
Esta función establece / fuerza el reenvío del mensaje mediante transmisión directa.
La configuración predeterminada para un mensaje nuevo 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 |
|
otMessageFree
otMessageAppend
otMessageGetLength
otMessageGetOffset
otMessageSetOffset
otMessageRead
otMessageWrite
otMessageSetOffset
void otMessageSetOffset( otMessage *aMessage, uint16_t aOffset )
Establezca el desplazamiento del mensaje en bytes.
Detalles | |||||
---|---|---|---|---|---|
Parámetros |
|
otMessageFree
otMessageAppend
otMessageGetLength
otMessageSetLength
otMessageGetOffset
otMessageRead
otMessageWrite
otMessageWrite
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. |
otMessageFree
otMessageAppend
otMessageGetLength
otMessageSetLength
otMessageGetOffset
otMessageSetOffset
otMessageRead