Border-Router
Dieses Modul enthält Funktionen zum Verwalten lokaler Netzwerkdaten mit dem OpenThread Border Router.
Zusammenfassung
Funktionen |
|
---|---|
otBorderRouterAddOnMeshPrefix(otInstance *aInstance, const otBorderRouterConfig *aConfig)
|
Fügen Sie den lokalen Netzwerkdaten eine Konfiguration für einen Border-Router hinzu.
|
otBorderRouterAddRoute(otInstance *aInstance, const otExternalRouteConfig *aConfig)
|
Fügen Sie den Daten des lokalen Netzwerks eine externe Routenkonfiguration hinzu.
|
otBorderRouterGetNetData(otInstance *aInstance, bool aStable, uint8_t *aData, uint8_t *aDataLength)
|
Mit dieser Methode wird eine vollständige oder stabile Kopie der lokalen Thread-Netzwerkdaten bereitgestellt.
|
otBorderRouterGetNextOnMeshPrefix(otInstance *aInstance, otNetworkDataIterator *aIterator, otBorderRouterConfig *aConfig)
|
Diese Funktion ruft das nächste On Mesh-Präfix in den lokalen Netzwerkdaten ab.
|
otBorderRouterGetNextRoute(otInstance *aInstance, otNetworkDataIterator *aIterator, otExternalRouteConfig *aConfig)
|
Diese Funktion ruft die nächste externe Route in den lokalen Netzwerkdaten ab.
|
otBorderRouterRegister(otInstance *aInstance)
|
Registrieren Sie sofort die lokalen Netzwerkdaten beim Leader.
|
otBorderRouterRemoveOnMeshPrefix(otInstance *aInstance, const otIp6Prefix *aPrefix)
|
Entfernen Sie eine Border-Router-Konfiguration aus den lokalen Netzwerkdaten.
|
otBorderRouterRemoveRoute(otInstance *aInstance, const otIp6Prefix *aPrefix)
|
Entfernen Sie die Konfiguration einer externen Route aus den lokalen Netzwerkdaten.
|
otBorderRoutingGetNat64Prefix(otInstance *aInstance, otIp6Prefix *aPrefix)
|
Diese Funktion gibt das lokale NAT64-Präfix zurück.
|
otBorderRoutingGetOmrPrefix(otInstance *aInstance, otIp6Prefix *aPrefix)
|
Diese Methode gibt das Präfix des Off-Mesh-Roibles (OMR) zurück.
|
otBorderRoutingGetOnLinkPrefix(otInstance *aInstance, otIp6Prefix *aPrefix)
|
Diese Methode gibt das On-Link-Präfix für den angrenzenden Infrastruktur-Link zurück.
|
otBorderRoutingInit(otInstance *aInstance, uint32_t aInfraIfIndex, bool aInfraIfIsRunning)
|
Diese Methode initialisiert den Border Routing Manager auf der angegebenen Infrastrukturschnittstelle.
|
otBorderRoutingSetEnabled(otInstance *aInstance, bool aEnabled)
|
Mit dieser Methode wird der Border Routing Manager aktiviert/deaktiviert.
|
Funktionen
otBorderRouterAddOnMeshPrefix
otError otBorderRouterAddOnMeshPrefix( otInstance *aInstance, const otBorderRouterConfig *aConfig )
Fügen Sie den lokalen Netzwerkdaten eine Konfiguration für einen Border-Router hinzu.
Details | |||||||
---|---|---|---|---|---|---|---|
Parameter |
|
||||||
Rückgabewerte |
|
otBorderRouterRemoveOnMeshPrefix
otBorderRouterRegister
otBorderRouterAddRoute
otError otBorderRouterAddRoute( otInstance *aInstance, const otExternalRouteConfig *aConfig )
Fügen Sie den Daten des lokalen Netzwerks eine externe Routenkonfiguration hinzu.
Details | |||||||
---|---|---|---|---|---|---|---|
Parameter |
|
||||||
Rückgabewerte |
|
otBorderRouterRemoveRoute
otBorderRouterRegister
otBorderRouterGetNetData
otError otBorderRouterGetNetData( otInstance *aInstance, bool aStable, uint8_t *aData, uint8_t *aDataLength )
Mit dieser Methode wird eine vollständige oder stabile Kopie der lokalen Thread-Netzwerkdaten bereitgestellt.
Details | |||||||||
---|---|---|---|---|---|---|---|---|---|
Parameter |
|
otBorderRouterGetNextOnMeshPrefix
otError otBorderRouterGetNextOnMeshPrefix( otInstance *aInstance, otNetworkDataIterator *aIterator, otBorderRouterConfig *aConfig )
Diese Funktion ruft das nächste On Mesh-Präfix in den lokalen Netzwerkdaten ab.
Details | |||||||
---|---|---|---|---|---|---|---|
Parameter |
|
||||||
Rückgabewerte |
|
otBorderRouterGetNextRoute
otError otBorderRouterGetNextRoute( otInstance *aInstance, otNetworkDataIterator *aIterator, otExternalRouteConfig *aConfig )
Diese Funktion ruft die nächste externe Route in den lokalen Netzwerkdaten ab.
Details | |||||||
---|---|---|---|---|---|---|---|
Parameter |
|
||||||
Rückgabewerte |
|
otBorderRouterRegister
otError otBorderRouterRegister( otInstance *aInstance )
Registrieren Sie sofort die lokalen Netzwerkdaten beim Leader.
Details | |||
---|---|---|---|
Parameter |
|
||
Rückgabewerte |
|
otBorderRouterAddOnMeshPrefix
otBorderRouterRemoveOnMeshPrefix
otBorderRouterAddRoute
otBorderRouterRemoveRoute
otBorderRouterRemoveOnMeshPrefix
otError otBorderRouterRemoveOnMeshPrefix( otInstance *aInstance, const otIp6Prefix *aPrefix )
Entfernen Sie eine Border-Router-Konfiguration aus den lokalen Netzwerkdaten.
Details | |||||
---|---|---|---|---|---|
Parameter |
|
||||
Rückgabewerte |
|
otBorderRouterAddOnMeshPrefix
otBorderRouterRegister
otBorderRouterRemoveRoute
otError otBorderRouterRemoveRoute( otInstance *aInstance, const otIp6Prefix *aPrefix )
Entfernen Sie die Konfiguration einer externen Route aus den lokalen Netzwerkdaten.
Details | |||||
---|---|---|---|---|---|
Parameter |
|
||||
Rückgabewerte |
|
otBorderRouterAddRoute
otBorderRouterRegister
otBorderRoutingGetNat64Prefix
otError otBorderRoutingGetNat64Prefix( otInstance *aInstance, otIp6Prefix *aPrefix )
Diese Funktion gibt das lokale NAT64-Präfix zurück.
Dieses Präfix wird im Thread-Netzwerk möglicherweise nicht beworben.
Diese Funktion ist nur verfügbar, wenn OPENTHREAD_CONFIG_BORDER_ROUTING_NAT64_ENABLE
aktiviert ist.
Details | |||||
---|---|---|---|---|---|
Parameter |
|
||||
Rückgabewerte |
|
otBorderRoutingGetOmrPrefix
otError otBorderRoutingGetOmrPrefix( otInstance *aInstance, otIp6Prefix *aPrefix )
Diese Methode gibt das Präfix des Off-Mesh-Roibles (OMR) zurück.
Das zufällig generierte 64-Bit-Präfix wird im Thread-Netzwerk veröffentlicht, wenn nicht bereits ein OMR-Präfix vorhanden ist.
Details | |||||
---|---|---|---|---|---|
Parameter |
|
||||
Rückgabewerte |
|
otBorderRoutingGetOnLinkPrefix
otError otBorderRoutingGetOnLinkPrefix( otInstance *aInstance, otIp6Prefix *aPrefix )
Diese Methode gibt das On-Link-Präfix für den angrenzenden Infrastruktur-Link zurück.
Das zufällig generierte 64-Bit-Präfix wird im Infrastrukturlink angegeben, wenn nicht bereits ein verwendbares On-Link-Präfix für den Link angeboten wird.
Details | |||||
---|---|---|---|---|---|
Parameter |
|
||||
Rückgabewerte |
|
otBorderRoutingInit
otError otBorderRoutingInit( otInstance *aInstance, uint32_t aInfraIfIndex, bool aInfraIfIsRunning )
Diese Methode initialisiert den Border Routing Manager auf der angegebenen Infrastrukturschnittstelle.
Details | |||||||||
---|---|---|---|---|---|---|---|---|---|
Parameter |
|
||||||||
Rückgabewerte |
|
otPlatInfraIfStateChanged
otBorderRoutingSetEnabled
otError otBorderRoutingSetEnabled( otInstance *aInstance, bool aEnabled )
Mit dieser Methode wird der Border Routing Manager aktiviert/deaktiviert.
Details | |||||
---|---|---|---|---|---|
Parameter |
|
||||
Rückgabewerte |
|
Ressourcen
Die OpenThread API-Referenzthemen stammen aus dem Quellcode, der auf GitHub verfügbar ist. Weitere Informationen und einen Beitrag zu unserer Dokumentation finden Sie unter Ressourcen.