Mensajes
Este módulo incluye funciones que manipulan los búferes de mensajes de OpenThread.
Resumen
Enumeraciones |
|
---|---|
otMessagePriority{
|
Enum Define los niveles de prioridad de los mensajes de OpenThread. |
Typedefs |
|
---|---|
otBufferInfo
|
typedefstruct otBufferInfo
Representa la información del búfer de mensajes para las diferentes colas que usa la pila de OpenThread. |
otMessage
|
typedefstruct otMessage
Una representación opaca de un búfer de mensajes de OpenThread. |
otMessagePriority
|
typedefenum otMessagePriority
Define los niveles de prioridad de los mensajes de OpenThread. |
otMessageQueueInfo
|
typedefstruct otMessageQueueInfo
Representa información sobre una cola de mensajes. |
otMessageSettings
|
typedefstruct otMessageSettings
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 mensaje 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 del mensaje en bytes.
|
otMessageGetRss(const otMessage *aMessage)
|
int8_t
Muestra el RSS promedio (intensidad de la señal recibida) asociado con el mensaje.
|
otMessageIsLinkSecurityEnabled(const otMessage *aMessage)
|
bool
Indica si la seguridad del vínculo está habilitada para el mensaje.
|
otMessageQueueDequeue(otMessageQueue *aQueue, otMessage *aMessage)
|
void
Quita un mensaje de la cola de mensajes determinada.
|
otMessageQueueEnqueue(otMessageQueue *aQueue, otMessage *aMessage)
|
void
Agrega un mensaje al final de la cola de mensajes determinada.
|
otMessageQueueEnqueueAtHead(otMessageQueue *aQueue, otMessage *aMessage)
|
void
Agrega un mensaje al encabezado/primero de la cola de mensajes determinada.
|
otMessageQueueGetHead(otMessageQueue *aQueue)
|
Muestra un puntero al mensaje en el encabezado de la cola.
|
otMessageQueueGetNext(otMessageQueue *aQueue, const otMessage *aMessage)
|
Muestra un puntero al siguiente mensaje en la cola mediante la iteración 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
|
otMessageResetBufferInfo(otInstance *aInstance)
|
void
Restablece el contador de información del búfer de mensajes a fin de hacer un seguimiento de la cantidad máxima de búferes en uso al mismo tiempo.
|
otMessageSetDirectTransmission(otMessage *aMessage, bool aEnabled)
|
void
Configura o fuerza el reenvío del mensaje mediante una transmisión directa.
|
otMessageSetLength(otMessage *aMessage, uint16_t aLength)
|
Establece 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; |
Representa la información del búfer de mensajes para las diferentes colas que usa la pila de OpenThread. |
otMessageQueue |
Representa una cola de mensajes de OpenThread. |
otMessageQueueInfo |
Representa información sobre una cola de mensajes. |
otMessageSettings |
Representa la configuración de un mensaje. |
Enumeraciones
otMessagePriority
otMessagePriority
Define los niveles de prioridad de los mensajes de OpenThread.
Propiedades | |
---|---|
OT_MESSAGE_PRIORITY_HIGH
|
Nivel de prioridad alto. |
OT_MESSAGE_PRIORITY_LOW
|
Nivel de prioridad bajo. |
OT_MESSAGE_PRIORITY_NORMAL
|
Nivel de prioridad normal. |
Typedefs
Información de otBuffer
struct otBufferInfo otBufferInfo
Representa la información del búfer de mensajes para las diferentes colas que usa la pila de OpenThread.
otMessage
struct otMessage otMessage
Una representación opaca de un búfer de mensajes de OpenThread.
otMessagePriority
enum otMessagePriority otMessagePriority
Define los niveles de prioridad de los mensajes de OpenThread.
otMessageQueueInfo
struct otMessageQueueInfo otMessageQueueInfo
Representa información sobre una cola de mensajes.
otMessageSettings
struct otMessageSettings otMessageSettings
Representa la configuración de un mensaje.
Funciones
otMessageAdjuntar
otError otMessageAppend( otMessage *aMessage, const void *aBuf, uint16_t aLength )
Agregar 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 mensaje 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 |
|
otMessageGetLength
uint16_t otMessageGetLength( const otMessage *aMessage )
Obtiene la longitud del mensaje en bytes.
Detalles | |||
---|---|---|---|
Parámetros |
|
||
Qué muestra |
Es la longitud del mensaje en bytes.
|
otMessageFree
otMessageAttach
otMessageSetLength
otMessageGetOffset
otMessageSetOffset
otMessageRead
otMessageWrite
otMessageGetOffset
uint16_t otMessageGetOffset( const otMessage *aMessage )
Obtiene el desplazamiento del mensaje en bytes.
Detalles | |||
---|---|---|---|
Parámetros |
|
||
Qué muestra |
Es el valor de compensación del mensaje.
|
otMessageFree
otMessageAttach
otMessageGetLength
otMessageSetLength
otMessageSetOffset
otMessageRead
otMessageWrite
otMessageGetRss
int8_t otMessageGetRss( const otMessage *aMessage )
Muestra el RSS promedio (intensidad de la señal recibida) asociado con el mensaje.
Detalles | |
---|---|
Qué muestra |
El valor de RSS promedio (en dBm) o OT_RADIO_RSSI_INVALID si no hay ningún RSS disponible
|
otMessageIsLinkSecurityEnabled
bool otMessageIsLinkSecurityEnabled( const otMessage *aMessage )
Indica si la seguridad del vínculo está habilitada para el mensaje.
Detalles | |||||
---|---|---|---|---|---|
Parámetros |
|
||||
Valores que se muestran |
|
otMessageQueueDequeue
void otMessageQueueDequeue( otMessageQueue *aQueue, otMessage *aMessage )
Quita un mensaje de la cola de mensajes determinada.
Detalles | |||||
---|---|---|---|---|---|
Parámetros |
|
otMessageQueueEnqueue
void otMessageQueueEnqueue( otMessageQueue *aQueue, otMessage *aMessage )
Agrega un mensaje al final de la cola de mensajes determinada.
Detalles | |||||
---|---|---|---|---|---|
Parámetros |
|
otMessageQueueEnqueueAtHead
void otMessageQueueEnqueueAtHead( otMessageQueue *aQueue, otMessage *aMessage )
Agrega un mensaje al encabezado/primero de la cola de mensajes determinada.
Detalles | |||||
---|---|---|---|---|---|
Parámetros |
|
otMessageQueueGetHead
otMessage * otMessageQueueGetHead( otMessageQueue *aQueue )
Muestra un puntero al mensaje 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 )
Muestra un puntero al siguiente mensaje en la cola mediante la iteración 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.
DEBE llamarse solo una vez para una instancia de otMessageQueue
antes de cualquier otra función otMessageQueue
. El comportamiento no está definido si se usan otras APIs 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 |
|
||||||||
Qué muestra |
La cantidad de bytes leídos.
|
otMessageFree
otMessageAttach
otMessageGetLength
otMessageSetLength
otMessageGetOffset
otMessageSetOffset
otMessageWrite
otMessageResetBufferInfo
void otMessageResetBufferInfo( otInstance *aInstance )
Restablece el contador de información del búfer de mensajes a fin de hacer un seguimiento de la cantidad máxima de búferes en uso al mismo tiempo.
Se restablecerá mMaxUsedBuffers
en otBufferInfo
.
Detalles | |||
---|---|---|---|
Parámetros |
|
otMessageSetDirectTransmission
void otMessageSetDirectTransmission( otMessage *aMessage, bool aEnabled )
Configura o fuerza el reenvío del mensaje mediante una transmisión directa.
El parámetro de configuración predeterminado de un mensaje nuevo es false
.
Detalles | |||||
---|---|---|---|---|---|
Parámetros |
|
otMessageSetLength
otError otMessageSetLength( otMessage *aMessage, uint16_t aLength )
Establece 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 |
La cantidad de bytes escritos.
|
otMessageFree
otMessageAttach
otMessageGetLength
otMessageSetLength
otMessageGetOffset
otMessageSetOffset
otMessageRead
Recursos
Los temas de referencia de la API de OpenThread se originan a partir del código fuente, disponible en GitHub. Para obtener más información o colaborar con nuestra documentación, consulta la sección Recursos.