Google is committed to advancing racial equity for Black communities. See how.
Se usó la API de Cloud Translation para traducir esta página.
Switch to English

Mensaje

Este módulo incluye funciones que manipulan los buffers de mensajes OpenThread.

Resumen

Enumeraciones

otMessagePriority {
OT_MESSAGE_PRIORITY_LOW = 0,
OT_MESSAGE_PRIORITY_NORMAL = 1,
OT_MESSAGE_PRIORITY_HIGH = 2
}
enumeración
Esta enumeración define los niveles de prioridad del mensaje OpenThread.

Typedefs

otBufferInfo typedef
struct otBufferInfo
Esta estructura representa la información del búfer del mensaje.
otMessage typedef
struct otMessage
Esta estructura apunta a un búfer de mensajes OpenThread.
otMessagePriority typedef
Esta enumeración define los niveles de prioridad del mensaje OpenThread.
otMessageSettings typedef
Esta estructura representa la configuración de un mensaje.

Las funciones

otMessageAppend ( otMessage *aMessage, const void *aBuf, uint16_t aLength)
Añadir bytes a un mensaje.
otMessageFree ( otMessage *aMessage)
void
Libere un búfer de mensajes asignado.
otMessageGetBufferInfo ( otInstance *aInstance, otBufferInfo *aBufferInfo)
void
Obtenga la información del Buffer de mensajes.
otMessageGetLength (const otMessage *aMessage)
uint16_t
Obtenga la longitud del mensaje en bytes.
otMessageGetOffset (const otMessage *aMessage)
uint16_t
Obtener el desplazamiento del mensaje en bytes.
otMessageGetRss (const otMessage *aMessage)
int8_t
Esta función devuelve el RSS promedio (intensidad de 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 en la cabecera / frente de la cola de mensajes dada.
otMessageQueueGetHead ( otMessageQueue *aQueue)
Esta función devuelve un puntero al mensaje en la cabecera 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 / obliga al mensaje a reenviarse mediante transmisión directa.
otMessageSetLength ( otMessage *aMessage, uint16_t aLength)
Establecer 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
Escribir bytes a un mensaje.

Estructuras

otBufferInfo

Esta estructura representa la información del búfer del mensaje.

otMessage

Esta estructura apunta a un búfer de mensajes OpenThread.

otMessageQueue

Esta estructura representa una cola de mensajes OpenThread.

otMessageSettings

Esta estructura representa la configuración de un mensaje.

Enumeraciones

otMessagePriority

 otMessagePriority

Esta enumeración define los niveles de prioridad del mensaje OpenThread.

Propiedades
OT_MESSAGE_PRIORITY_HIGH

Nivel de alta prioridad.

OT_MESSAGE_PRIORITY_LOW

Nivel de baja prioridad.

OT_MESSAGE_PRIORITY_NORMAL

Nivel de prioridad normal.

Typedefs

otBufferInfo

struct otBufferInfo otBufferInfo

Esta estructura representa la información del búfer del mensaje.

otMessage

struct otMessage otMessage

Esta estructura apunta a un búfer de mensajes OpenThread.

otMessagePriority

enum otMessagePriority otMessagePriority

Esta enumeración define los niveles de prioridad del mensaje OpenThread.

otMessageSettings

struct otMessageSettings otMessageSettings

Esta estructura representa la configuración de un mensaje.

Las funciones

otMessageAppend

 otError otMessageAppend(
  otMessage *aMessage,
  const void *aBuf,
  uint16_t aLength
)

Añadir bytes a un mensaje.

Detalles
Parámetros
[in] aMessage
Un puntero a un búfer de mensajes.
[in] aBuf
Un puntero a los datos a agregar.
[in] aLength
Número de bytes a agregar.
Valores de retorno
OT_ERROR_NONE
Se ha añadido correctamente al mensaje.
OT_ERROR_NO_BUFS
No hay buffers disponibles para hacer crecer el mensaje.
Ver también:
otMessageFree
otMessageGetLength
otMessageSetLength
otMessageGetOffset
otMessageSetOffset
otMessageRead
otMessageWrite

otMessageFree

void otMessageFree(
  otMessage *aMessage
)

Libere un búfer de mensajes asignado.

Detalles
Parámetros
[in] aMessage
Un puntero a un búfer de mensajes.
Ver también:
otMessageAppend
otMessageGetLength
otMessageSetLength
otMessageGetOffset
otMessageSetOffset
otMessageRead
otMessageWrite

otMessageGetBufferInfo

void otMessageGetBufferInfo(
  otInstance *aInstance,
  otBufferInfo *aBufferInfo
)

Obtenga la información del Buffer de mensajes.

Detalles
Parámetros
[in] aInstance
Un puntero a la instancia de OpenThread.
[out] aBufferInfo
Un puntero donde se escribe la información del búfer de mensajes.

otMessageGetLength

uint16_t otMessageGetLength(
  const otMessage *aMessage
)

Obtenga la longitud del mensaje en bytes.

Detalles
Parámetros
[in] aMessage
Un puntero a un búfer de mensajes.
Devoluciones
La longitud del mensaje en bytes.
Ver también:
otMessageFree
otMessageAppend
otMessageSetLength
otMessageGetOffset
otMessageSetOffset
otMessageRead
otMessageWrite
otMessageSetLength

otMessageGetOffset

uint16_t otMessageGetOffset(
  const otMessage *aMessage
)

Obtener el desplazamiento del mensaje en bytes.

Detalles
Parámetros
[in] aMessage
Un puntero a un búfer de mensajes.
Devoluciones
El valor de desplazamiento del mensaje.
Ver también:
otMessageFree
otMessageAppend
otMessageGetLength
otMessageSetLength
otMessageSetOffset
otMessageRead
otMessageWrite

otMessageGetRss

int8_t otMessageGetRss(
  const otMessage *aMessage
)

Esta función devuelve el RSS promedio (intensidad de señal recibida) asociado con el mensaje.

Detalles
Devoluciones
El valor RSS promedio (en dBm) o OT_RADIO_RSSI_INVALID si no hay RSS promedio 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
[in] aMessage
Un puntero a un búfer de mensajes.
Valores de retorno
TRUE
Si la seguridad del enlace está habilitada.
FALSE
Si la seguridad del enlace no está habilitada.

otMessageQueueDequeue

void otMessageQueueDequeue(
  otMessageQueue *aQueue,
  otMessage *aMessage
)

Esta función elimina un mensaje de la cola de mensajes dada.

Detalles
Parámetros
[in] aQueue
Un puntero a la cola de mensajes.
[in] aMessage
El mensaje a eliminar.

otMessageQueueEnqueue

void otMessageQueueEnqueue(
  otMessageQueue *aQueue,
  otMessage *aMessage
)

Esta función agrega un mensaje al final de la cola de mensajes dada.

Detalles
Parámetros
[in] aQueue
Un puntero a la cola de mensajes.
[in] aMessage
El mensaje para agregar.

otMessageQueueEnqueueAtHead

void otMessageQueueEnqueueAtHead(
  otMessageQueue *aQueue,
  otMessage *aMessage
)

Esta función agrega un mensaje en la cabecera / frente de la cola de mensajes dada.

Detalles
Parámetros
[in] aQueue
Un puntero a la cola de mensajes.
[in] aMessage
El mensaje para agregar.

otMessageQueueGetHead

 otMessage * otMessageQueueGetHead(
  otMessageQueue *aQueue
)

Esta función devuelve un puntero al mensaje en la cabecera de la cola.

Detalles
Parámetros
[in] aQueue
Un puntero a una cola de mensajes.
Devoluciones
Un puntero al mensaje en la cabecera 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 iterando hacia adelante (de principio a fin).

Detalles
Parámetros
[in] aQueue
Un puntero a una cola de mensajes.
[in] aMessage
Un puntero al búfer de mensajes actual.
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 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
[in] aQueue
Un puntero a una cola de mensajes.

otMessageRead

uint16_t otMessageRead(
  const otMessage *aMessage,
  uint16_t aOffset,
  void *aBuf,
  uint16_t aLength
)

Leer bytes de un mensaje.

Detalles
Parámetros
[in] aMessage
Un puntero a un búfer de mensajes.
[in] aOffset
Un desplazamiento en bytes.
[in] aBuf
Un puntero a un búfer donde se leen los bytes del mensaje
[in] aLength
Número de bytes a leer.
Devoluciones
El número de bytes leídos.
Ver también:
otMessageFree
otMessageAppend
otMessageGetLength
otMessageSetLength
otMessageGetOffset
otMessageSetOffset
otMessageWrite

otMessageSetDirectTransmission

void otMessageSetDirectTransmission(
  otMessage *aMessage,
  bool aEnabled
)

Esta función establece / obliga al mensaje a reenviarse mediante transmisión directa.

La configuración predeterminada para un nuevo mensaje es false .

Detalles
Parámetros
[in] aMessage
Un puntero a un búfer de mensajes.
[in] aEnabled
Si es true , el mensaje se ve obligado a utilizar la transmisión directa. Si es false , el mensaje sigue el procedimiento normal.

otMessageSetLength

 otError otMessageSetLength(
  otMessage *aMessage,
  uint16_t aLength
)

Establecer la longitud del mensaje en bytes.

Detalles
Parámetros
[in] aMessage
Un puntero a un búfer de mensajes.
[in] aLength
Una longitud en bytes.
Valores de retorno
OT_ERROR_NONE
Establecer correctamente la longitud del mensaje.
OT_ERROR_NO_BUFS
No hay buffers disponibles para hacer crecer el mensaje.
Ver también:
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
[in] aMessage
Un puntero a un búfer de mensajes.
[in] aOffset
Un desplazamiento en bytes.
Ver también:
otMessageFree
otMessageAppend
otMessageGetLength
otMessageSetLength
otMessageGetOffset
otMessageRead
otMessageWrite

otMessageWrite

int otMessageWrite(
  otMessage *aMessage,
  uint16_t aOffset,
  const void *aBuf,
  uint16_t aLength
)

Escribir bytes a un mensaje.

Detalles
Parámetros
[in] aMessage
Un puntero a un búfer de mensajes.
[in] aOffset
Un desplazamiento en bytes.
[in] aBuf
Un puntero a un búfer desde el que se escriben los bytes del mensaje.
[in] aLength
Número de bytes para escribir.
Devoluciones
El número de bytes escritos.
Ver también:
otMessageFree
otMessageAppend
otMessageGetLength
otMessageSetLength
otMessageGetOffset
otMessageSetOffset
otMessageRead