Mensaje

 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.

struct otBufferInfo otBufferInfo

Esta estructura representa la información del búfer de mensajes para las diferentes colas que utiliza la pila de OpenThread.

struct otMessage otMessage

Este tipo es una representación opaca de un búfer de mensajes de OpenThread.

enum otMessagePriority otMessagePriority

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

struct otMessageQueueInfo otMessageQueueInfo

Esta estructura representa información sobre una cola de mensajes.

struct otMessageSettings otMessageSettings

Esta estructura representa la configuración de un mensaje.

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

Agrega bytes a un mensaje.

Detalles
Parámetros	[in] aMessage Un puntero para un búfer de mensajes. [in] aBuf Un puntero para los datos que se adjuntarán. [in] aLength Cantidad de bytes que se agregarán.
Valores que se muestran	OT_ERROR_NONE Se agregó correctamente al mensaje OT_ERROR_NO_BUFS No hay búferes disponibles para hacer crecer el mensaje.

Consulta también:
otMessageFree
otMessageGetLength
otMessageSetLength
otMessageGetOffset
otMessageSetOffset
otMessageRead
otMessageWrite

void otMessageFree(
  otMessage *aMessage
)

Libera un búfer de mensajes asignado.

Detalles
Parámetros	[in] aMessage Un puntero para un búfer de mensajes.

Consulta también:
otMessageAttach
otMessageGetLength
otMessageSetLength
otMessageGetOffset
otMessageSetOffset
otMessageRead
otMessageWrite

void otMessageGetBufferInfo(
  otInstance *aInstance,
  otBufferInfo *aBufferInfo
)

Obtén la información del búfer de mensajes.

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

uint16_t otMessageGetLength(
  const otMessage *aMessage
)

Obtiene la longitud del mensaje en bytes.

Detalles
Parámetros	[in] aMessage Un puntero para un búfer de mensajes.
Qué muestra	La longitud del mensaje en bytes.

Consulta también:
otMessageFree
otMessageAttach
otMessageSetLength
otMessageGetOffset
otMessageSetOffset
otMessageRead
otMessageWrite1
8 8

uint16_t otMessageGetOffset(
  const otMessage *aMessage
)

Obtiene el desplazamiento de mensajes en bytes.

Detalles
Parámetros	[in] aMessage Un puntero para un búfer de mensajes.
Qué muestra	El valor de compensación del mensaje

Consulta también:
otMessageFree
otMessageAttach
otMessageGetLength
otMessageSetLength
otMessageSetOffset
otMessageRead
otMessageWrite

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.

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	[in] aMessage Un puntero para un búfer de mensajes.
Valores que se muestran	TRUE Si la seguridad del vínculo está habilitada. FALSE Si la seguridad del vínculo no está habilitada, haz lo siguiente:

void otMessageQueueDequeue(
  otMessageQueue *aQueue,
  otMessage *aMessage
)

Esta función quita un mensaje de la cola de mensajes determinada.

Detalles
Parámetros	[in] aQueue Un puntero para la cola de mensajes. [in] aMessage El mensaje que se quitará.

void otMessageQueueEnqueue(
  otMessageQueue *aQueue,
  otMessage *aMessage
)

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

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

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	[in] aQueue Un puntero para la cola de mensajes. [in] aMessage El mensaje que se agregará.

otMessage * otMessageQueueGetHead(
  otMessageQueue *aQueue
)

Esta función muestra un puntero al mensaje que se encuentra en el encabezado de la cola.

Detalles
Parámetros	[in] aQueue Un puntero para una cola de mensajes.
Qué muestra	Un puntero al mensaje en el encabezado de la cola o NULL si la cola está vacía.

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	[in] aQueue Un puntero para una cola de mensajes. [in] aMessage Un puntero para el búfer de mensajes actual.
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 ifaMessageis not in the queueaQueue`.

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	[in] aQueue Un puntero para una cola de mensajes.

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 para un búfer de mensajes. [in] aOffset Desplazamiento en bytes. [in] aBuf Un puntero para un búfer en el que se leen los bytes de mensaje. [in] aLength Cantidad de bytes que se leerán.
Qué muestra	La cantidad de bytes leídos.

Consulta también:
otMessageFree
otMessageAttach
otMessageGetLength
otMessageSetLength
otMessageGetOffset
otMessageSetOffset
otMessageWrite

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	[in] aMessage Un puntero para un búfer de mensajes. [in] aEnabled Si es true, el mensaje se verá obligado a usar la transmisión directa. Si es false, el mensaje sigue el procedimiento normal.

otError otMessageSetLength(
  otMessage *aMessage,
  uint16_t aLength
)

Configura la longitud del mensaje en bytes.

Detalles
Parámetros	[in] aMessage Un puntero para un búfer de mensajes. [in] aLength Longitud en bytes.
Valores que se muestran	OT_ERROR_NONE Se configuró correctamente la longitud del mensaje. OT_ERROR_NO_BUFS No hay búferes disponibles para hacer crecer el mensaje.

Consulta también:
otMessageFree
otMessageAttach
otMessageGetLength
otMessageGetOffset
otMessageSetOffset
otMessageRead
otMessageWrite

void otMessageSetOffset(
  otMessage *aMessage,
  uint16_t aOffset
)

Configura el desplazamiento del mensaje en bytes.

Detalles
Parámetros	[in] aMessage Un puntero para un búfer de mensajes. [in] aOffset Desplazamiento en bytes.

Consulta también:
otMessageFree
otMessageAttach
otMessageGetLength
otMessageSetLength
otMessageGetOffset
otMessageRead
otMessageWrite

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

Escribir bytes en un mensaje

Detalles
Parámetros	[in] aMessage Un puntero para un búfer de mensajes. [in] aOffset Desplazamiento en bytes. [in] aBuf Un puntero para un búfer desde el que se escriben los bytes de un mensaje. [in] aLength Cantidad de bytes para escribir.
Qué muestra	Es la cantidad de bytes escritos.

Consulta también:
otMessageFree
otMessageAttach
otMessageGetLength
otMessageSetLength
otMessageGetOffset
otMessageSetOffset
otMessageRead