Esta página foi traduzida pela API Cloud Translation.

Message

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 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 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 `enum otMessagePriority` Essa enumeração define os níveis de prioridade da mensagem OpenThread.
`otMessageQueueInfo`	typedef `struct otMessageQueueInfo` Essa estrutura representa as informações sobre uma fila de mensagens.
`otMessageSettings`	typedef `struct otMessageSettings` Essa estrutura representa as configurações de mensagens.

Functions
`otMessageAppend(otMessage aMessage, const void aBuf, uint16_t aLength)`	`otError` Acrescentar bytes a uma mensagem.
`otMessageFree(otMessage *aMessage)`	`void` Libere um buffer de mensagem alocado.
`otMessageGetBufferInfo(otInstance aInstance, otBufferInfo aBufferInfo)`	`void` Receber as informações do buffer de mensagens.
`otMessageGetLength(const otMessage *aMessage)`	`uint16_t` Saber o tamanho da mensagem em bytes.
`otMessageGetOffset(const otMessage *aMessage)`	`uint16_t` Encontre o deslocamento da mensagem em bytes.
`otMessageGetRss(const otMessage *aMessage)`	`int8_t` Essa função retorna o RSS médio (intensidade do sinal recebido) associado à mensagem.
`otMessageIsLinkSecurityEnabled(const otMessage *aMessage)`	`bool` Essa função indica se a segurança do link está ativada ou não na mensagem.
`otMessageQueueDequeue(otMessageQueue aQueue, otMessage aMessage)`	`void` Essa função remove uma mensagem da fila.
`otMessageQueueEnqueue(otMessageQueue aQueue, otMessage aMessage)`	`void` Essa função adiciona uma mensagem ao final da fila.
`otMessageQueueEnqueueAtHead(otMessageQueue aQueue, otMessage aMessage)`	`void` Essa função adiciona uma mensagem ao cabeçalho/frente da fila.
`otMessageQueueGetHead(otMessageQueue *aQueue)`	`otMessage *` Essa função retorna um ponteiro para a mensagem no cabeçalho da fila.
`otMessageQueueGetNext(otMessageQueue aQueue, const otMessage aMessage)`	`otMessage *` Essa função retorna um ponteiro para a próxima mensagem na fila ao iterar para frente (da cabeça para a cauda).
`otMessageQueueInit(otMessageQueue *aQueue)`	`void` Inicializar a fila de mensagens.
`otMessageRead(const otMessage aMessage, uint16_t aOffset, void aBuf, uint16_t aLength)`	`uint16_t` Ler bytes de uma mensagem.
`otMessageSetDirectTransmission(otMessage *aMessage, bool aEnabled)`	`void` Essa função define/força a mensagem a ser encaminhada usando a transmissão direta.
`otMessageSetLength(otMessage *aMessage, uint16_t aLength)`	`otError` Define o tamanho da mensagem em bytes.
`otMessageSetOffset(otMessage *aMessage, uint16_t aOffset)`	`void` Define o deslocamento da 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 (link em inglês)	Essa estrutura representa uma fila de mensagens do OpenThread.
otMessageQueueInfo.	Essa estrutura representa as informações sobre uma fila de mensagens.
otMessageSettings (em inglês)	Essa estrutura representa as configurações de mensagens.

Enumerações

OtMessagePriority

 otMessagePriority

Essa enumeração define os níveis de prioridade da mensagem 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 de Ot

struct otMessage otMessage

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

OtMessagePriority

enum otMessagePriority otMessagePriority

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

OtMessageQueueInfo

struct otMessageQueueInfo otMessageQueueInfo

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

Configurações de mensagem

struct otMessageSettings otMessageSettings

Essa estrutura representa as configurações de mensagens.

Functions

OtMessageAppend

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

Acrescentar 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 anexados.
`[in] aLength`	Número de bytes a serem anexados.

Valores de retorno

`OT_ERROR_NONE`	Anexado à mensagem
`OT_ERROR_NO_BUFS`	Nenhum buffer disponível para desenvolver 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
)

Receber as informações do buffer de mensagens.

Detalhes

Parâmetros

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

OtMessageGetLength

uint16_t otMessageGetLength(
  const otMessage *aMessage
)

Saber 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
otMessageAppend
otMessageSetLength
otMessageGetOffset
otMessageSetOffset
otMessageRead
otMessageWrite
ot otMessageWrite

OtMessageGetOffset

uint16_t otMessageGetOffset(
  const otMessage *aMessage
)

Encontre o deslocamento da 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
otMessageAppend
otMessageGetLength
otMessageSetLength
otMessageSetOffset
otMessageRead
otMessageWrite

OtMessageGetRs

int8_t otMessageGetRss(
  const otMessage *aMessage
)

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

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

OtMessageIsLinkSecurityEnabled

bool otMessageIsLinkSecurityEnabled(
  const otMessage *aMessage
)

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

Detalhes

Parâmetros

[in] aMessage

Um ponteiro para um buffer de mensagem.

Valores de retorno

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

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.

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 ao cabeçalho/frente da fila.

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 ao iterar para frente (da cabeça para 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
)

Inicializar a fila de mensagens.

Essa função PRECISA ser chamada apenas 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 uma 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.

OtMessageRead

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
otMessageAppend
otMessageGetLength
otMessageSetLength
otMessageGetOffset
otMessageSetOffset
otMessageWrite

OtMessageSetDirectTransmission

void otMessageSetDirectTransmission(
  otMessage *aMessage,
  bool aEnabled
)

Essa função define/força a mensagem a ser encaminhada usando a transmissão direta.

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

Detalhes

Parâmetros

`[in] aMessage`	Um ponteiro para um buffer de mensagem.
`[in] aEnabled`	Se `true`, a mensagem será forçada a usar a transmissão direta. Se `false`, a mensagem seguirá o procedimento normal.

OtMessageSetLength

otError otMessageSetLength(
  otMessage *aMessage,
  uint16_t aLength
)

Define o tamanho da mensagem em bytes.

Detalhes

Parâmetros

`[in] aMessage`	Um ponteiro para um buffer de mensagem.
`[in] aLength`	Um tamanho em bytes.

Valores de retorno

`OT_ERROR_NONE`	O tamanho da mensagem foi definido.
`OT_ERROR_NO_BUFS`	Nenhum buffer disponível para desenvolver a mensagem.

Veja também:
otMessageFree
otMessageAppend
otMessageGetLength
otMessageGetOffset
otMessageSetOffset
otMessageRead
otMessageWrite

OtMessageSetOffset

void otMessageSetOffset(
  otMessage *aMessage,
  uint16_t aOffset
)

Define 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
)

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 em que 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
otMessageAppend
otMessageGetLength
otMessageSetLength
otMessageGetOffset
otMessageSetOffset
otMessageRead

Recursos

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

Message

Resumo

Enumerações

Typedefs

Functions

Estruturas

Enumerações

OtMessagePriority

Typedefs

OtBufferInfo

Mensagem de Ot

OtMessagePriority

OtMessageQueueInfo

Configurações de mensagem

Functions

OtMessageAppend

OtMessageFree

OtMessageGetBufferInfo

OtMessageGetLength

OtMessageGetOffset

OtMessageGetRs

OtMessageIsLinkSecurityEnabled

OtMessageQueueDequeue

OtMessageQueueEnqueue

OtMessageQueueEnqueueAtHead

OtMessageQueueGetHead

OtMessageQueueGetNext

OtMessageQueueInit

OtMessageRead

OtMessageSetDirectTransmission

OtMessageSetLength

OtMessageSetOffset

OtMessageWrite

Recursos