O Google tem o compromisso de promover a igualdade racial para as comunidades negras. Saiba como.

Mensagem

Este módulo inclui funções que manipulam buffers de mensagens OpenThread.

Resumo

Enumerações

otMessagePriority {
OT_MESSAGE_PRIORITY_LOW = 0,
OT_MESSAGE_PRIORITY_NORMAL = 1,
OT_MESSAGE_PRIORITY_HIGH = 2
}		 enum
Essa enumeração define os níveis de prioridade da mensagem OpenThread.

Typedefs

otBufferInfo typedef
struct otBufferInfo
Essa estrutura representa as informações do buffer de mensagem.
otMessage typedef
struct otMessage
Este tipo é uma representação opaca de um buffer de mensagem OpenThread.
otMessagePriority typedef
Essa enumeração define os níveis de prioridade da mensagem OpenThread.
otMessageSettings typedef
Esta estrutura representa as configurações de uma mensagem.

Funções

otMessageAppend ( otMessage *aMessage, const void *aBuf, uint16_t aLength)
Acrescente bytes a uma mensagem.
otMessageFree ( otMessage *aMessage)
void
Libere um buffer de mensagem alocado.
otMessageGetBufferInfo ( otInstance *aInstance, otBufferInfo *aBufferInfo)
void
Obtenha as informações do Message Buffer.
otMessageGetLength (const otMessage *aMessage)
uint16_t
Obtenha o comprimento da mensagem em bytes.
otMessageGetOffset (const otMessage *aMessage)
uint16_t
Obtenha o deslocamento da mensagem em bytes.
otMessageGetRss (const otMessage *aMessage)
int8_t
Esta função retorna o RSS médio (intensidade do sinal recebido) associado à mensagem.
otMessageIsLinkSecurityEnabled (const otMessage *aMessage)
bool
Esta função indica se a segurança do link está ou não habilitada para a mensagem.
otMessageQueueDequeue ( otMessageQueue *aQueue, otMessage *aMessage)
void
Esta função remove uma mensagem da fila de mensagens fornecida.
otMessageQueueEnqueue ( otMessageQueue *aQueue, otMessage *aMessage)
void
Esta função adiciona uma mensagem ao final da fila de mensagens fornecida.
otMessageQueueEnqueueAtHead ( otMessageQueue *aQueue, otMessage *aMessage)
void
Esta função adiciona uma mensagem no início / frente da fila de mensagens fornecida.
otMessageQueueGetHead ( otMessageQueue *aQueue)
Esta função retorna um ponteiro para a mensagem no início da fila.
otMessageQueueGetNext ( otMessageQueue *aQueue, const otMessage *aMessage)
Esta função retorna um ponteiro para a próxima mensagem na fila, iterando para frente (do início ao fim).
otMessageQueueInit ( otMessageQueue *aQueue)
void
Inicialize a fila de mensagens.
otMessageRead (const otMessage *aMessage, uint16_t aOffset, void *aBuf, uint16_t aLength)
uint16_t
Leia bytes de uma mensagem.
otMessageSetDirectTransmission ( otMessage *aMessage, bool aEnabled)
void
Esta função configura / força o encaminhamento da mensagem por meio de transmissão direta.
otMessageSetLength ( otMessage *aMessage, uint16_t aLength)
Defina o comprimento da mensagem em bytes.
otMessageSetOffset ( otMessage *aMessage, uint16_t aOffset)
void
Defina o deslocamento da mensagem em bytes.
otMessageWrite ( otMessage *aMessage, uint16_t aOffset, const void *aBuf, uint16_t aLength)
int
Escreva bytes em uma mensagem.

Structs

otBufferInfo

Essa estrutura representa as informações do buffer de mensagem.

otMessageQueue

Esta estrutura representa uma fila de mensagens OpenThread.

otMessageSettings

Esta estrutura representa as configurações de uma mensagem.

Enumerações

otMessagePriority

 otMessagePriority

Essa enumeração define os níveis de prioridade da mensagem OpenThread.

Propriedades
OT_MESSAGE_PRIORITY_HIGH

Nível de alta prioridade.

OT_MESSAGE_PRIORITY_LOW

Nível de baixa prioridade.

OT_MESSAGE_PRIORITY_NORMAL

Nível de prioridade normal.

Typedefs

otBufferInfo

struct otBufferInfo otBufferInfo

Essa estrutura representa as informações do buffer de mensagem.

otMessage

struct otMessage otMessage

Este tipo é uma representação opaca de um buffer de mensagem OpenThread.

otMessagePriority

enum otMessagePriority otMessagePriority

Essa enumeração define os níveis de prioridade da mensagem OpenThread.

otMessageSettings

struct otMessageSettings otMessageSettings

Esta estrutura representa as configurações de uma mensagem.

Funções

otMessageAppend

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

Acrescente bytes a uma mensagem.

Detalhes
Parâmetros
[in] aMessage
Um ponteiro para um buffer de mensagem.
[in] aBuf
Um ponteiro para os dados a serem acrescentados.
[in] aLength
Número de bytes a acrescentar.
Valores Retornados
OT_ERROR_NONE
Anexado com sucesso à mensagem
OT_ERROR_NO_BUFS
Nenhum buffer disponível para aumentar a mensagem.
Veja também:
otMessageFree
otMessageGetLength
otMessageSetLength
otMessageGetOffset
otMessageSetOffset
otMessageRead
otMessageWrite

otMessageFree

void otMessageFree(
  otMessage *aMessage
)

Libere um buffer de mensagem alocado.

Detalhes
Parâmetros
[in] aMessage
Um ponteiro para um buffer de mensagem.
Veja também:
otMessageAppend
otMessageGetLength
otMessageSetLength
otMessageGetOffset
otMessageSetOffset
otMessageRead
otMessageWrite

otMessageGetBufferInfo

void otMessageGetBufferInfo(
  otInstance *aInstance,
  otBufferInfo *aBufferInfo
)

Obtenha as informações do Message Buffer.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para a instância OpenThread.
[out] aBufferInfo
Um ponteiro onde as informações do buffer de mensagem são gravadas.

otMessageGetLength

uint16_t otMessageGetLength(
  const otMessage *aMessage
)

Obtenha o comprimento da mensagem em bytes.

Detalhes
Parâmetros
[in] aMessage
Um ponteiro para um buffer de mensagem.
Devoluções
O comprimento da mensagem em bytes.
Veja também:
otMessageFree
otMessageAppend
otMessageSetLength
otMessageGetOffset
otMessageSetOffset
otMessageRead
otMessageWrite
otMessageSetLength

otMessageGetOffset

uint16_t otMessageGetOffset(
  const otMessage *aMessage
)

Obtenha o deslocamento da mensagem em bytes.

Detalhes
Parâmetros
[in] aMessage
Um ponteiro para um buffer de mensagem.
Devoluções
O valor do deslocamento da mensagem.
Veja também:
otMessageFree
otMessageAppend
otMessageGetLength
otMessageSetLength
otMessageSetOffset
otMessageRead
otMessageWrite

otMessageGetRss

int8_t otMessageGetRss(
  const otMessage *aMessage
)

Esta função retorna o RSS médio (intensidade do sinal recebido) associado à mensagem.

Detalhes
Devoluções
O valor RSS médio (em dBm) ou OT_RADIO_RSSI_INVALID se nenhum RSS médio estiver disponível.

otMessageIsLinkSecurityEnabled

bool otMessageIsLinkSecurityEnabled(
  const otMessage *aMessage
)

Esta função indica se a segurança do link está ou não ativada para a mensagem.

Detalhes
Parâmetros
[in] aMessage
Um ponteiro para um buffer de mensagem.
Valores Retornados
TRUE
Se a segurança do link estiver habilitada.
FALSE
Se a segurança do link não estiver habilitada.

otMessageQueueDequeue

void otMessageQueueDequeue(
  otMessageQueue *aQueue,
  otMessage *aMessage
)

Esta função remove uma mensagem da fila de mensagens fornecida.

Detalhes
Parâmetros
[in] aQueue
Um ponteiro para a fila de mensagens.
[in] aMessage
A mensagem a ser removida.

otMessageQueueEnqueue

void otMessageQueueEnqueue(
  otMessageQueue *aQueue,
  otMessage *aMessage
)

Esta função adiciona uma mensagem ao final da fila de mensagens fornecida.

Detalhes
Parâmetros
[in] aQueue
Um ponteiro para a fila de mensagens.
[in] aMessage
A mensagem a ser adicionada.

otMessageQueueEnqueueAtHead

void otMessageQueueEnqueueAtHead(
  otMessageQueue *aQueue,
  otMessage *aMessage
)

Esta função adiciona uma mensagem no início / frente da fila de mensagens fornecida.

Detalhes
Parâmetros
[in] aQueue
Um ponteiro para a fila de mensagens.
[in] aMessage
A mensagem a ser adicionada.

otMessageQueueGetHead

otMessage * otMessageQueueGetHead(
  otMessageQueue *aQueue
)

Esta função retorna um ponteiro para a mensagem no início da fila.

Detalhes
Parâmetros
[in] aQueue
Um ponteiro para uma fila de mensagens.
Devoluções
Um ponteiro para a mensagem no início da fila ou NULL se a fila estiver vazia.

otMessageQueueGetNext

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

Esta função retorna um ponteiro para a próxima mensagem na fila, iterando para frente (do início ao fim).

Detalhes
Parâmetros
[in] aQueue
Um ponteiro para uma fila de mensagens.
[in] aMessage
Um ponteiro para o buffer de mensagem atual.
Devoluções
Um ponteiro para a próxima mensagem na fila após aMessage ou NULL se aMessage is the tail of queue. NULL is returned if aMessage is not in the queue aQueue`.

otMessageQueueInit

void otMessageQueueInit(
  otMessageQueue *aQueue
)

Inicialize a fila de mensagens.

Esta função DEVE ser chamada uma vez e apenas uma vez para uma instância de otMessageQueue antes de qualquer outra função de otMessageQueue . O comportamento é indefinido se outras APIs de fila forem usadas com um otMessageQueue antes de ser inicializado ou se for inicializado mais de uma vez.

Detalhes
Parâmetros
[in] aQueue
Um ponteiro para uma fila de mensagens.

otMessageRead

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

Leia bytes de uma mensagem.

Detalhes
Parâmetros
[in] aMessage
Um ponteiro para um buffer de mensagem.
[in] aOffset
Um deslocamento em bytes.
[in] aBuf
Um ponteiro para um buffer para o qual os bytes da mensagem são lidos.
[in] aLength
Número de bytes para ler.
Devoluções
O número de bytes lidos.
Veja também:
otMessageFree
otMessageAppend
otMessageGetLength
otMessageSetLength
otMessageGetOffset
otMessageSetOffset
otMessageWrite

otMessageSetDirectTransmission

void otMessageSetDirectTransmission(
  otMessage *aMessage,
  bool aEnabled
)

Esta função configura / força o encaminhamento da mensagem por meio de transmissão direta.

A configuração padrão para uma nova mensagem é false .

Detalhes
Parâmetros
[in] aMessage
Um ponteiro para um buffer de mensagem.
[in] aEnabled
Se true , a mensagem é forçada a usar transmissão direta. Se for false , a mensagem segue o procedimento normal.

otMessageSetLength

otError otMessageSetLength(
  otMessage *aMessage,
  uint16_t aLength
)

Defina o comprimento da mensagem em bytes.

Detalhes
Parâmetros
[in] aMessage
Um ponteiro para um buffer de mensagem.
[in] aLength
Um comprimento em bytes.
Valores Retornados
OT_ERROR_NONE
Defina o comprimento da mensagem com sucesso.
OT_ERROR_NO_BUFS
Nenhum buffer disponível para aumentar a mensagem.
Veja também:
otMessageFree
otMessageAppend
otMessageGetLength
otMessageGetOffset
otMessageSetOffset
otMessageRead
otMessageWrite

otMessageSetOffset

void otMessageSetOffset(
  otMessage *aMessage,
  uint16_t aOffset
)

Defina o deslocamento da mensagem em bytes.

Detalhes
Parâmetros
[in] aMessage
Um ponteiro para um buffer de mensagem.
[in] aOffset
Um deslocamento em bytes.
Veja também:
otMessageFree
otMessageAppend
otMessageGetLength
otMessageSetLength
otMessageGetOffset
otMessageRead
otMessageWrite

otMessageWrite

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

Escreva bytes em uma mensagem.

Detalhes
Parâmetros
[in] aMessage
Um ponteiro para um buffer de mensagem.
[in] aOffset
Um deslocamento em bytes.
[in] aBuf
Um ponteiro para um buffer a partir do qual os bytes da mensagem são gravados.
[in] aLength
Número de bytes a escrever.
Devoluções
O número de bytes gravados.
Veja também:
otMessageFree
otMessageAppend
otMessageGetLength
otMessageSetLength
otMessageGetOffset
otMessageSetOffset
otMessageRead