Backbone-Router
Dieses Modul enthält Funktionen für den BackThread-Backbone-Router-Dienst.
Zusammenfassung
Aufzählungen |
|
---|---|
otBackboneRouterDomainPrefixEvent{
|
enum Stellt die Domain-Präfixereignisse dar. |
otBackboneRouterMulticastListenerEvent{
|
enum Die Multicast-Listener-Ereignisse. |
otBackboneRouterNdProxyEvent{
|
enum Die ND-Proxy-Ereignisse. |
otBackboneRouterState{
|
enum Der Status des Backbone-Routers. |
Typdef1 |
|
---|---|
otBackboneRouterConfig
|
Typdefstruct otBackboneRouterConfig
Stellt die Backbone-Router-Konfiguration dar. |
otBackboneRouterDomainPrefixCallback)(void *aContext, otBackboneRouterDomainPrefixEvent aEvent, const otIp6Prefix *aDomainPrefix)
|
Typdefvoid(*
Der Zeiger wird immer dann aufgerufen, wenn sich das Domainpräfix geändert hat. |
otBackboneRouterMulticastListenerCallback)(void *aContext, otBackboneRouterMulticastListenerEvent aEvent, const otIp6Address *aAddress)
|
Typdefvoid(*
Der Mauszeiger wird aufgerufen, wenn sich die Multicast-Listener ändern. |
otBackboneRouterMulticastListenerInfo
|
Typdef Stellt einen Backcast-Router-Multicast-Listener-Informationen dar. |
otBackboneRouterMulticastListenerIterator
|
Typdefuint16_t
Wird für die Iteration über Multicast-Listener verwendet. |
otBackboneRouterNdProxyCallback)(void *aContext, otBackboneRouterNdProxyEvent aEvent, const otIp6Address *aDua)
|
Typdefvoid(*
Der Mauszeiger wird immer dann aufgerufen, wenn sich der Nd-Proxy geändert hat. |
otBackboneRouterNdProxyInfo
|
Typdefstruct otBackboneRouterNdProxyInfo
Stellt die ND Proxy-Informationen zum Backbone-Router dar. |
Functions |
|
---|---|
otBackboneRouterConfigNextDuaRegistrationResponse(otInstance *aInstance, const otIp6InterfaceIdentifier *aMlIid, uint8_t aStatus)
|
void
Konfiguriert den Antwortstatus für die nächste DUA-Registrierung.
|
otBackboneRouterConfigNextMulticastListenerRegistrationResponse(otInstance *aInstance, uint8_t aStatus)
|
void
Konfiguriert den Antwortstatus für die nächste Multicast-Listener-Registrierung.
|
otBackboneRouterGetConfig(otInstance *aInstance, otBackboneRouterConfig *aConfig)
|
void
Ruft die lokale Backbone-Router-Konfiguration ab.
|
otBackboneRouterGetDomainPrefix(otInstance *aInstance, otBorderRouterConfig *aConfig)
|
Ruft die Konfiguration der lokalen Domainpräfixe ab
|
otBackboneRouterGetNdProxyInfo(otInstance *aInstance, const otIp6Address *aDua, otBackboneRouterNdProxyInfo *aNdProxyInfo)
|
Ruft die BackND-Router-ND-Proxy-Informationen ab.
|
otBackboneRouterGetPrimary(otInstance *aInstance, otBackboneRouterConfig *aConfig)
|
Ruft die Informationen zum primären Backbone-Router im Thread-Netzwerk ab.
|
otBackboneRouterGetRegistrationJitter(otInstance *aInstance)
|
uint8_t
Gibt den Registrierungsjitter-Wert für den Backbone-Router zurück.
|
otBackboneRouterGetState(otInstance *aInstance)
|
Ruft den Backbone-Router otBackboneRouterState ab.
|
otBackboneRouterMulticastListenerAdd(otInstance *aInstance, const otIp6Address *aAddress, uint32_t aTimeout)
|
Fügt einen Multicast-Listener mit Zeitlimit in Sekunden hinzu.
|
otBackboneRouterMulticastListenerClear(otInstance *aInstance)
|
void
Löscht die Multicast-Listener.
|
otBackboneRouterMulticastListenerGetNext(otInstance *aInstance, otBackboneRouterMulticastListenerIterator *aIterator, otBackboneRouterMulticastListenerInfo *aListenerInfo)
|
Ruft die nächsten Multicast-Listener-Informationen ab (mit einem Iterator).
|
otBackboneRouterRegister(otInstance *aInstance)
|
Registriert explizit die lokale Backbone-Router-Konfiguration.
|
otBackboneRouterSetConfig(otInstance *aInstance, const otBackboneRouterConfig *aConfig)
|
Legt die lokale Backbone-Router-Konfiguration otBackboneRouterConfig fest.
|
otBackboneRouterSetDomainPrefixCallback(otInstance *aInstance, otBackboneRouterDomainPrefixCallback aCallback, void *aContext)
|
void
Legt den Callback des Domain-Präfixes für den Backbone-Router fest.
|
otBackboneRouterSetEnabled(otInstance *aInstance, bool aEnable)
|
void
Aktiviert oder deaktiviert die Backbone-Funktion.
|
otBackboneRouterSetMulticastListenerCallback(otInstance *aInstance, otBackboneRouterMulticastListenerCallback aCallback, void *aContext)
|
void
Legt den Backcast Router-Multicast-Listener-Callback fest.
|
otBackboneRouterSetNdProxyCallback(otInstance *aInstance, otBackboneRouterNdProxyCallback aCallback, void *aContext)
|
void
Legt den ND Proxy-Callback des Backbone-Routers fest.
|
otBackboneRouterSetRegistrationJitter(otInstance *aInstance, uint8_t aJitter)
|
void
Legt den Wert für den Registrierungs-Jitter für den Backbone fest.
|
Structs |
|
---|---|
otBackboneRouterConfig |
Stellt die Backbone-Router-Konfiguration dar. |
otBackboneRouterMulticastListenerInfo |
Stellt einen Backcast-Router-Multicast-Listener-Informationen dar. |
otBackboneRouterNdProxyInfo |
Stellt die ND Proxy-Informationen zum Backbone-Router dar. |
Aufzählungen
otBackboneRouterDomainPrefixEvent
otBackboneRouterDomainPrefixEvent
Stellt die Domain-Präfixereignisse dar.
Attribute | |
---|---|
OT_BACKBONE_ROUTER_DOMAIN_PREFIX_ADDED
|
Domainpräfix wurde hinzugefügt. |
OT_BACKBONE_ROUTER_DOMAIN_PREFIX_CHANGED
|
Domainpräfix wurde geändert. |
OT_BACKBONE_ROUTER_DOMAIN_PREFIX_REMOVED
|
Domainpräfix wurde entfernt. |
otBackboneRouterMulticastListenerEvent
otBackboneRouterMulticastListenerEvent
Die Multicast-Listener-Ereignisse.
Attribute | |
---|---|
OT_BACKBONE_ROUTER_MULTICAST_LISTENER_ADDED
|
Multicast-Listener wurde hinzugefügt. |
OT_BACKBONE_ROUTER_MULTICAST_LISTENER_REMOVED
|
Der Multicast-Listener wurde entfernt oder ist abgelaufen. |
otBackboneRouterNdProxyEvent
otBackboneRouterNdProxyEvent
Die ND-Proxy-Ereignisse.
Attribute | |
---|---|
OT_BACKBONE_ROUTER_NDPROXY_ADDED
|
ND-Proxy wurde hinzugefügt. |
OT_BACKBONE_ROUTER_NDPROXY_CLEARED
|
Alle ND-Proxys wurden gelöscht. |
OT_BACKBONE_ROUTER_NDPROXY_REMOVED
|
ND-Proxy wurde entfernt. |
OT_BACKBONE_ROUTER_NDPROXY_RENEWED
|
ND Proxy wurde verlängert. |
otBackboneRouter-Status
otBackboneRouterState
Der Status des Backbone-Routers.
Attribute | |
---|---|
OT_BACKBONE_ROUTER_STATE_DISABLED
|
Die Backbone-Funktion ist deaktiviert. |
OT_BACKBONE_ROUTER_STATE_PRIMARY
|
Der primäre Backbone-Router. |
OT_BACKBONE_ROUTER_STATE_SECONDARY
|
Sekundärer Backbone-Router. |
Typdef1
Konfiguration
struct otBackboneRouterConfig otBackboneRouterConfig
Stellt die Backbone-Router-Konfiguration dar.
otBackboneRouterDomainPrefixCallback
void(* otBackboneRouterDomainPrefixCallback)(void *aContext, otBackboneRouterDomainPrefixEvent aEvent, const otIp6Prefix *aDomainPrefix)
Der Zeiger wird immer dann aufgerufen, wenn sich das Domainpräfix geändert hat.
Details | |||||||
---|---|---|---|---|---|---|---|
Parameter |
|
otBackboneRouterMulticastListenerCallback
void(* otBackboneRouterMulticastListenerCallback)(void *aContext, otBackboneRouterMulticastListenerEvent aEvent, const otIp6Address *aAddress)
Der Mauszeiger wird aufgerufen, wenn sich die Multicast-Listener ändern.
Details | |||||||
---|---|---|---|---|---|---|---|
Parameter |
|
OTBackboneRouterMulticastListenerInfo
struct otBackboneRouterMulticastListenerInfo otBackboneRouterMulticastListenerInfo
Stellt einen Backcast-Router-Multicast-Listener-Informationen dar.
otBackboneRouterMulticastListenerIterator
uint16_t otBackboneRouterMulticastListenerIterator
Wird für die Iteration über Multicast-Listener verwendet.
otBackboneRouterNdProxyCallback
void(* otBackboneRouterNdProxyCallback)(void *aContext, otBackboneRouterNdProxyEvent aEvent, const otIp6Address *aDua)
Der Mauszeiger wird immer dann aufgerufen, wenn sich der Nd-Proxy geändert hat.
Details | |||||||
---|---|---|---|---|---|---|---|
Parameter |
|
otBackboneRouterNdProxyInfo
struct otBackboneRouterNdProxyInfo otBackboneRouterNdProxyInfo
Stellt die ND Proxy-Informationen zum Backbone-Router dar.
Functions
OTBackboneRouterConfigNextDuaRegistrierungsantwort
void otBackboneRouterConfigNextDuaRegistrationResponse( otInstance *aInstance, const otIp6InterfaceIdentifier *aMlIid, uint8_t aStatus )
Konfiguriert den Antwortstatus für die nächste DUA-Registrierung.
Hinweis: Nur verfügbar, wenn OPENTHREAD_CONFIG_REFERENCE_DEVICE_ENABLE
aktiviert ist. Wird nur zu Testzwecken und für die Zertifizierung verwendet.
TODO (DUA): Unterstützung von Coap-Fehlercodes und entsprechendem Prozess zu Zertifizierungszwecken
Details | |||||||
---|---|---|---|---|---|---|---|
Parameter |
|
otBackboneRouterConfigNextMulticastListenerRegistrationResponse
void otBackboneRouterConfigNextMulticastListenerRegistrationResponse( otInstance *aInstance, uint8_t aStatus )
Konfiguriert den Antwortstatus für die nächste Multicast-Listener-Registrierung.
Verfügbar, wenn OPENTHREAD_CONFIG_BACKBONE_ROUTER_ENABLE
, OPENTHREAD_CONFIG_BACKBONE_ROUTER_MULTICAST_ROUTING_ENABLE
und OPENTHREAD_CONFIG_REFERENCE_DEVICE_ENABLE
aktiviert sind.
Details | |||||
---|---|---|---|---|---|
Parameter |
|
OTBackboneRouterGetConfig
void otBackboneRouterGetConfig( otInstance *aInstance, otBackboneRouterConfig *aConfig )
Ruft die lokale Backbone-Router-Konfiguration ab.
Verfügbar, wenn OPENTHREAD_CONFIG_BACKBONE_ROUTER_ENABLE
aktiviert ist.
Details | |||||
---|---|---|---|---|---|
Parameter |
|
otBackboneRouterSetEnabled
otBackRouterRouterGetState
otBackRouterRouterSetConfig
otBackboneRouterReg
otBackboneRouterGetDomainPräfix
otError otBackboneRouterGetDomainPrefix( otInstance *aInstance, otBorderRouterConfig *aConfig )
Ruft die Konfiguration der lokalen Domainpräfixe ab
Details | |||||
---|---|---|---|---|---|
Parameter |
|
||||
Rückgabewerte |
|
otBackboneRouterGetNdProxyInfo
otError otBackboneRouterGetNdProxyInfo( otInstance *aInstance, const otIp6Address *aDua, otBackboneRouterNdProxyInfo *aNdProxyInfo )
Ruft die BackND-Router-ND-Proxy-Informationen ab.
Details | |||||||
---|---|---|---|---|---|---|---|
Parameter |
|
||||||
Rückgabewerte |
|
otBackboneRouterGetPrimär
otError otBackboneRouterGetPrimary( otInstance *aInstance, otBackboneRouterConfig *aConfig )
Ruft die Informationen zum primären Backbone-Router im Thread-Netzwerk ab.
Details | |||||
---|---|---|---|---|---|
Parameter |
|
||||
Rückgabewerte |
|
OTBackboneRouterGetRegistrierungJitter
uint8_t otBackboneRouterGetRegistrationJitter( otInstance *aInstance )
Gibt den Registrierungsjitter-Wert für den Backbone-Router zurück.
Details | |
---|---|
Rückgabe |
Registrierungsjitter-Wert für den Backbone-Router.
|
otBackboneRouterSetRegistrationJitter
OTBackboneRouterGetState
otBackboneRouterState otBackboneRouterGetState( otInstance *aInstance )
Ruft den Backbone-Router otBackboneRouterState ab.
Details | |||||||
---|---|---|---|---|---|---|---|
Parameter |
|
||||||
Rückgabewerte |
|
otBackboneRouterSetEnabled
otBackRouterRouterGetConfig
otBackboneRouterSetConfig
otBackboneRouterReg
otBackboneRouterMulticastListenerHinzufügen
otError otBackboneRouterMulticastListenerAdd( otInstance *aInstance, const otIp6Address *aAddress, uint32_t aTimeout )
Fügt einen Multicast-Listener mit Zeitlimit in Sekunden hinzu.
Übergeben Sie 0
, um das Standard-MLR-Zeitlimit zu verwenden.
Verfügbar, wenn OPENTHREAD_CONFIG_BACKBONE_ROUTER_ENABLE
, OPENTHREAD_CONFIG_BACKBONE_ROUTER_MULTICAST_ROUTING_ENABLE
und OPENTHREAD_CONFIG_REFERENCE_DEVICE_ENABLE
aktiviert sind.
Details | |||||||
---|---|---|---|---|---|---|---|
Parameter |
|
||||||
Rückgabewerte |
|
otBackboneRouterMulticastListenerClear
otBackboneRouterMulticastListenerGetNext
OTBackboneRouterMulticastListenerClear
void otBackboneRouterMulticastListenerClear( otInstance *aInstance )
Löscht die Multicast-Listener.
Verfügbar, wenn OPENTHREAD_CONFIG_BACKBONE_ROUTER_ENABLE
, OPENTHREAD_CONFIG_BACKBONE_ROUTER_MULTICAST_ROUTING_ENABLE
und OPENTHREAD_CONFIG_REFERENCE_DEVICE_ENABLE
aktiviert sind.
Details | |||
---|---|---|---|
Parameter |
|
otBackboneRouterMulticastListenerAdd
otBackboneRouterMulticastListenerGetNext
otBackboneRouterMultiCastListenerWeiter
otError otBackboneRouterMulticastListenerGetNext( otInstance *aInstance, otBackboneRouterMulticastListenerIterator *aIterator, otBackboneRouterMulticastListenerInfo *aListenerInfo )
Ruft die nächsten Multicast-Listener-Informationen ab (mit einem Iterator).
Details | |||||||
---|---|---|---|---|---|---|---|
Parameter |
|
||||||
Rückgabewerte |
|
otBackboneRouterMulticastListenerClear
otBackboneRouterMulticastListenerAdd
Registrieren
otError otBackboneRouterRegister( otInstance *aInstance )
Registriert explizit die lokale Backbone-Router-Konfiguration.
Für das angeschlossene Gerät wird eine Nachricht zur Serverdatenanforderung SRV_DATA.ntf
ausgelöst.
Verfügbar, wenn OPENTHREAD_CONFIG_BACKBONE_ROUTER_ENABLE
aktiviert ist.
Details | |||||
---|---|---|---|---|---|
Parameter |
|
||||
Rückgabewerte |
|
otBackboneRouterSetEnabled
otBackRouterRouterGetState
otBackRouterRouterGetConfig
otBackboneRouterSetConfig
otBackRouterSetSet
otError otBackboneRouterSetConfig( otInstance *aInstance, const otBackboneRouterConfig *aConfig )
Legt die lokale Backbone-Router-Konfiguration otBackboneRouterConfig fest.
Die Nachricht SRV_DATA.ntf
einer Serverdatenanforderung wird automatisch initiiert, wenn sich der BBR-Datensatz für den primären Backbone-Router ändert.
Verfügbar, wenn OPENTHREAD_CONFIG_BACKBONE_ROUTER_ENABLE
aktiviert ist.
Details | |||||
---|---|---|---|---|---|
Parameter |
|
||||
Rückgabewerte |
|
otBackboneRouterSetEnabled
otBackboneRouterGetState
otBackboneRouterGetConfig
otBackboneRouterReg
otBackboneRouterSetDomainPrefixCallback
void otBackboneRouterSetDomainPrefixCallback( otInstance *aInstance, otBackboneRouterDomainPrefixCallback aCallback, void *aContext )
Legt den Callback des Domain-Präfixes für den Backbone-Router fest.
Details | |||||||
---|---|---|---|---|---|---|---|
Parameter |
|
otBackboneRouterSetEnabled
void otBackboneRouterSetEnabled( otInstance *aInstance, bool aEnable )
Aktiviert oder deaktiviert die Backbone-Funktion.
Wenn diese Option aktiviert ist, wird für das angeschlossene Gerät eine Serverdatenanfragenachricht (SRV_DATA.ntf
) ausgelöst, wenn in den Thread-Netzwerkdaten kein Backbone Router-Dienst vorhanden ist.
Ist die Option deaktiviert, wird SRV_DATA.ntf
ausgelöst, wenn sich der Backbone-Router im primären Zustand befindet.
Verfügbar, wenn OPENTHREAD_CONFIG_BACKBONE_ROUTER_ENABLE
aktiviert ist.
Details | |||||
---|---|---|---|---|---|
Parameter |
|
otBackboneRouterGetState
otBackRouterRouterGetConfig
otBackRouterRouterSetConfig
otBackboneRouterReg
otBackboneRouterSetMulticastListenerCallback
void otBackboneRouterSetMulticastListenerCallback( otInstance *aInstance, otBackboneRouterMulticastListenerCallback aCallback, void *aContext )
Legt den Backcast Router-Multicast-Listener-Callback fest.
Details | |||||||
---|---|---|---|---|---|---|---|
Parameter |
|
otBackboneRouterSetNdProxyCallback
void otBackboneRouterSetNdProxyCallback( otInstance *aInstance, otBackboneRouterNdProxyCallback aCallback, void *aContext )
Legt den ND Proxy-Callback des Backbone-Routers fest.
Details | |||||||
---|---|---|---|---|---|---|---|
Parameter |
|
OTBackboneRouterSetRegistrierung
void otBackboneRouterSetRegistrationJitter( otInstance *aInstance, uint8_t aJitter )
Legt den Wert für den Registrierungs-Jitter für den Backbone fest.
Details | |||
---|---|---|---|
Parameter |
|
otBackboneRouterGetRegistrationJitter
Makros
OT_BACKBONE_ROUTER_MULTICAST_LISTENER_ITERATOR_INIT;
OT_BACKBONE_ROUTER_MULTICAST_LISTENER_ITERATOR_INIT 0
Initialisierer für otBackboneRouterMulticastListenerIterator.
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.