Border Agent

Dieses Modul enthält Funktionen für die Rolle „Thread-Border-Agent“.

Zusammenfassung

Aufzählungen
otBorderAgentState{
  OT_BORDER_AGENT_STATE_STOPPED = 0,
  OT_BORDER_AGENT_STATE_STARTED = 1,
  OT_BORDER_AGENT_STATE_ACTIVE = 2
} 		enum
Definiert den Status des Border Agent.

Typdef1
otBorderAgentId Typdef
Eine Border Agent-ID
otBorderAgentState Typdef
Definiert den Status des Border Agent.

Variablen
OT_TOOL_PACKED_END

Functions
otBorderAgentGetId(otInstance *aInstance, otBorderAgentId *aId)
Ruft die zufällig generierte Border Agent-ID ab
otBorderAgentGetState(otInstance *aInstance)
Ruft den otBorderAgentState der Thread-Border-Agent-Rolle ab.
otBorderAgentGetUdpPort(otInstance *aInstance)
uint16_t
Ruft den UDP-Port des Thread-Border-Agent-Dienstes ab.
otBorderAgentSetId(otInstance *aInstance, const otBorderAgentId *aId)
Legt die Border Agent-ID fest.

Structs
otBorderAgentId

Eine Border Agent-ID

Aufzählungen

OTBorderAgentState

 otBorderAgentState

Definiert den Status des Border Agent.

Attribute
OT_BORDER_AGENT_STATE_ACTIVE

Der Border Agent ist mit einem externen Provisionsmitarbeiter verbunden.

OT_BORDER_AGENT_STATE_STARTED

Border Agent wurde gestartet.

OT_BORDER_AGENT_STATE_STOPPED

Die Rolle „Border-Agent“ ist deaktiviert.

Typdef1

OTBorderAgentId

struct otBorderAgentId otBorderAgentId

Eine Border Agent-ID

OTBorderAgentState

enum otBorderAgentState otBorderAgentState

Definiert den Status des Border Agent.

Variablen

OT_TOOL_PACKED_END

OT_TOOL_PACKED_BEGIN struct otBorderAgentId OT_TOOL_PACKED_END

Functions

otBorderAgentGetId

otError otBorderAgentGetId(
  otInstance *aInstance,
  otBorderAgentId *aId
)

Ruft die zufällig generierte Border Agent-ID ab

Die ID wird in nichtflüchtigem Speicher gespeichert und bleibt auch nach einem Neustart erhalten. Der typische Anwendungsfall für die ID ist im mDNS-Dienst von MeshCoP als id-TXT-Wert für den Client zu veröffentlichen, der dieses Border-Router/Agent-Gerät identifiziert.

Details
Parameter
[in] aInstance
Ein Zeiger auf eine OpenThread-Instanz.
[out] aId
Zeiger, der zwischengespeichert werden soll, um die ID zu erhalten.
Rückgabewerte
OT_ERROR_NONE
Wenn der Border Agent-ID erfolgreich abgerufen wurde.
...
Wenn die Border Agent-ID nicht abgerufen werden konnte.
Weitere Informationen:
otBorderAgentSetId

otBorderAgentGetState

otBorderAgentState otBorderAgentGetState(
  otInstance *aInstance
)

Ruft den otBorderAgentState der Thread-Border-Agent-Rolle ab.

Details
Parameter
[in] aInstance
Ein Zeiger auf eine OpenThread-Instanz.
Rückgabe
Der aktuelle otBorderAgentState des Border Agent.

UTBorderAgentGetUdpPort

uint16_t otBorderAgentGetUdpPort(
  otInstance *aInstance
)

Ruft den UDP-Port des Thread-Border-Agent-Dienstes ab.

Details
Parameter
[in] aInstance
Ein Zeiger auf eine OpenThread-Instanz.
Rückgabe
UDP-Port des Border Agent.

otBorderAgentSetId

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

Legt die Border Agent-ID fest.

Die Border Agent-ID wird im nichtflüchtigen Speicher gespeichert und bleibt auch nach einem Neustart bestehen. Die ID muss nach dem Zurücksetzen auf die Werkseinstellungen nur einmal festgelegt werden. Wenn die Funktion nie aufgerufen wurde, wird eine zufällige ID generiert und zurückgegeben, wenn otBorderAgentGetId aufgerufen wird.

Details
Parameter
[in] aInstance
Ein Zeiger auf eine OpenThread-Instanz.
[out] aId
Ein Zeiger auf die Border Agent-ID.
Rückgabewerte
OT_ERROR_NONE
Wenn die Border Agent-ID erfolgreich festgelegt wurde.
...
Wenn die Border Agent-ID nicht festgelegt werden konnte.
Weitere Informationen:
otBorderAgentGetId

Makros

OT_BORDER_AGENT_ID_LENGTH

 OT_BORDER_AGENT_ID_LENGTH (16)

Die Länge des Border Agent/Router-IDs in Byte.

Ressourcen

Die Themen der OpenThread API-Referenz stammen aus dem Quellcode, der auf GitHub verfügbar ist. Weitere Informationen oder als Ergänzung zu unserer Dokumentation finden Sie unter Ressourcen.