Mensagem

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

Resumo

Enumerações
otMessageOrigin{
  OT_MESSAGE_ORIGIN_THREAD_NETIF = 0,
  OT_MESSAGE_ORIGIN_HOST_TRUSTED = 1,
  OT_MESSAGE_ORIGIN_HOST_UNTRUSTED = 2
} 		enum
Define as origens das mensagens do OpenThread.
otMessagePriority{
  OT_MESSAGE_PRIORITY_LOW = 0,
  OT_MESSAGE_PRIORITY_NORMAL = 1,
  OT_MESSAGE_PRIORITY_HIGH = 2
} 		enum
Define os níveis de prioridade das mensagens do OpenThread.

Typedefs
otBufferInfo typedef
struct otBufferInfo
Representa as informações do buffer de mensagem para diferentes filas usadas pela pilha do OpenThread.
otMessage typedef
struct otMessage
Uma representação opaca de um buffer de mensagem do OpenThread.
otMessageOrigin typedef
Define as origens das mensagens do OpenThread.
otMessagePriority typedef
Define os níveis de prioridade das mensagens do OpenThread.
otMessageQueueInfo typedef
Representa informações sobre uma fila de mensagens.
otMessageSettings typedef
Representa as configurações de uma mensagem.

remotas
otMessageAppend(otMessage *aMessage, const void *aBuf, uint16_t aLength)
Anexe bytes a uma mensagem.
otMessageFree(otMessage *aMessage)
void
Liberar um buffer de mensagem alocado.
otMessageGetBufferInfo(otInstance *aInstance, otBufferInfo *aBufferInfo)
void
Acessa as informações do buffer de mensagens.
otMessageGetLength(const otMessage *aMessage)
uint16_t
Consiga o tamanho da mensagem em bytes.
otMessageGetOffset(const otMessage *aMessage)
uint16_t
Acessa o deslocamento da mensagem em bytes.
otMessageGetOrigin(const otMessage *aMessage)
Extrai a origem da mensagem.
otMessageGetRss(const otMessage *aMessage)
int8_t
Retorna o RSS (intensidade do sinal recebido) médio associado à mensagem.
otMessageIsLinkSecurityEnabled(const otMessage *aMessage)
bool
Indica se a segurança de links está ativada para a mensagem.
otMessageIsLoopbackToHostAllowed(const otMessage *aMessage)
bool
Indica se a mensagem tem permissão para ser retornada ao host.
otMessageIsMulticastLoopEnabled(otMessage *aMessage)
bool
Indica se a mensagem dada pode ser retornada em loop no caso de um endereço de destino multicast.
otMessageQueueDequeue(otMessageQueue *aQueue, otMessage *aMessage)
void
Remove uma mensagem da fila de mensagens especificada.
otMessageQueueEnqueue(otMessageQueue *aQueue, otMessage *aMessage)
void
Adiciona uma mensagem ao final da fila de mensagens especificada.
otMessageQueueEnqueueAtHead(otMessageQueue *aQueue, otMessage *aMessage)
void
Adiciona uma mensagem no início ou na frente da fila de mensagens especificada.
otMessageQueueGetHead(otMessageQueue *aQueue)
Retorna um ponteiro para a mensagem no início da fila.
otMessageQueueGetNext(otMessageQueue *aQueue, const otMessage *aMessage)
Retorna um ponteiro para a próxima mensagem na fila iterando para frente (de ponta a ponta).
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
Redefine o contador de informações do buffer de mensagens rastreando o número máximo de buffers em uso ao mesmo tempo.
otMessageSetDirectTransmission(otMessage *aMessage, bool aEnabled)
void
Define/força a mensagem a ser encaminhada usando a transmissão direta.
otMessageSetLength(otMessage *aMessage, uint16_t aLength)
Define o tamanho da mensagem em bytes.
otMessageSetLoopbackToHostAllowed(otMessage *aMessage, bool aAllowLoopbackToHost)
void
Define se a mensagem tem permissão para ser retornada ao host.
otMessageSetMulticastLoopEnabled(otMessage *aMessage, bool aEnabled)
void
Controla se a mensagem pode ser retornada em loop no caso de um endereço de destino multicast.
otMessageSetOffset(otMessage *aMessage, uint16_t aOffset)
void
Define o deslocamento da mensagem em bytes.
otMessageSetOrigin(otMessage *aMessage, otMessageOrigin aOrigin)
void
Define a origem da mensagem.
otMessageWrite(otMessage *aMessage, uint16_t aOffset, const void *aBuf, uint16_t aLength)
int
Gravar bytes em uma mensagem.

Estruturas
otBufferInfo

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

otMessageQueue

Representa uma fila de mensagens do OpenThread.

otMessageQueueInfo

Representa informações sobre uma fila de mensagens.

otMessageSettings

Representa as configurações de uma mensagem.

Enumerações

otMessageOrigin

 otMessageOrigin

Define as origens das mensagens do OpenThread.

Propriedades
OT_MESSAGE_ORIGIN_HOST_TRUSTED

Mensagem de uma fonte confiável no host.

OT_MESSAGE_ORIGIN_HOST_UNTRUSTED

Mensagem de uma origem não confiável no host.

OT_MESSAGE_ORIGIN_THREAD_NETIF

Mensagem do Thread Netif.

otMessagePriority

 otMessagePriority

Define os níveis de prioridade das 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

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

otMessage

struct otMessage otMessage

Uma representação opaca de um buffer de mensagem do OpenThread.

otMessageOrigin

enum otMessageOrigin otMessageOrigin

Define as origens das mensagens do OpenThread.

otMessagePriority

enum otMessagePriority otMessagePriority

Define os níveis de prioridade das mensagens do OpenThread.

otMessageQueueInfo

struct otMessageQueueInfo otMessageQueueInfo

Representa informações sobre uma fila de mensagens.

otMessageSettings

struct otMessageSettings otMessageSettings

Representa as configurações de uma mensagem.

remotas

otMessageAppend

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 a serem anexados.
[in] aLength
Número de bytes a serem anexados.
Valores de retorno
OT_ERROR_NONE
Mensagem anexada com sucesso
OT_ERROR_NO_BUFS
Não há buffers disponíveis para ampliar a mensagem.
Consulte também:
otMessageFree
otMessageGetLength
otMessageSetLength
otMessageGetOffset
otMessageSetOffset
otMessageRead
otMessageWrite

otMessageFree

void otMessageFree(
  otMessage *aMessage
)

Liberar um buffer de mensagem alocado.

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

otMessageGetBufferInfo

void otMessageGetBufferInfo(
  otInstance *aInstance,
  otBufferInfo *aBufferInfo
)

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

Consiga 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.
Consulte também:
otMessageFree
otMessageAppend
otMessageSetLength
otMessageGetOffset
otMessageSetOffset
otMessageRead
otMessageWrite18 t
otMessageSetLength

otMessageGetOffset

uint16_t otMessageGetOffset(
  const otMessage *aMessage
)

Acessa 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.
Consulte também:
otMessageFree
otMessageAppend
otMessageGetLength
otMessageSetLength
otMessageSetOffset
otMessageRead
otMessageWrite

otMessageGetOrigin

otMessageOrigin otMessageGetOrigin(
  const otMessage *aMessage
)

Extrai a origem da mensagem.

Detalhes
Parâmetros
[in] aMessage
Um ponteiro para um buffer de mensagem.
Retorna
A origem da mensagem.

otMessageGetRss

int8_t otMessageGetRss(
  const otMessage *aMessage
)

Retorna o RSS (intensidade do sinal recebido) médio associado à mensagem.

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

otMessageIsLinkSecurityEnabled

bool otMessageIsLinkSecurityEnabled(
  const otMessage *aMessage
)

Indica se a segurança de links está ativada para a 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.

otMessageIsLoopbackToHostAllowed

bool otMessageIsLoopbackToHostAllowed(
  const otMessage *aMessage
)

Indica se a mensagem tem permissão para ser retornada ao host.

Detalhes
Parâmetros
[in] aMessage
Um ponteiro para um buffer de mensagem.
Valores de retorno
TRUE
Se a mensagem pode ser repetida para o host.
FALSE
Se não for possível retornar a mensagem ao host.

otMessageIsMulticastLoopEnabled

bool otMessageIsMulticastLoopEnabled(
  otMessage *aMessage
)

Indica se a mensagem dada pode ser retornada em loop no caso de um endereço de destino multicast.

Se aMessage for usado com um otMessageInfo, o campo mMulticastLoop da estrutura otMessageInfo terá precedência e vai ser usado em vez do valor definido em aMessage.

Essa API se destina principalmente ao uso com otIp6Send(), que espera uma mensagem IPv6 já preparada.

Detalhes
Parâmetros
[in] aMessage
Um ponteiro para a mensagem.

otMessageQueueDequeue

void otMessageQueueDequeue(
  otMessageQueue *aQueue,
  otMessage *aMessage
)

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
)

Adiciona uma mensagem ao final da fila de mensagens especificada.

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

otMessageQueueEnqueueAtHead

void otMessageQueueEnqueueAtHead(
  otMessageQueue *aQueue,
  otMessage *aMessage
)

Adiciona uma mensagem no início ou na frente da fila de mensagens especificada.

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

otMessageQueueGetHead

otMessage * otMessageQueueGetHead(
  otMessageQueue *aQueue
)

Retorna um ponteiro para a mensagem no início da fila.

Detalhes
Parâmetros
[in] aQueue
Um ponteiro para uma fila de mensagens.
Retorna
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
)

Retorna um ponteiro para a próxima mensagem na fila iterando para frente (de ponta a ponta).

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 depois de 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.

PRECISA ser chamado uma vez, e apenas uma vez, para uma instância otMessageQueue antes de qualquer outra função otMessageQueue. O comportamento será 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.

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.
Consulte também:
otMessageFree
otMessageAppend
otMessageGetLength
otMessageSetLength
otMessageGetOffset
otMessageSetOffset
otMessageWrite

otMessageResetBufferInfo

void otMessageResetBufferInfo(
  otInstance *aInstance
)

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

Isso vai redefinir o mMaxUsedBuffers em otBufferInfo.

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

otMessageSetDirectTransmission

void otMessageSetDirectTransmission(
  otMessage *aMessage,
  bool aEnabled
)

Define/força a mensagem a ser encaminhada usando a transmissão direta.

A configuração padrão para novas mensagens é false.

Detalhes
Parâmetros
[in] aMessage
Um ponteiro para um buffer de mensagem.
[in] aEnabled
Se o valor 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
)

Define o tamanho da mensagem em bytes.

Detalhes
Parâmetros
[in] aMessage
Um ponteiro para um buffer de mensagem.
[in] aLength
Um comprimento em bytes.
Valores de retorno
OT_ERROR_NONE
O tamanho da mensagem foi definido.
OT_ERROR_NO_BUFS
Não há buffers disponíveis para ampliar a mensagem.
Consulte também:
otMessageFree
otMessageAppend
otMessageGetLength
otMessageGetOffset
otMessageSetOffset
otMessageRead
otMessageWrite

otMessageSetLoopbackToHostAllowed

void otMessageSetLoopbackToHostAllowed(
  otMessage *aMessage,
  bool aAllowLoopbackToHost
)

Define se a mensagem tem permissão para ser retornada ao host.

Detalhes
Parâmetros
[in] aMessage
Um ponteiro para um buffer de mensagem.
[in] aAllowLoopbackToHost
Define se a mensagem será transmitida de volta para o host.

otMessageSetMulticastLoopEnabled

void otMessageSetMulticastLoopEnabled(
  otMessage *aMessage,
  bool aEnabled
)

Controla se a mensagem pode ser retornada em loop no caso de um endereço de destino multicast.

Detalhes
Parâmetros
[in] aMessage
Um ponteiro para a mensagem.
[in] aEnabled
O valor de configuração.

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.
Consulte também:
otMessageFree
otMessageAppend
otMessageGetLength
otMessageSetLength
otMessageGetOffset
otMessageRead
otMessageWrite

otMessageSetOrigin

void otMessageSetOrigin(
  otMessage *aMessage,
  otMessageOrigin aOrigin
)

Define a origem da mensagem.

Detalhes
Parâmetros
[in] aMessage
Um ponteiro para um buffer de mensagem.
[in] aOrigin
A origem da mensagem.

otMessageWrite

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

Gravar 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.
Consulte 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 mais informações ou para contribuir com nossa documentação, consulte Recursos.