Google se compromete a impulsar la igualdad racial para las comunidades afrodescendientes. Obtén información al respecto.

Agente de borde

Este módulo incluye funciones para la función de agente de borde de Thread.

Resumen

Enumeraciones

otBorderAgentState{
  OT_BORDER_AGENT_STATE_STOPPED = 0,
  OT_BORDER_AGENT_STATE_STARTED = 1,
  OT_BORDER_AGENT_STATE_ACTIVE = 2
}
Enum
En esta enumeración, se define el estado del agente de borde.

Typedefs

otBorderAgentState typedef
En esta enumeración, se define el estado del agente de borde.

Funciones

otBorderAgentGetId(otInstance *aInstance, uint8_t *aId, uint16_t *aLength)
Obtiene el ID del agente de borde generado de forma aleatoria.
otBorderAgentGetState(otInstance *aInstance)
Obtiene el otBorderAgentState de la función de agente de borde de Thread.
otBorderAgentGetUdpPort(otInstance *aInstance)
uint16_t
Obtiene el puerto UDP del servicio del Agente de borde de Thread.

Enumeraciones

otBorderAgentState

 otBorderAgentState

En esta enumeración, se define el estado del agente de borde.

Propiedades
OT_BORDER_AGENT_STATE_ACTIVE

El agente de borde se conecta con el comisionado externo.

OT_BORDER_AGENT_STATE_STARTED

Se inició el agente de borde.

OT_BORDER_AGENT_STATE_STOPPED

La función de agente de borde está inhabilitada.

Typedefs

otBorderAgentState

enum otBorderAgentState otBorderAgentState

En esta enumeración, se define el estado del agente de borde.

Funciones

otBorderAgentGetId

otError otBorderAgentGetId(
  otInstance *aInstance,
  uint8_t *aId,
  uint16_t *aLength
)

Obtiene el ID del agente de borde generado de forma aleatoria.

El ID se guarda en el almacenamiento persistente y se mantiene después de los reinicios. El caso de uso típico del ID es que se publique en el servicio mDNS de MeshCoP como el valor id TXT para que el cliente identifique este dispositivo Border Router/Agent.

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.
[out] aId
Un puntero para almacenar en búfer y recibir el ID.
[in,out] aLength
Especifica la longitud de aId cuando se usa como entrada y recibe la longitud de los datos de ID reales copiados en aId cuando se usan como salida.
Valores que se muestran
OT_ERROR_INVALID_ARGS
Si el valor es aLength si es menor que OT_BORDER_AGENT_ID_LENGTH.
OT_ERROR_NONE
Si se recuperó correctamente el ID del agente de borde

otBorderAgentGetState

otBorderAgentState otBorderAgentGetState(
  otInstance *aInstance
)

Obtiene el otBorderAgentState de la función de agente de borde de Thread.

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.
Qué muestra
El otBorderAgentState actual del agente de borde.

otBorderAgentGetUdpPort

uint16_t otBorderAgentGetUdpPort(
  otInstance *aInstance
)

Obtiene el puerto UDP del servicio del Agente de borde de Thread.

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.
Qué muestra
Puerto UDP del agente de borde.

Macros

PO_BORDER_AGENT_ID_LENGTH

 OT_BORDER_AGENT_ID_LENGTH (16)

Es la longitud del ID del router o del agente de borde en bytes.

Recursos

Los temas de referencia de la API de OpenThread se originan a partir del código fuente, disponible en GitHub. Para obtener más información o colaborar con nuestra documentación, consulta la sección Recursos.