Mensaje
Este módulo incluye funciones que manipulan los búferes de mensajes de OpenThread.
Resumen
Enumeraciones |
|
---|---|
otMessagePriority{
|
enum Esta enumeración define los niveles de prioridad del mensaje de OpenThread. |
Typedefs |
|
---|---|
otBufferInfo
|
typedefstruct otBufferInfo
Esta estructura representa la información del búfer de mensajes para las diferentes colas que utiliza la pila de OpenThread. |
otMessage
|
typedefstruct otMessage
Este tipo es una representación opaca de un búfer de mensajes de OpenThread. |
otMessagePriority
|
typedefenum otMessagePriority
Esta enumeración define los niveles de prioridad del mensaje de OpenThread. |
otMessageQueueInfo
|
typedefstruct otMessageQueueInfo
Esta estructura representa información sobre una cola de mensajes. |
otMessageSettings
|
typedefstruct otMessageSettings
Esta estructura representa la configuración de un mensaje. |
Functions |
|
---|---|
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
Obtén la información del búfer de mensajes.
|
otMessageGetLength(const otMessage *aMessage)
|
uint16_t
Obtiene la longitud del mensaje en bytes.
|
otMessageGetOffset(const otMessage *aMessage)
|
uint16_t
Obtiene el desplazamiento de mensajes en bytes.
|
otMessageGetRss(const otMessage *aMessage)
|
int8_t
Esta función muestra 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 vínculo está habilitada o no en el mensaje.
|
otMessageQueueDequeue(otMessageQueue *aQueue, otMessage *aMessage)
|
void
Esta función quita un mensaje de la cola de mensajes determinada.
|
otMessageQueueEnqueue(otMessageQueue *aQueue, otMessage *aMessage)
|
void
Esta función agrega un mensaje al final de la cola de mensajes determinada.
|
otMessageQueueEnqueueAtHead(otMessageQueue *aQueue, otMessage *aMessage)
|
void
Esta función agrega un mensaje al principio o al frente de la cola de mensajes.
|
otMessageQueueGetHead(otMessageQueue *aQueue)
|
Esta función muestra un puntero al mensaje que se encuentra en el encabezado de la cola.
|
otMessageQueueGetNext(otMessageQueue *aQueue, const otMessage *aMessage)
|
Esta función muestra un puntero al siguiente mensaje en la cola iterando hacia adelante (de la cabeza a la cola).
|
otMessageQueueInit(otMessageQueue *aQueue)
|
void
Inicializa 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 o fuerza el reenvío del mensaje mediante la transmisión directa.
|
otMessageSetLength(otMessage *aMessage, uint16_t aLength)
|
Configura la longitud del mensaje en bytes.
|
otMessageSetOffset(otMessage *aMessage, uint16_t aOffset)
|
void
Configura el desplazamiento del mensaje en bytes.
|
otMessageWrite(otMessage *aMessage, uint16_t aOffset, const void *aBuf, uint16_t aLength)
|
int
Escribir bytes en un mensaje
|
Structs |
|
---|---|
OtBufferInfo |
Esta estructura representa la información del búfer de mensajes para las diferentes colas que utiliza la pila de OpenThread. |
otMessageQueue |
Esta estructura representa una cola de mensajes de OpenThread. |
otMessageQueueInfo |
Esta estructura representa información sobre una cola de mensajes. |
Configuración del mensaje de ot |
Esta estructura representa la configuración de un mensaje. |
Enumeraciones
otMessagePriority
otMessagePriority
Esta enumeración define los niveles de prioridad del mensaje de OpenThread.
Properties | |
---|---|
OT_MESSAGE_PRIORITY_HIGH
|
Nivel de prioridad alta. |
OT_MESSAGE_PRIORITY_LOW
|
Nivel de prioridad bajo. |
OT_MESSAGE_PRIORITY_NORMAL
|
Nivel de prioridad normal. |
Typedefs
Información de búfer
struct otBufferInfo otBufferInfo
Esta estructura representa la información del búfer de mensajes para las diferentes colas que utiliza la pila de OpenThread.
Mensaje de ot
struct otMessage otMessage
Este tipo es una representación opaca de un búfer de mensajes de OpenThread.
otMessagePriority
enum otMessagePriority otMessagePriority
Esta enumeración define los niveles de prioridad del mensaje de OpenThread.
otMessageQueueInfo
struct otMessageQueueInfo otMessageQueueInfo
Esta estructura representa información sobre una cola de mensajes.
Configuración del mensaje de ot
struct otMessageSettings otMessageSettings
Esta estructura representa la configuración de un mensaje.
Functions
otMessageAdjuntar
otError otMessageAppend( otMessage *aMessage, const void *aBuf, uint16_t aLength )
Agrega bytes a un mensaje.
Detalles | |||||||
---|---|---|---|---|---|---|---|
Parámetros |
|
||||||
Valores que se muestran |
|
otMessageFree
otMessageGetLength
otMessageSetLength
otMessageGetOffset
otMessageSetOffset
otMessageRead
otMessageWrite
otMessageFree
void otMessageFree( otMessage *aMessage )
Libera un búfer de mensajes asignado.
Detalles | |||
---|---|---|---|
Parámetros |
|
otMessageAttach
otMessageGetLength
otMessageSetLength
otMessageGetOffset
otMessageSetOffset
otMessageRead
otMessageWrite
otMessageGetBufferInfo
void otMessageGetBufferInfo( otInstance *aInstance, otBufferInfo *aBufferInfo )
Obtén la información del búfer de mensajes.
Detalles | |||||
---|---|---|---|---|---|
Parámetros |
|
oMessageMessageGetLength
uint16_t otMessageGetLength( const otMessage *aMessage )
Obtiene la longitud del mensaje en bytes.
Detalles | |||
---|---|---|---|
Parámetros |
|
||
Qué muestra |
La longitud del mensaje en bytes.
|
otMessageFree
otMessageAttach
otMessageSetLength
otMessageGetOffset
otMessageSetOffset
otMessageRead
otMessageWrite1
8 8
otMessageGetOffset
uint16_t otMessageGetOffset( const otMessage *aMessage )
Obtiene el desplazamiento de mensajes en bytes.
Detalles | |||
---|---|---|---|
Parámetros |
|
||
Qué muestra |
El valor de compensación del mensaje
|
otMessageFree
otMessageAttach
otMessageGetLength
otMessageSetLength
otMessageSetOffset
otMessageRead
otMessageWrite
otMessageGetRss
int8_t otMessageGetRss( const otMessage *aMessage )
Esta función muestra el RSS promedio (intensidad de la señal recibida) asociado con el mensaje.
Detalles | |
---|---|
Qué muestra |
Es el valor de RSS promedio (en dBm) o OT_RADIO_RSSI_INVALID si no hay un RSS promedio disponible.
|
otMessageIsLinkSecurityEnabled
bool otMessageIsLinkSecurityEnabled( const otMessage *aMessage )
Esta función indica si la seguridad del vínculo está habilitada o no en el mensaje.
Detalles | |||||
---|---|---|---|---|---|
Parámetros |
|
||||
Valores que se muestran |
|
otMessageQueueDequeue
void otMessageQueueDequeue( otMessageQueue *aQueue, otMessage *aMessage )
Esta función quita un mensaje de la cola de mensajes determinada.
Detalles | |||||
---|---|---|---|---|---|
Parámetros |
|
otMessageQueueEnqueue
void otMessageQueueEnqueue( otMessageQueue *aQueue, otMessage *aMessage )
Esta función agrega un mensaje al final de la cola de mensajes determinada.
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.
Detalles | |||||
---|---|---|---|---|---|
Parámetros |
|
otMessageQueueGetHead
otMessage * otMessageQueueGetHead( otMessageQueue *aQueue )
Esta función muestra un puntero al mensaje que se encuentra en el encabezado de la cola.
Detalles | |||
---|---|---|---|
Parámetros |
|
||
Qué muestra |
Un puntero al mensaje en el encabezado de la cola o NULL si la cola está vacía.
|
otMessageQueueGetNext
otMessage * otMessageQueueGetNext( otMessageQueue *aQueue, const otMessage *aMessage )
Esta función muestra un puntero al siguiente mensaje en la cola iterando hacia adelante (de la cabeza a la cola).
Detalles | |||||
---|---|---|---|---|---|
Parámetros |
|
||||
Qué muestra |
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 aMessageis not in the queue aQueue`. |
otMessageQueueInit
void otMessageQueueInit( otMessageQueue *aQueue )
Inicializa la cola de mensajes.
Esta función DEBE llamarse una vez y solo una vez para una instancia otMessageQueue
antes que cualquier otra función otMessageQueue
. El comportamiento no está definido si otras API de cola se usan con 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 |
|
||||||||
Qué muestra |
La cantidad de bytes leídos.
|
otMessageFree
otMessageAttach
otMessageGetLength
otMessageSetLength
otMessageGetOffset
otMessageSetOffset
otMessageWrite
otMessageSetDirectTransmission
void otMessageSetDirectTransmission( otMessage *aMessage, bool aEnabled )
Esta función configura o fuerza el reenvío del mensaje mediante la transmisión directa.
El parámetro de configuración predeterminado para los mensajes nuevos es false
.
Detalles | |||||
---|---|---|---|---|---|
Parámetros |
|
otMessageSetLength
otError otMessageSetLength( otMessage *aMessage, uint16_t aLength )
Configura la longitud del mensaje en bytes.
Detalles | |||||
---|---|---|---|---|---|
Parámetros |
|
||||
Valores que se muestran |
|
otMessageFree
otMessageAttach
otMessageGetLength
otMessageGetOffset
otMessageSetOffset
otMessageRead
otMessageWrite
otMessageSetOffset
void otMessageSetOffset( otMessage *aMessage, uint16_t aOffset )
Configura el desplazamiento del mensaje en bytes.
Detalles | |||||
---|---|---|---|---|---|
Parámetros |
|
otMessageFree
otMessageAttach
otMessageGetLength
otMessageSetLength
otMessageGetOffset
otMessageRead
otMessageWrite
OtMessageWrite
int otMessageWrite( otMessage *aMessage, uint16_t aOffset, const void *aBuf, uint16_t aLength )
Escribir bytes en un mensaje
Detalles | |||||||||
---|---|---|---|---|---|---|---|---|---|
Parámetros |
|
||||||||
Qué muestra |
Es la cantidad de bytes escritos.
|
otMessageFree
otMessageAttach
otMessageGetLength
otMessageSetLength
otMessageGetOffset
otMessageSetOffset
otMessageRead
Recursos
Los temas de referencia de la API de OpenThread se originan en el código fuente, disponible en GitHub. Para obtener más información o colaborar con nuestra documentación, consulta Recursos.