Agente de borda

Este módulo inclui funções para o papel Thread Border Agent.

Resumo

Enumerações
otBorderAgentState{
  OT_BORDER_AGENT_STATE_STOPPED = 0,
  OT_BORDER_AGENT_STATE_STARTED = 1,
  OT_BORDER_AGENT_STATE_ACTIVE = 2
} 		tipo enumerado
Define o estado do agente de borda.

Typedefs
otBorderAgentId typedef
Representa um ID de agente de borda.
otBorderAgentState typedef
Define o estado do agente de borda.

Variáveis.
OT_TOOL_PACKED_END

Funções
otBorderAgentGetId(otInstance *aInstance, otBorderAgentId *aId)
Obtém o ID do agente de borda gerado aleatoriamente.
otBorderAgentGetState(otInstance *aInstance)
Recebe o otBorderAgentState do papel Thread Border Agent.
otBorderAgentGetUdpPort(otInstance *aInstance)
uint16_t
Recebe a porta UDP do serviço Thread Border Agent.
otBorderAgentSetId(otInstance *aInstance, const otBorderAgentId *aId)
Define o ID do agente de borda.

Estruturas
otBorderAgentId (em inglês)

Representa um ID de agente de borda.

Enumerações

OtBorderAgentState

 otBorderAgentState

Define o estado do agente de borda.

Propriedades
OT_BORDER_AGENT_STATE_ACTIVE

O agente de borda está conectado ao comissário externo.

OT_BORDER_AGENT_STATE_STARTED

O agente de borda foi iniciado.

OT_BORDER_AGENT_STATE_STOPPED

O papel de agente de borda está desativado.

Typedefs

ID do otBorderAgent

struct otBorderAgentId otBorderAgentId

Representa um ID de agente de borda.

OtBorderAgentState

enum otBorderAgentState otBorderAgentState

Define o estado do agente de borda.

Variáveis.

OT_TOOL_PACKED_END

OT_TOOL_PACKED_BEGIN struct otBorderAgentId OT_TOOL_PACKED_END

Funções

OtBorderAgentGetId

otError otBorderAgentGetId(
  otInstance *aInstance,
  otBorderAgentId *aId
)

Obtém o ID do agente de borda gerado aleatoriamente.

O código é salvo no armazenamento permanente e sobrevive a reinicializações. O caso de uso típico do ID é ser publicado no serviço mDNS MeshCoP como o valor TXT id para que o cliente identifique o dispositivo Border Router/Agent.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
[out] aId
Um ponteiro para armazenar em buffer para receber o ID.
Valores de retorno
OT_ERROR_NONE
Se o ID do agente de borda foi recuperado.
...
Em caso de falha ao recuperar o ID do agente de borda.
Consulte também:
otBorderAgentSetId

OtBorderAgentGetState

otBorderAgentState otBorderAgentGetState(
  otInstance *aInstance
)

Recebe o otBorderAgentState do papel Thread Border Agent.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
Retorna
O otBorderAgentState atual do agente de borda.

PortaOtBorderAgentGetUdp

uint16_t otBorderAgentGetUdpPort(
  otInstance *aInstance
)

Recebe a porta UDP do serviço Thread Border Agent.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
Retorna
Porta UDP do agente de borda.

ID do otBorderAgentSet

otError otBorderAgentSetId(
  otInstance *aInstance,
  const otBorderAgentId *aId
)

Define o ID do agente de borda.

O ID do agente de borda será salvo no armazenamento permanente e sobreviverá a reinicializações. É necessário definir o código apenas uma vez após a redefinição para a configuração original. Se o ID nunca tiver sido definido chamando essa função, um ID aleatório será gerado e retornado quando otBorderAgentGetId for chamado.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
[out] aId
Um ponteiro para o ID do agente de borda.
Valores de retorno
OT_ERROR_NONE
Se o ID do agente de borda tiver sido definido.
...
Em caso de falha ao definir o ID do agente de borda.
Consulte também:
otBorderAgentGetId

Macros

Pr_BORDER_AGENT_ID_LENGTH

 OT_BORDER_AGENT_ID_LENGTH (16)

O comprimento do agente de borda/ID do roteador em bytes.

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.