Mensaje

Este módulo incluye funciones que manipulan los búferes de mensajes de OpenThread.

Resumen

Enumeraciones
otMessageOrigin{
  OT_MESSAGE_ORIGIN_THREAD_NETIF = 0,
  OT_MESSAGE_ORIGIN_HOST_TRUSTED = 1,
  OT_MESSAGE_ORIGIN_HOST_UNTRUSTED = 2
} 		enum
Define los orígenes de los mensajes de OpenThread.
otMessagePriority{
  OT_MESSAGE_PRIORITY_LOW = 0,
  OT_MESSAGE_PRIORITY_NORMAL = 1,
  OT_MESSAGE_PRIORITY_HIGH = 2
} 		enum
Define los niveles de prioridad de los mensajes de OpenThread.

Typedefs
otBufferInfo typedef
struct otBufferInfo
Representa la información del búfer de mensajes para las diferentes colas que usa la pila de OpenThread.
otMessage typedef
struct otMessage
Representación opaca de un búfer de mensajes de OpenThread.
otMessageOrigin typedef
Define los orígenes de los mensajes de OpenThread.
otMessagePriority typedef
Define los niveles de prioridad de los mensajes de OpenThread.
otMessageQueueInfo typedef
Representa información sobre una cola de mensajes.
otMessageSettings typedef
Representa la configuración de un mensaje.

remotas
otMessageAppend(otMessage *aMessage, const void *aBuf, uint16_t aLength)
Agrega bytes a los mensajes.
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
Obtén la longitud del mensaje en bytes.
otMessageGetOffset(const otMessage *aMessage)
uint16_t
Obtiene el desplazamiento del mensaje en bytes.
otMessageGetOrigin(const otMessage *aMessage)
Obtiene el origen del mensaje.
otMessageGetRss(const otMessage *aMessage)
int8_t
Muestra el RSS (intensidad de la señal recibida) promedio asociado con el mensaje.
otMessageIsLinkSecurityEnabled(const otMessage *aMessage)
bool
Indica si la seguridad de los vínculos está habilitada o no para el mensaje.
otMessageIsLoopbackToHostAllowed(const otMessage *aMessage)
bool
Indica si se puede repetir o no el mensaje en el host.
otMessageIsMulticastLoopEnabled(otMessage *aMessage)
bool
Indica si el mensaje dado puede repetirse en el caso de una dirección de destino de multidifusión.
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 frente o al frente de la cola de mensajes proporcionada.
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 de la cola iterando hacia delante (desde la cabeza hasta 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
Lee los bytes de un mensaje.
otMessageResetBufferInfo(otInstance *aInstance)
void
Restablece el contador de información del búfer de mensajes que realiza un seguimiento de la cantidad máxima de búferes en uso al mismo tiempo.
otMessageSetDirectTransmission(otMessage *aMessage, bool aEnabled)
void
Establece o fuerza el reenvío del mensaje mediante transmisión directa.
otMessageSetLength(otMessage *aMessage, uint16_t aLength)
Establece la longitud del mensaje en bytes.
otMessageSetLoopbackToHostAllowed(otMessage *aMessage, bool aAllowLoopbackToHost)
void
Establece si se permite o no que el mensaje se vuelva a repetir en el host.
otMessageSetMulticastLoopEnabled(otMessage *aMessage, bool aEnabled)
void
Controla si el mensaje determinado se puede repetir en bucle en el caso de una dirección de destino de multidifusión.
otMessageSetOffset(otMessage *aMessage, uint16_t aOffset)
void
Configura el desplazamiento del mensaje en bytes.
otMessageSetOrigin(otMessage *aMessage, otMessageOrigin aOrigin)
void
Establece el origen del mensaje.
otMessageWrite(otMessage *aMessage, uint16_t aOffset, const void *aBuf, uint16_t aLength)
int
Escribe 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

otMessageOrigin

 otMessageOrigin

Define los orígenes de los mensajes de OpenThread.

Propiedades
OT_MESSAGE_ORIGIN_HOST_TRUSTED

Mensaje de una fuente de confianza del host

OT_MESSAGE_ORIGIN_HOST_UNTRUSTED

Mensaje de una fuente no confiable en el host.

OT_MESSAGE_ORIGIN_THREAD_NETIF

Mensaje de Thread Netif.

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

otBufferInfo

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

Representación opaca de un búfer de mensajes de OpenThread.

otMessageOrigin

enum otMessageOrigin otMessageOrigin

Define los orígenes de los 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.

remotas

otMessageAppend

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

Agrega bytes a los mensajes.

Detalles
Parámetros
[in] aMessage
Un puntero para un búfer de mensaje.
[in] aBuf
Un puntero a los datos que se adjuntarán.
[in] aLength
Cantidad de bytes para adjuntar.
Valores que se muestran
OT_ERROR_NONE
Se agregó correctamente al mensaje
OT_ERROR_NO_BUFS
No hay búferes disponibles para ampliar el mensaje.
Consulta también:
otMessageFree
otMessageGetLength
otMessageSetLength
otMessageGetOffset
otMessageSetOffset
otMessageRead
otMessageWrite

otMessageFree

void otMessageFree(
  otMessage *aMessage
)

Libera un búfer de mensajes asignado.

Detalles
Parámetros
[in] aMessage
Un puntero para un búfer de mensaje.
Consulta también:
otMessageAppend
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
[in] aInstance
Un puntero para 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
)

Obtén la longitud del mensaje en bytes.

Detalles
Parámetros
[in] aMessage
Un puntero para un búfer de mensaje.
Qué muestra
Es la longitud del mensaje en bytes.
Consulta también:
otMessageFree
otMessageAppend
otMessageSetLength
otMessageGetOffset
otMessageSetOffset
otMessageRead
otMessageWrite
otMessageLength
otMessageSetLength

otMessageGetOffset

uint16_t otMessageGetOffset(
  const otMessage *aMessage
)

Obtiene el desplazamiento del mensaje en bytes.

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

otMessageGetOrigin

otMessageOrigin otMessageGetOrigin(
  const otMessage *aMessage
)

Obtiene el origen del mensaje.

Detalles
Parámetros
[in] aMessage
Un puntero para un búfer de mensaje.
Qué muestra
El origen del mensaje.

otMessageGetRss

int8_t otMessageGetRss(
  const otMessage *aMessage
)

Muestra el RSS (intensidad de la señal recibida) promedio asociado con el mensaje.

Detalles
Qué muestra
El valor RSS promedio (en dBm) u OT_RADIO_RSSI_INVALID si no hay un RSS promedio disponible.

otMessageIsLinkSecurityEnabled

bool otMessageIsLinkSecurityEnabled(
  const otMessage *aMessage
)

Indica si la seguridad de los vínculos está habilitada o no para el mensaje.

Detalles
Parámetros
[in] aMessage
Un puntero para un búfer de mensaje.
Valores que se muestran
TRUE
Si la seguridad de los vínculos está habilitada.
FALSE
Si la seguridad de los vínculos no está habilitada.

otMessageIsLoopbackToHostAllowed

bool otMessageIsLoopbackToHostAllowed(
  const otMessage *aMessage
)

Indica si se puede repetir o no el mensaje en el host.

Detalles
Parámetros
[in] aMessage
Un puntero para un búfer de mensaje.
Valores que se muestran
TRUE
Si el mensaje se puede repetir en bucle al host.
FALSE
Si no se permite que el mensaje se vuelva a repetir en el host.

otMessageIsMulticastLoopEnabled

bool otMessageIsMulticastLoopEnabled(
  otMessage *aMessage
)

Indica si el mensaje dado puede repetirse en el caso de una dirección de destino de multidifusión.

Si se usa aMessage junto con otMessageInfo, el campo mMulticastLoop de la estructura otMessageInfo tiene prioridad y se usará en lugar del valor establecido en aMessage.

Esta API está diseñada principalmente para usarse junto con otIp6Send(), que espera un mensaje IPv6 ya preparado.

Detalles
Parámetros
[in] aMessage
Un puntero para el mensaje.

otMessageQueueDequeue

void otMessageQueueDequeue(
  otMessageQueue *aQueue,
  otMessage *aMessage
)

Quita un mensaje de la cola de mensajes determinada.

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

otMessageQueueEnqueue

void otMessageQueueEnqueue(
  otMessageQueue *aQueue,
  otMessage *aMessage
)

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á.

otMessageQueueEnqueueAtHead

void otMessageQueueEnqueueAtHead(
  otMessageQueue *aQueue,
  otMessage *aMessage
)

Agrega un mensaje al frente o al frente de la cola de mensajes proporcionada.

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

otMessageQueueGetHead

otMessage * otMessageQueueGetHead(
  otMessageQueue *aQueue
)

Muestra un puntero al mensaje 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.

otMessageQueueGetNext

otMessage * otMessageQueueGetNext(
  otMessageQueue *aQueue,
  const otMessage *aMessage
)

Muestra un puntero al siguiente mensaje de la cola iterando hacia delante (desde la cabeza hasta 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`.

otMessageQueueInit

void otMessageQueueInit(
  otMessageQueue *aQueue
)

Inicializa la cola de mensajes.

SE DEBE llamar una y solo una vez para una instancia de otMessageQueue antes que a cualquier otra función otMessageQueue. El comportamiento no está definido si otras APIs de cola se usan con un 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.

otMessageRead

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

Lee los bytes de un mensaje.

Detalles
Parámetros
[in] aMessage
Un puntero para un búfer de mensaje.
[in] aOffset
Es un desplazamiento en bytes.
[in] aBuf
Un puntero para un búfer en el que se leen los bytes del mensaje.
[in] aLength
Cantidad de bytes que se leerán.
Qué muestra
La cantidad de bytes leídos.
Consulta también:
otMessageFree
otMessageAppend
otMessageGetLength
otMessageSetLength
otMessageGetOffset
otMessageSetOffset
otMessageWrite

otMessageResetBufferInfo

void otMessageResetBufferInfo(
  otInstance *aInstance
)

Restablece el contador de información del búfer de mensajes que realiza un seguimiento de la cantidad máxima de búferes en uso al mismo tiempo.

Esta acción restablecerá mMaxUsedBuffers en otBufferInfo.

Detalles
Parámetros
[in] aInstance
Un puntero para la instancia de OpenThread.

otMessageSetDirectTransmission

void otMessageSetDirectTransmission(
  otMessage *aMessage,
  bool aEnabled
)

Establece o fuerza el reenvío del mensaje mediante 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 mensaje.
[in] aEnabled
Si es true, el mensaje se verá forzado a usar la transmisión directa. Si es false, el mensaje sigue el procedimiento normal.

otMessageSetLength

otError otMessageSetLength(
  otMessage *aMessage,
  uint16_t aLength
)

Establece la longitud del mensaje en bytes.

Detalles
Parámetros
[in] aMessage
Un puntero para un búfer de mensaje.
[in] aLength
Es una 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 ampliar el mensaje.
Consulta también:
otMessageFree
otMessageAppend
otMessageGetLength
otMessageGetOffset
otMessageSetOffset
otMessageRead
otMessageWrite

otMessageSetLoopbackToHostAllowed

void otMessageSetLoopbackToHostAllowed(
  otMessage *aMessage,
  bool aAllowLoopbackToHost
)

Establece si se permite o no que el mensaje se vuelva a repetir en el host.

Detalles
Parámetros
[in] aMessage
Un puntero para un búfer de mensaje.
[in] aAllowLoopbackToHost
Indica si se debe permitir que el mensaje se repita en el host.

otMessageSetMulticastLoopEnabled

void otMessageSetMulticastLoopEnabled(
  otMessage *aMessage,
  bool aEnabled
)

Controla si el mensaje determinado se puede repetir en bucle en el caso de una dirección de destino de multidifusión.

Detalles
Parámetros
[in] aMessage
Un puntero para el mensaje.
[in] aEnabled
El valor de configuración.

otMessageSetOffset

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 mensaje.
[in] aOffset
Es un desplazamiento en bytes.
Consulta también:
otMessageFree
otMessageAppend
otMessageGetLength
otMessageSetLength
otMessageGetOffset
otMessageRead
otMessageWrite

otMessageSetOrigin

void otMessageSetOrigin(
  otMessage *aMessage,
  otMessageOrigin aOrigin
)

Establece el origen del mensaje.

Detalles
Parámetros
[in] aMessage
Un puntero para un búfer de mensaje.
[in] aOrigin
El origen del mensaje.

otMessageWrite

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

Escribe bytes en un mensaje.

Detalles
Parámetros
[in] aMessage
Un puntero para un búfer de mensaje.
[in] aOffset
Es un desplazamiento en bytes.
[in] aBuf
Un puntero para un búfer desde el que se escriben los bytes del mensaje.
[in] aLength
Cantidad de bytes que se escribirán.
Qué muestra
Es la cantidad de bytes escritos.
Consulta también:
otMessageFree
otMessageAppend
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 contribuir a nuestra documentación, consulta Recursos.