Router dorsale

Questo modulo include funzioni per il servizio di router Backbone OpenThread.

Riepilogo

Enumerazioni
otBackboneRouterDomainPrefixEvent{
  OT_BACKBONE_ROUTER_DOMAIN_PREFIX_ADDED = 0,
  OT_BACKBONE_ROUTER_DOMAIN_PREFIX_REMOVED = 1,
  OT_BACKBONE_ROUTER_DOMAIN_PREFIX_CHANGED = 2
} 		enum
Rappresenta gli eventi del prefisso di dominio.
otBackboneRouterMulticastListenerEvent{
  OT_BACKBONE_ROUTER_MULTICAST_LISTENER_ADDED = 0,
  OT_BACKBONE_ROUTER_MULTICAST_LISTENER_REMOVED = 1
} 		enum
Rappresenta gli eventi del listener multicast.
otBackboneRouterNdProxyEvent{
  OT_BACKBONE_ROUTER_NDPROXY_ADDED = 0,
  OT_BACKBONE_ROUTER_NDPROXY_REMOVED = 1,
  OT_BACKBONE_ROUTER_NDPROXY_RENEWED = 2,
  OT_BACKBONE_ROUTER_NDPROXY_CLEARED = 3
} 		enum
Rappresenta gli eventi del proxy ND.
otBackboneRouterState{
  OT_BACKBONE_ROUTER_STATE_DISABLED = 0,
  OT_BACKBONE_ROUTER_STATE_SECONDARY = 1,
  OT_BACKBONE_ROUTER_STATE_PRIMARY = 2
} 		enum
Rappresenta lo stato del router Backbone.

Definizione di tipo
otBackboneRouterConfig typedef
Rappresenta la configurazione del router Backbone.
otBackboneRouterDomainPrefixCallback)(void *aContext, otBackboneRouterDomainPrefixEvent aEvent, const otIp6Prefix *aDomainPrefix) typedef
void(*
Il puntatore viene chiamato ogni volta che il prefisso di dominio cambia.
otBackboneRouterMulticastListenerCallback)(void *aContext, otBackboneRouterMulticastListenerEvent aEvent, const otIp6Address *aAddress) typedef
void(*
Il puntatore viene chiamato ogni volta che gli ascoltatori multicast cambiano.
otBackboneRouterMulticastListenerInfo typedef
Rappresenta le informazioni dell'ascoltatore multicast del router Backbone.
otBackboneRouterMulticastListenerIterator typedef
uint16_t
Utilizzato per eseguire l'iterazione tramite gli ascoltatori multicast.
otBackboneRouterNdProxyCallback)(void *aContext, otBackboneRouterNdProxyEvent aEvent, const otIp6Address *aDua) typedef
void(*
Il puntatore viene chiamato ogni volta che il proxy Nd viene modificato.
otBackboneRouterNdProxyInfo typedef
Rappresenta le informazioni del proxy ND del router Backbone.

Funzioni
otBackboneRouterConfigNextDuaRegistrationResponse(otInstance *aInstance, const otIp6InterfaceIdentifier *aMlIid, uint8_t aStatus)
void
Configura lo stato della risposta per la prossima registrazione del DUA.
otBackboneRouterConfigNextMulticastListenerRegistrationResponse(otInstance *aInstance, uint8_t aStatus)
void
Consente di configurare lo stato della risposta per la prossima registrazione dell'ascoltatore multicast.
otBackboneRouterGetConfig(otInstance *aInstance, otBackboneRouterConfig *aConfig)
void
Visualizza la configurazione del router Backbone locale.
otBackboneRouterGetDomainPrefix(otInstance *aInstance, otBorderRouterConfig *aConfig)
Visualizza la configurazione del prefisso di dominio locale.
otBackboneRouterGetNdProxyInfo(otInstance *aInstance, const otIp6Address *aDua, otBackboneRouterNdProxyInfo *aNdProxyInfo)
Recupera le informazioni relative al proxy ND del router Backbone.
otBackboneRouterGetPrimary(otInstance *aInstance, otBackboneRouterConfig *aConfig)
Recupera le informazioni del router principale dorsale nella rete Thread.
otBackboneRouterGetRegistrationJitter(otInstance *aInstance)
uint8_t
Restituisce il valore jitter di registrazione del router Backbone.
otBackboneRouterGetState(otInstance *aInstance)
Recupera il router Backbone otBackboneRouterState.
otBackboneRouterMulticastListenerAdd(otInstance *aInstance, const otIp6Address *aAddress, uint32_t aTimeout)
Aggiunge un listener multicast con un valore di timeout, in secondi.
otBackboneRouterMulticastListenerClear(otInstance *aInstance)
void
Cancella i listener multicast.
otBackboneRouterMulticastListenerGetNext(otInstance *aInstance, otBackboneRouterMulticastListenerIterator *aIterator, otBackboneRouterMulticastListenerInfo *aListenerInfo)
Recupera le informazioni sul prossimo ascolto multicast (utilizzando un iteratore).
otBackboneRouterRegister(otInstance *aInstance)
Registra esplicitamente la configurazione del router Backbone locale.
otBackboneRouterSetConfig(otInstance *aInstance, const otBackboneRouterConfig *aConfig)
Imposta la configurazione del router Backbone locale otBackboneRouterConfig.
otBackboneRouterSetDomainPrefixCallback(otInstance *aInstance, otBackboneRouterDomainPrefixCallback aCallback, void *aContext)
void
Imposta il callback del prefisso di dominio del router Backbone.
otBackboneRouterSetEnabled(otInstance *aInstance, bool aEnable)
void
Attiva o disattiva la funzionalità Backbone.
otBackboneRouterSetMulticastListenerCallback(otInstance *aInstance, otBackboneRouterMulticastListenerCallback aCallback, void *aContext)
void
Imposta il callback listener multicast del router Backbone.
otBackboneRouterSetNdProxyCallback(otInstance *aInstance, otBackboneRouterNdProxyCallback aCallback, void *aContext)
void
Imposta il callback Proxy ND del router Backbone.
otBackboneRouterSetRegistrationJitter(otInstance *aInstance, uint8_t aJitter)
void
Imposta il valore del jitter di registrazione del router Backbone.

Strutture
otBackboneRouterConfig

Rappresenta la configurazione del router Backbone.

otBackboneRouterMulticastAscoltaInfo

Rappresenta le informazioni dell'ascoltatore multicast del router Backbone.

otBackboneRouterNdProxyInfo

Rappresenta le informazioni del proxy ND del router Backbone.

Enumerazioni

Evento otBackboneRouterDomainPrefixEvent

 otBackboneRouterDomainPrefixEvent

Rappresenta gli eventi del prefisso di dominio.

Proprietà
OT_BACKBONE_ROUTER_DOMAIN_PREFIX_ADDED

Il prefisso di dominio è stato aggiunto.

OT_BACKBONE_ROUTER_DOMAIN_PREFIX_CHANGED

Il prefisso di dominio è stato modificato.

OT_BACKBONE_ROUTER_DOMAIN_PREFIX_REMOVED

Il prefisso di dominio è stato rimosso.

Evento otBackboneRouterMulticastAscolta

 otBackboneRouterMulticastListenerEvent

Rappresenta gli eventi del listener multicast.

Proprietà
OT_BACKBONE_ROUTER_MULTICAST_LISTENER_ADDED

È stato aggiunto il listener multicast.

OT_BACKBONE_ROUTER_MULTICAST_LISTENER_REMOVED

Il listener multicast è stato rimosso o è scaduto.

OtBackboneRouterNdProxyEvent

 otBackboneRouterNdProxyEvent

Rappresenta gli eventi del proxy ND.

Proprietà
OT_BACKBONE_ROUTER_NDPROXY_ADDED

Il proxy ND è stato aggiunto.

OT_BACKBONE_ROUTER_NDPROXY_CLEARED

Tutti i proxy ND sono stati cancellati.

OT_BACKBONE_ROUTER_NDPROXY_REMOVED

Il proxy ND è stato rimosso.

OT_BACKBONE_ROUTER_NDPROXY_RENEWED

Il proxy ND è stato rinnovato.

OtBackboneRouterState

 otBackboneRouterState

Rappresenta lo stato del router Backbone.

Proprietà
OT_BACKBONE_ROUTER_STATE_DISABLED

La funzione dorsale è disabilitata.

OT_BACKBONE_ROUTER_STATE_PRIMARY

Il router principale della dorsale.

OT_BACKBONE_ROUTER_STATE_SECONDARY

Router dorsale secondario.

Definizione di tipo

Configurazione otBackboneRouterConfig

struct otBackboneRouterConfig otBackboneRouterConfig

Rappresenta la configurazione del router Backbone.

otBackboneRouterDomainPrefixCallback

void(* otBackboneRouterDomainPrefixCallback)(void *aContext, otBackboneRouterDomainPrefixEvent aEvent, const otIp6Prefix *aDomainPrefix)

Il puntatore viene chiamato ogni volta che il prefisso di dominio cambia.

Dettagli
Parametri
[in] aContext
Il puntatore del contesto dell'utente.
[in] aEvent
L'evento del prefisso di dominio.
[in] aDomainPrefix
Il nuovo prefisso di dominio, se viene aggiunto o modificato, altrimenti viene utilizzato il valore nullptr.

otBackboneRouterMulticastAscoltaCallback

void(* otBackboneRouterMulticastListenerCallback)(void *aContext, otBackboneRouterMulticastListenerEvent aEvent, const otIp6Address *aAddress)

Il puntatore viene chiamato ogni volta che gli ascoltatori multicast cambiano.

Dettagli
Parametri
[in] aContext
Il puntatore del contesto dell'utente.
[in] aEvent
L'evento listener multicast.
[in] aAddress
L'indirizzo multicast IPv6 del listener multicast.

otBackboneRouterMulticastAscoltaInfo

struct otBackboneRouterMulticastListenerInfo otBackboneRouterMulticastListenerInfo

Rappresenta le informazioni dell'ascoltatore multicast del router Backbone.

OtBackboneRouterMulticast listenerIteratore

uint16_t otBackboneRouterMulticastListenerIterator

Utilizzato per eseguire l'iterazione tramite gli ascoltatori multicast.

OtBackboneRouterNdProxyCallback

void(* otBackboneRouterNdProxyCallback)(void *aContext, otBackboneRouterNdProxyEvent aEvent, const otIp6Address *aDua)

Il puntatore viene chiamato ogni volta che il proxy Nd viene modificato.

Dettagli
Parametri
[in] aContext
Il puntatore del contesto dell'utente.
[in] aEvent
L'evento proxy ND.
[in] aDua
L'indirizzo Unicast di dominio del proxy ND o nullptr se aEvent è OT_BACKBONE_ROUTER_NDPROXY_CLEARED.

otBackboneRouterNdProxyInfo

struct otBackboneRouterNdProxyInfo otBackboneRouterNdProxyInfo

Rappresenta le informazioni del proxy ND del router Backbone.

Funzioni

otBackboneRouterConfigNextDuaRegistrationResponse

void otBackboneRouterConfigNextDuaRegistrationResponse(
  otInstance *aInstance,
  const otIp6InterfaceIdentifier *aMlIid,
  uint8_t aStatus
)

Configura lo stato della risposta per la prossima registrazione del DUA.

Nota: disponibile solo quando è abilitata l'opzione OPENTHREAD_CONFIG_REFERENCE_DEVICE_ENABLE. Utilizzata solo per test e certificazione.

DA FARE: il codice di errore coap (DUA) supporta la procedura corrispondente ai fini della certificazione.

Dettagli
Parametri
[in] aInstance
Un puntatore su un'istanza OpenThread.
[in] aMlIid
Un puntatore sullo IID locale mesh. In caso di NULL, rispondi con aStatus per ogni DUA.req disponibile. In caso contrario, rispondi solo a quello con aMlIid corrispondente.
[in] aStatus
Lo stato a cui rispondere.

otBackboneRouterConfigNextMulticastAscoltaRegistrationResponse

void otBackboneRouterConfigNextMulticastListenerRegistrationResponse(
  otInstance *aInstance,
  uint8_t aStatus
)

Consente di configurare lo stato della risposta per la prossima registrazione dell'ascoltatore multicast.

Disponibile quando sono attivati OPENTHREAD_CONFIG_BACKBONE_ROUTER_ENABLE, OPENTHREAD_CONFIG_BACKBONE_ROUTER_MULTICAST_ROUTING_ENABLE e OPENTHREAD_CONFIG_REFERENCE_DEVICE_ENABLE.

Dettagli
Parametri
[in] aInstance
Un puntatore su un'istanza OpenThread.
[in] aStatus
Lo stato a cui rispondere.

otBackboneRouterGetConfig

void otBackboneRouterGetConfig(
  otInstance *aInstance,
  otBackboneRouterConfig *aConfig
)

Visualizza la configurazione del router Backbone locale.

Disponibile quando viene attivata l'opzione OPENTHREAD_CONFIG_BACKBONE_ROUTER_ENABLE.

Dettagli
Parametri
[in] aInstance
Un puntatore su un'istanza OpenThread.
[out] aConfig
Un puntatore in cui inserire la configurazione del router Backbone locale.
Vedi anche:
otBackboneRouterSetEnabled
otBackboneRouterGetState
otBackboneRouterSetConfig
otBackboneRouterregister

otBackboneRouterGetDomainPrefix

otError otBackboneRouterGetDomainPrefix(
  otInstance *aInstance,
  otBorderRouterConfig *aConfig
)

Visualizza la configurazione del prefisso di dominio locale.

Dettagli
Parametri
[in] aInstance
Un puntatore su un'istanza OpenThread.
[out] aConfig
Un puntatore alla configurazione del prefisso di dominio.
Valori restituiti
OT_ERROR_NONE
Configurazione del prefisso di dominio completata.
OT_ERROR_NOT_FOUND
Nessun prefisso di dominio configurato.

otBackboneRouterGetNdProxyInfo

otError otBackboneRouterGetNdProxyInfo(
  otInstance *aInstance,
  const otIp6Address *aDua,
  otBackboneRouterNdProxyInfo *aNdProxyInfo
)

Recupera le informazioni relative al proxy ND del router Backbone.

Dettagli
Parametri
[in] aInstance
Un puntatore su un'istanza OpenThread.
[in] aDua
L'indirizzo del dominio Unicast.
[out] aNdProxyInfo
Un puntatore alle informazioni del proxy ND.
Valori restituiti
OT_ERROR_NONE
Informazioni relative al proxy ND recuperate correttamente.
OT_ERROR_NOT_FOUND
Impossibile trovare l'indirizzo Unicast di dominio nella tabella del proxy ND.

OtBackboneRouterGetEmail

otError otBackboneRouterGetPrimary(
  otInstance *aInstance,
  otBackboneRouterConfig *aConfig
)

Recupera le informazioni del router principale dorsale nella rete Thread.

Dettagli
Parametri
[in] aInstance
Un puntatore su un'istanza OpenThread.
[out] aConfig
Un puntatore su dove inserire le informazioni sul router principale della dorsale.
Valori restituiti
OT_ERROR_NONE
Informazioni relative al router dorsale principale riuscita.
OT_ERROR_NOT_FOUND
Non esiste alcun router dorsale principale.

otBackboneRouterGetRegistrationJitter

uint8_t otBackboneRouterGetRegistrationJitter(
  otInstance *aInstance
)

Restituisce il valore jitter di registrazione del router Backbone.

Dettagli
Restituisce
Il valore del jitter di registrazione del router Backbone.
Vedi anche:
otBackboneRouterSetRegistrationJitter

OtBackboneRouterGetState

otBackboneRouterState otBackboneRouterGetState(
  otInstance *aInstance
)

Recupera il router Backbone otBackboneRouterState.

Dettagli
Parametri
[in] aInstance
Un puntatore su un'istanza OpenThread.
Valori restituiti
OT_BACKBONE_ROUTER_STATE_DISABLED
La funzionalità dorsale è disabilitata.
OT_BACKBONE_ROUTER_STATE_SECONDARY
Router dorsale secondario.
OT_BACKBONE_ROUTER_STATE_PRIMARY
Il router principale della dorsale.
Vedi anche:
otBackboneRouterSetEnabled
otBackboneRouterGetConfig
otBackboneRouterSetConfig
otBackboneRouterregister

otBackboneRouterMulticastAscoltaAggiungi

otError otBackboneRouterMulticastListenerAdd(
  otInstance *aInstance,
  const otIp6Address *aAddress,
  uint32_t aTimeout
)

Aggiunge un listener multicast con un valore di timeout, in secondi.

Passa 0 per utilizzare il timeout MLR predefinito.

Disponibile quando sono attivati OPENTHREAD_CONFIG_BACKBONE_ROUTER_ENABLE, OPENTHREAD_CONFIG_BACKBONE_ROUTER_MULTICAST_ROUTING_ENABLE e OPENTHREAD_CONFIG_REFERENCE_DEVICE_ENABLE.

Dettagli
Parametri
[in] aInstance
Un puntatore su un'istanza OpenThread.
[in] aAddress
L'indirizzo del listener multicast.
[in] aTimeout
Il timeout (in secondi) del listener multicast o 0 per utilizzare il timeout MLR predefinito.
Valori restituiti
OT_ERROR_NONE
Se il listener multicast è stato aggiunto.
OT_ERROR_INVALID_ARGS
Se l'indirizzo del listener multicast non è valido.
OT_ERROR_NO_BUFS
Nessuno spazio disponibile per salvare il listener multicast.
Vedi anche:
otBackboneRouterMulticast listenerClear
otBackboneRouterMulticastAscoltaGetNext

otBackboneRouterMulticastascolta

void otBackboneRouterMulticastListenerClear(
  otInstance *aInstance
)

Cancella i listener multicast.

Disponibile quando sono attivati OPENTHREAD_CONFIG_BACKBONE_ROUTER_ENABLE, OPENTHREAD_CONFIG_BACKBONE_ROUTER_MULTICAST_ROUTING_ENABLE e OPENTHREAD_CONFIG_REFERENCE_DEVICE_ENABLE.

Dettagli
Parametri
[in] aInstance
Un puntatore su un'istanza OpenThread.
Vedi anche:
otBackboneRouterMulticastAscoltaAdd
otBackboneRouterMulticastAscoltaGetNext

otBackboneRouterMulticastAscoltaGetNext

otError otBackboneRouterMulticastListenerGetNext(
  otInstance *aInstance,
  otBackboneRouterMulticastListenerIterator *aIterator,
  otBackboneRouterMulticastListenerInfo *aListenerInfo
)

Recupera le informazioni sul prossimo ascolto multicast (utilizzando un iteratore).

Dettagli
Parametri
[in] aInstance
Un puntatore su un'istanza OpenThread.
[in,out] aIterator
Un puntatore all'iteratore. In caso di esito positivo, l'iteratore verrà aggiornato in modo da puntare al prossimo listener multicast. Per ottenere la prima voce, l'iteratore deve essere impostato su OT_BACKBONE_ROUTER_MULTICAST_LISTENER_ITERATOR_INIT.
[out] aListenerInfo
Un puntatore su un otBackboneRouterMulticastListenerInfo in cui vengono posizionate le informazioni del prossimo listener multicast (in caso di esito positivo).
Valori restituiti
OT_ERROR_NONE
Trovate le successive informazioni sul listener multicast (aListenerInfo aggiornate correttamente).
OT_ERROR_NOT_FOUND
Nessuna informazione successiva sugli ascoltatori multicast trovata.
Vedi anche:
otBackboneRouterMulticast listenerClear
otBackboneRouterMulticastAscoltaAdd

Registrazione otBackboneRouter

otError otBackboneRouterRegister(
  otInstance *aInstance
)

Registra esplicitamente la configurazione del router Backbone locale.

Viene attivato un messaggio di richiesta dei dati del server SRV_DATA.ntf per il dispositivo collegato.

Disponibile quando viene attivata l'opzione OPENTHREAD_CONFIG_BACKBONE_ROUTER_ENABLE.

Dettagli
Parametri
[in] aInstance
Un puntatore su un'istanza OpenThread.
Valori restituiti
OT_ERROR_NO_BUFS
Spazio insufficiente per aggiungere il servizio router Backbone.
OT_ERROR_NONE
È stato messo in coda un messaggio di richiesta di dati del server per il recapito.
Vedi anche:
otBackboneRouterSetEnabled
otBackboneRouterGetState
otBackboneRouterGetConfig
otBackboneRouterSetConfig

Configurazione otBackboneRouterSetConfig

otError otBackboneRouterSetConfig(
  otInstance *aInstance,
  const otBackboneRouterConfig *aConfig
)

Imposta la configurazione del router Backbone locale otBackboneRouterConfig.

Un messaggio di richiesta dei dati del server SRV_DATA.ntf viene avviato automaticamente se il set di dati BBR cambia per il router principale.

Disponibile quando viene attivata l'opzione OPENTHREAD_CONFIG_BACKBONE_ROUTER_ENABLE.

Dettagli
Parametri
[in] aInstance
Un puntatore su un'istanza OpenThread.
[in] aConfig
Un puntatore alla configurazione del router Backbone per diventare effettivo.
Valori restituiti
OT_ERROR_NONE
Configurazione aggiornata.
OT_ERROR_INVALID_ARGS
La configurazione in aConfig non è valida.
Vedi anche:
otBackboneRouterSetEnabled
otBackboneRouterGetState
otBackboneRouterGetConfig
otBackboneRouterregister

otBackboneRouterSetDomainPrefixCallback

void otBackboneRouterSetDomainPrefixCallback(
  otInstance *aInstance,
  otBackboneRouterDomainPrefixCallback aCallback,
  void *aContext
)

Imposta il callback del prefisso di dominio del router Backbone.

Dettagli
Parametri
[in] aInstance
Un puntatore su un'istanza OpenThread.
[in] aCallback
Un puntatore al callback Prefisso dominio.
[in] aContext
Un puntatore al contesto dell'utente.

otBackboneRouterSetEnabled

void otBackboneRouterSetEnabled(
  otInstance *aInstance,
  bool aEnable
)

Attiva o disattiva la funzionalità Backbone.

Se l'opzione è abilitata, viene attivato un messaggio di richiesta dei dati del server SRV_DATA.ntf per il dispositivo collegato se non è presente un servizio di router dorsale nei dati di rete Thread.

Se viene disattivato, SRV_DATA.ntf viene attivato se il router Backbone è in stato Principale.

Disponibile quando viene attivata l'opzione OPENTHREAD_CONFIG_BACKBONE_ROUTER_ENABLE.

Dettagli
Parametri
[in] aInstance
Un puntatore su un'istanza OpenThread.
[in] aEnable
TRUE per abilitare la funzionalità Backbone, FALSE in caso contrario.
Vedi anche:
otBackboneRouterGetState
otBackboneRouterGetConfig
otBackboneRouterSetConfig
otBackboneRouterregister

otBackboneRouterSetMulticastAscoltaCallback

void otBackboneRouterSetMulticastListenerCallback(
  otInstance *aInstance,
  otBackboneRouterMulticastListenerCallback aCallback,
  void *aContext
)

Imposta il callback listener multicast del router Backbone.

Dettagli
Parametri
[in] aInstance
Un puntatore su un'istanza OpenThread.
[in] aCallback
Un puntatore al callback multicast listener.
[in] aContext
Un puntatore al contesto dell'utente.

OtBackboneRouterSetNdProxyCallback

void otBackboneRouterSetNdProxyCallback(
  otInstance *aInstance,
  otBackboneRouterNdProxyCallback aCallback,
  void *aContext
)

Imposta il callback Proxy ND del router Backbone.

Dettagli
Parametri
[in] aInstance
Un puntatore su un'istanza OpenThread.
[in] aCallback
Un puntatore al callback ND Proxy.
[in] aContext
Un puntatore al contesto dell'utente.

otBackboneRouterSetRegistrationJitter

void otBackboneRouterSetRegistrationJitter(
  otInstance *aInstance,
  uint8_t aJitter
)

Imposta il valore del jitter di registrazione del router Backbone.

Dettagli
Parametri
[in] aJitter
il valore jitter di registrazione del router Backbone da impostare.
Vedi anche:
otBackboneRouterGetRegistrationJitter

Macro

OT_BACKBONE_ROUTER_MULTICAST_LISTENER_ITERATOR_INIT

 OT_BACKBONE_ROUTER_MULTICAST_LISTENER_ITERATOR_INIT 0

Inizializzatore per otBackboneRouterMulticast listenerIterator.

Risorse

Gli argomenti di riferimento per l'API OpenThread provengono dal codice sorgente, disponibile su GitHub. Per maggiori informazioni o per contribuire alla nostra documentazione, consulta Risorse.