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

A mensagem

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

Resumo

Enumerações
otMessagePriority{
  OT_MESSAGE_PRIORITY_LOW = 0,
  OT_MESSAGE_PRIORITY_NORMAL = 1,
  OT_MESSAGE_PRIORITY_HIGH = 2
} 		tipo enumerado
Esta enumeração define os níveis de prioridade de mensagens do OpenThread.

Typedefs
otBufferInfo typedef
struct otBufferInfo
Essa estrutura representa as informações do buffer de mensagem para diferentes filas usadas pela pilha do OpenThread.
otMessage typedef
struct otMessage
Esse tipo é uma representação opaca de um buffer de mensagem do OpenThread.
otMessagePriority typedef
Esta enumeração define os níveis de prioridade de mensagens do OpenThread.
otMessageQueueInfo typedef
Essa estrutura representa informações sobre uma fila de mensagens.
otMessageSettings typedef
Essa estrutura representa uma configuração de mensagem.

Funções
otMessageAppend(otMessage *aMessage, const void *aBuf, uint16_t aLength)
Anexe bytes a uma mensagem.
otMessageFree(otMessage *aMessage)
void
Libera um buffer de mensagem alocado.
otMessageGetBufferInfo(otInstance *aInstance, otBufferInfo *aBufferInfo)
void
Acessa as informações do buffer de mensagem.
otMessageGetLength(const otMessage *aMessage)
uint16_t
Veja o tamanho da mensagem em bytes.
otMessageGetOffset(const otMessage *aMessage)
uint16_t
Encontre o deslocamento de mensagem em bytes.
otMessageGetRss(const otMessage *aMessage)
int8_t
Essa função retorna o RSS médio (força do sinal recebida) médio associado à mensagem.
otMessageIsLinkSecurityEnabled(const otMessage *aMessage)
bool
Essa função indica se a segurança da vinculação está ativada ou não na mensagem.
otMessageQueueDequeue(otMessageQueue *aQueue, otMessage *aMessage)
void
Essa função remove uma mensagem da fila de mensagens especificada.
otMessageQueueEnqueue(otMessageQueue *aQueue, otMessage *aMessage)
void
Essa função adiciona uma mensagem ao final da fila de mensagens especificada.
otMessageQueueEnqueueAtHead(otMessageQueue *aQueue, otMessage *aMessage)
void
Essa função adiciona uma mensagem no cabeçalho/frente da fila de mensagens especificada.
otMessageQueueGetHead(otMessageQueue *aQueue)
Essa função retorna um ponteiro para a mensagem no cabeçalho da fila.
otMessageQueueGetNext(otMessageQueue *aQueue, const otMessage *aMessage)
Essa função retorna um ponteiro para a próxima mensagem na fila iterando para frente (da cabeça à cauda).
otMessageQueueInit(otMessageQueue *aQueue)
void
Inicialize a fila de mensagens.
otMessageRead(const otMessage *aMessage, uint16_t aOffset, void *aBuf, uint16_t aLength)
uint16_t
Ler bytes de uma mensagem.
otMessageResetBufferInfo(otInstance *aInstance)
void
Redefinir o contador de informações do buffer de mensagem rastreando o número máximo de buffers em uso ao mesmo tempo.
otMessageSetDirectTransmission(otMessage *aMessage, bool aEnabled)
void
Essa função define/força o encaminhamento da mensagem usando a transmissão direta.
otMessageSetLength(otMessage *aMessage, uint16_t aLength)
Defina o tamanho da mensagem em bytes.
otMessageSetOffset(otMessage *aMessage, uint16_t aOffset)
void
Define o deslocamento de mensagem em bytes.
otMessageWrite(otMessage *aMessage, uint16_t aOffset, const void *aBuf, uint16_t aLength)
int
Grave bytes em uma mensagem.

Estruturas
OtBufferInfo (em inglês)

Essa estrutura representa as informações do buffer de mensagem para diferentes filas usadas pela pilha do OpenThread.

otMessageQueue.

Essa estrutura representa uma fila de mensagens do OpenThread.

OtMessageQueueInfo.

Essa estrutura representa informações sobre uma fila de mensagens.

OtMessageSettings.

Essa estrutura representa uma configuração de mensagem.

Enumerações

Prioridade da mensagem

 otMessagePriority

Esta enumeração define os níveis de prioridade de mensagens do OpenThread.

Propriedades
OT_MESSAGE_PRIORITY_HIGH

Nível de prioridade alto.

OT_MESSAGE_PRIORITY_LOW

Nível de prioridade baixo.

OT_MESSAGE_PRIORITY_NORMAL

Nível de prioridade normal.

Typedefs

otBufferInfo

struct otBufferInfo otBufferInfo

Essa estrutura representa as informações do buffer de mensagem para diferentes filas usadas pela pilha do OpenThread.

Mensagem ot

struct otMessage otMessage

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

Prioridade da mensagem

enum otMessagePriority otMessagePriority

Esta enumeração define os níveis de prioridade de mensagens do OpenThread.

OtMessageQueueInfo

struct otMessageQueueInfo otMessageQueueInfo

Essa estrutura representa informações sobre uma fila de mensagens.

Configurações de mensagens de texto

struct otMessageSettings otMessageSettings

Essa estrutura representa uma configuração de mensagem.

Funções

OtMessageAttach

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

Anexe bytes a uma mensagem.

Detalhes
Parâmetros
[in] aMessage
Um ponteiro para um buffer de mensagem.
[in] aBuf
Um ponteiro para os dados que serão anexados.
[in] aLength
Número de bytes a serem anexados.
Retornar valores
OT_ERROR_NONE
A mensagem foi anexada
OT_ERROR_NO_BUFS
Nenhum buffer disponível para aumentar a mensagem.
Veja também:
otMessageFree
otMessageGetLength
otMessageSetLength
otMessageGetOffset
otMessageSetOffset
otMessageRead
otMessageWrite

Mensagens livres

void otMessageFree(
  otMessage *aMessage
)

Libera um buffer de mensagem alocado.

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

OtMessageGetBufferInfo

void otMessageGetBufferInfo(
  otInstance *aInstance,
  otBufferInfo *aBufferInfo
)

Acessa as informações do buffer de mensagem.

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

OtMessageGetLength

uint16_t otMessageGetLength(
  const otMessage *aMessage
)

Veja o tamanho da mensagem em bytes.

Detalhes
Parâmetros
[in] aMessage
Um ponteiro para um buffer de mensagem.
Retorna
O tamanho da mensagem em bytes.
Veja também:
otMessageFree
otMessageAttach
otMessageSetLength
otMessageGetOffset
otMessageSetOffset
otMessageRead
otMessageWrite

OtMessageGetOffset.

uint16_t otMessageGetOffset(
  const otMessage *aMessage
)

Encontre o deslocamento de mensagem em bytes.

Detalhes
Parâmetros
[in] aMessage
Um ponteiro para um buffer de mensagem.
Retorna
O valor de deslocamento da mensagem.
Veja também:
otMessageFree
otMessageAttach
otMessageGetLength
otMessageSetLength
otMessageSetOffset
otMessageRead
otMessageWrite

OtMessageGetRss

int8_t otMessageGetRss(
  const otMessage *aMessage
)

Essa função retorna o RSS médio (força do sinal recebida) médio associado à mensagem.

Detalhes
Retorna
O valor médio de RSS (em dBm) ou OT_RADIO_RSSI_INVALID, caso nenhum RSS médio esteja disponível.

OtMessageIsLinkSecurityEnabled

bool otMessageIsLinkSecurityEnabled(
  const otMessage *aMessage
)

Essa função indica se a segurança da vinculação está ativada ou não na mensagem.

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

OtMessageQueueDequeue

void otMessageQueueDequeue(
  otMessageQueue *aQueue,
  otMessage *aMessage
)

Essa função remove uma mensagem da fila de mensagens especificada.

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
)

Essa função adiciona uma mensagem ao final da fila de mensagens especificada.

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
)

Essa função adiciona uma mensagem no cabeçalho/frente da fila de mensagens especificada.

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

OtMessageQueueGetHead

otMessage * otMessageQueueGetHead(
  otMessageQueue *aQueue
)

Essa função retorna um ponteiro para a mensagem no cabeçalho da fila.

Detalhes
Parâmetros
[in] aQueue
Um ponteiro para uma fila de mensagens.
Retorna
Um ponteiro para a mensagem no cabeçalho da fila ou NULL se a fila estiver vazia.

OtMessageQueueGetNext

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

Essa função retorna um ponteiro para a próxima mensagem na fila iterando para frente (da cabeça à cauda).

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

OtMessageQueueInit

void otMessageQueueInit(
  otMessageQueue *aQueue
)

Inicialize a fila de mensagens.

Essa função PRECISA ser chamada uma vez e somente uma vez para uma instância otMessageQueue antes de qualquer outra função otMessageQueue. O comportamento é indefinido se outras APIs de fila forem usadas com um otMessageQueue antes da inicialização ou se ela for inicializada mais de uma vez.

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

Leitura de mensagens

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

Ler 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 em que os bytes da mensagem são lidos.
[in] aLength
Número de bytes a serem lidos.
Retorna
O número de bytes lidos.
Veja também:
otMessageFree
otMessageAttach
otMessageGetLength
otMessageSetLength
otMessageGetOffset
otMessageSetOffset
otMessageWrite

OtMessageResetBufferInfo

void otMessageResetBufferInfo(
  otInstance *aInstance
)

Redefinir o contador de informações do buffer de mensagem rastreando o número máximo de buffers em uso ao mesmo tempo.

Isso redefinirá mMaxUsedBuffers em otBufferInfo.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para a instância do OpenThread.

OtMessageSetDirectTransmission

void otMessageSetDirectTransmission(
  otMessage *aMessage,
  bool aEnabled
)

Essa função define/força o encaminhamento da mensagem usando a 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 for true, a mensagem será forçada a usar a transmissão direta. Se for false, a mensagem seguirá o procedimento normal.

OtMessageSetLength

otError otMessageSetLength(
  otMessage *aMessage,
  uint16_t aLength
)

Defina o tamanho da mensagem em bytes.

Detalhes
Parâmetros
[in] aMessage
Um ponteiro para um buffer de mensagem.
[in] aLength
Um tamanho em bytes.
Retornar valores
OT_ERROR_NONE
O tamanho da mensagem foi definido.
OT_ERROR_NO_BUFS
Nenhum buffer disponível para aumentar a mensagem.
Veja também:
otMessageFree
otMessageAttach
otMessageGetLength
otMessageGetOffset
otMessageSetOffset
otMessageRead
otMessageWrite

OtMessageSetOffset

void otMessageSetOffset(
  otMessage *aMessage,
  uint16_t aOffset
)

Define o deslocamento de 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
otMessageAttach
otMessageGetLength
otMessageSetLength
otMessageGetOffset
otMessageRead
otMessageWrite

Gravação de mensagens ot

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

Grave 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 do qual os bytes da mensagem são gravados.
[in] aLength
Número de bytes a serem gravados.
Retorna
O número de bytes gravados.
Veja também:
otMessageFree
otMessageAttach
otMessageGetLength
otMessageSetLength
otMessageGetOffset
otMessageSetOffset
otMessageRead

Recursos

Os tópicos de referência da API OpenThread são provenientes do código-fonte, disponível no GitHub. Para mais informações ou para contribuir com nossa documentação, consulte Recursos.