TREL – Thread Stack

In diesem Modul werden die APIs von Thread Radio Encapsulation Link (TREL) für Thread Over Infrastructure definiert.

Zusammenfassung

Für die Funktionen in diesem Modul muss OPENTHREAD_CONFIG_RADIO_LINK_TREL_ENABLE aktiviert sein.

Typedefs
otTrelPeer typedef
struct otTrelPeer
Stellt einen TREL-Peer dar.
otTrelPeerIterator typedef
uint16_t
Stellt einen iterator zum Iterieren über TREL-Peer-Tabelleneinträge dar.

Funktionen
otTrelGetNextPeer(otInstance *aInstance, otTrelPeerIterator *aIterator)
const otTrelPeer *
Iteriert über die Peer-Tabelleneinträge und ruft den nächsten Eintrag aus der Tabelle ab.
otTrelInitPeerIterator(otInstance *aInstance, otTrelPeerIterator *aIterator)
void
Initialisiert einen Peer-Tabellen-iterator.
otTrelIsEnabled(otInstance *aInstance)
bool
Gibt an, ob der TREL-Vorgang aktiviert ist.
otTrelIsFilterEnabled(otInstance *aInstance)
bool
Gibt an, ob der Filtermodus aktiviert ist.
otTrelSetEnabled(otInstance *aInstance, bool aEnable)
void
Aktiviert oder deaktiviert den TREL-Vorgang.
otTrelSetFilterEnabled(otInstance *aInstance, bool aEnable)
void
Legt den Filtermodus fest (aktiviert/deaktiviert die Filterung).

Strukturen
otTrelPeer

Stellt einen TREL-Peer dar.

Typedefs

otTrelPeer

struct otTrelPeer otTrelPeer

Stellt einen TREL-Peer dar.

otTrelPeerIterator

uint16_t otTrelPeerIterator

Stellt einen iterator zum Iterieren über TREL-Peer-Tabelleneinträge dar.

Funktionen

otTrelGetNextPeer

const otTrelPeer * otTrelGetNextPeer(
  otInstance *aInstance,
  otTrelPeerIterator *aIterator
)

Iteriert über die Peer-Tabelleneinträge und ruft den nächsten Eintrag aus der Tabelle ab.

Details
Parameter
[in] aInstance
Die OpenThread-Instanz.
[in] aIterator
Der Iteration. MUSS initialisiert werden.
Rückgabe
Ein Zeiger auf den nächsten otTrelPeer-Eintrag oder NULL, wenn keine weiteren Einträge in der Tabelle vorhanden sind.

otTrelInitPeerIterator

void otTrelInitPeerIterator(
  otInstance *aInstance,
  otTrelPeerIterator *aIterator
)

Initialisiert einen Peer-Tabellen-iterator.

Details
Parameter
[in] aInstance
Die OpenThread-Instanz.
[in] aIterator
Der zu initialisierende Iteration.

otTrelIsEnabled

bool otTrelIsEnabled(
  otInstance *aInstance
)

Gibt an, ob der TREL-Vorgang aktiviert ist.

Details
Parameter
[in] aInstance
Die OpenThread-Instanz.
Rückgabewerte
TRUE
wenn der TREL-Vorgang aktiviert ist.
FALSE
wenn der TREL-Vorgang deaktiviert ist.

otTrelIsFilterEnabled

bool otTrelIsFilterEnabled(
  otInstance *aInstance
)

Gibt an, ob der Filtermodus aktiviert ist.

Details
Parameter
[in] aInstance
Die OpenThread-Instanz.
Rückgabewerte
TRUE
wenn der TREL-Filtermodus aktiviert ist.
FALSE
wenn der TREL-Filtermodus deaktiviert ist.

otTrelSetEnabled

void otTrelSetEnabled(
  otInstance *aInstance,
  bool aEnable
)

Aktiviert oder deaktiviert den TREL-Vorgang.

Wenn aEnable auf „true“ gesetzt ist, initiiert diese Funktion einen laufenden DNS-SD-Suchvorgang für den Dienstnamen „_trel._udp“ in der lokalen Browserdomain, um andere Geräte zu finden, die TREL unterstützen. Das Gerät registriert auch einen neuen Dienst, der mit DNS-SD beworben werden soll. Der Dienstname lautet „_trel._udp“. Dies gibt an, dass TREL unterstützt wird. Das Gerät kann dann TREL-Nachrichten von Peers empfangen.

Wenn aEnable auf „false“ gesetzt ist, beendet diese Funktion die DNS-SD-Suche für den Dienstnamen „_trel._udp“, beendet das Bewerben des TREL-DNS-SD-Dienstes und löscht die TREL-Peer-Tabelle.

Details
Parameter
[in] aInstance
Ein Zeiger auf eine OpenThread-Instanz.
[in] aEnable
Ein boolescher Wert zum Aktivieren/Deaktivieren des TREL-Vorgangs.

otTrelSetFilterEnabled

void otTrelSetFilterEnabled(
  otInstance *aInstance,
  bool aEnable
)

Legt den Filtermodus fest (aktiviert/deaktiviert die Filterung).

Wenn der Filtermodus aktiviert ist, wird jeglicher rx- und tx-Traffic über die TREL-Schnittstelle automatisch verworfen. Diese Funktion ist hauptsächlich für Tests vorgesehen.

Im Gegensatz zu otTrel{Enable/Disable}(), das den TREL-Vorgang vollständig startet/beendet, ist die TREL-Schnittstelle weiterhin aktiviert, wenn der Filtermodus aktiviert ist.

Details
Parameter
[in] aInstance
Die OpenThread-Instanz.
[in] aFiltered
TRUE zum Aktivieren des Filtermodus, FALSE zum Deaktivieren des Filtermodus.

Ressourcen

OpenThread API-Referenzthemen stammen aus dem Quellcode, der auf GitHub verfügbar ist. Weitere Informationen finden Sie unter Ressourcen. Dort können Sie auch einen Beitrag zu unserer Dokumentation leisten.