Mantieni tutto organizzato con le raccolte Salva e classifica i contenuti in base alle tue preferenze.

Router backbone

Questo modulo include funzioni per il servizio OpenThread Backbone Router.

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 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.

Defin

otBackboneRouterConfig Typedef
Questa struttura rappresenta la configurazione del router backbone.
otBackboneRouterDomainPrefixCallback)(void *aContext, otBackboneRouterDomainPrefixEvent aEvent, const otIp6Prefix *aDomainPrefix) Typedef
void(*
Il puntatore della funzione viene richiamato ogni volta che il prefisso del dominio è cambiato.
otBackboneRouterMulticastListenerCallback)(void *aContext, otBackboneRouterMulticastListenerEvent aEvent, const otIp6Address *aAddress) Typedef
void(*
Il puntatore della funzione viene richiamato ogni volta che i listener multicast cambiano.
otBackboneRouterMulticastListenerInfo Typedef
Questa struttura rappresenta un'informazione relativa al listener multicast del router backbone.
otBackboneRouterMulticastListenerIterator Typedef
uint16_t
Utilizzato per eseguire l'iterazione tramite i listener multicast.
otBackboneRouterNdProxyCallback)(void *aContext, otBackboneRouterNdProxyEvent aEvent, const otIp6Address *aDua) Typedef
void(*
Questo puntatore di funzione viene richiamato ogni volta che il proxy Nd è stato modificato.
otBackboneRouterNdProxyInfo Typedef
Rappresenta le informazioni del proxy ND del router Backbone.

Functions

otBackboneRouterConfigNextDuaRegistrationResponse(otInstance *aInstance, const otIp6InterfaceIdentifier *aMlIid, uint8_t aStatus)
void
Questo metodo 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 successiva registrazione del listener multicast.
otBackboneRouterGetConfig(otInstance *aInstance, otBackboneRouterConfig *aConfig)
void
Recupera la configurazione del router backbone locale.
otBackboneRouterGetDomainPrefix(otInstance *aInstance, otBorderRouterConfig *aConfig)
Questo metodo restituisce la configurazione del prefisso del dominio locale.
otBackboneRouterGetNdProxyInfo(otInstance *aInstance, const otIp6Address *aDua, otBackboneRouterNdProxyInfo *aNdProxyInfo)
Questo metodo riceve le informazioni del proxy ND del router Backbone.
otBackboneRouterGetPrimary(otInstance *aInstance, otBackboneRouterConfig *aConfig)
Questa funzione riceve le informazioni del router backbone principale nella rete Thread.
otBackboneRouterGetRegistrationJitter(otInstance *aInstance)
uint8_t
Questo metodo restituisce il valore del 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)
Questa funzione riceve le successive informazioni sul listener 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
Questo metodo imposta il callback Prefisso dominio router Backbone.
otBackboneRouterSetEnabled(otInstance *aInstance, bool aEnable)
void
Attiva o disattiva la funzionalità backbone.
otBackboneRouterSetMulticastListenerCallback(otInstance *aInstance, otBackboneRouterMulticastListenerCallback aCallback, void *aContext)
void
Questo metodo imposta il callback listener multicast del router backbone.
otBackboneRouterSetNdProxyCallback(otInstance *aInstance, otBackboneRouterNdProxyCallback aCallback, void *aContext)
void
Questo metodo imposta il callback Proxy ND router Backbone.
otBackboneRouterSetRegistrationJitter(otInstance *aInstance, uint8_t aJitter)
void
Questo metodo imposta il valore del jitter di registrazione del router backbone.

Struttura

OtBackboneRouterConfig

Questa struttura rappresenta la configurazione del router backbone.

otBackboneRouterMulticastListenerInfo

Questa struttura rappresenta un'informazione relativa al listener multicast del router backbone.

otBackboneRouterNdProxyInfo

Rappresenta le informazioni del proxy ND del router Backbone.

Enumerazioni

otBackboneRouterDomainPrefixEvent

 otBackboneRouterDomainPrefixEvent

Rappresenta gli eventi del prefisso di dominio.

Proprietà
OT_BACKBONE_ROUTER_DOMAIN_PREFIX_ADDED

Prefisso dominio è stato aggiunto.

OT_BACKBONE_ROUTER_DOMAIN_PREFIX_CHANGED

Il prefisso del dominio è stato modificato.

OT_BACKBONE_ROUTER_DOMAIN_PREFIX_REMOVED

Il prefisso di dominio è stato rimosso.

otBackboneRouterMulticastListenerEvent

 otBackboneRouterMulticastListenerEvent

Rappresenta gli eventi listener multicast.

Proprietà
OT_BACKBONE_ROUTER_MULTICAST_LISTENER_ADDED

ascoltatore multicast aggiunto.

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 backbone è disabilitata.

OT_BACKBONE_ROUTER_STATE_PRIMARY

Il router backbone principale.

OT_BACKBONE_ROUTER_STATE_SECONDARY

Router secondario di backbone.

Defin

otBackboneRouterConfig

struct otBackboneRouterConfig otBackboneRouterConfig

Questa struttura rappresenta la configurazione del router backbone.

otBackboneRouterDomainPrefixCallback

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

Il puntatore della funzione viene richiamato ogni volta che il prefisso del dominio è cambiato.

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

otBackboneRouterMulticastListenerCallback

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

Il puntatore della funzione viene richiamato ogni volta che i listener 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.

otBackboneRouterMulticastListenerInfo

struct otBackboneRouterMulticastListenerInfo otBackboneRouterMulticastListenerInfo

Questa struttura rappresenta un'informazione relativa al listener multicast del router backbone.

otBackboneRouterMulticastListenerIterator

uint16_t otBackboneRouterMulticastListenerIterator

Utilizzato per eseguire l'iterazione tramite i listener multicast.

otBackboneRouterNdProxyCallback

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

Questo puntatore di funzione viene richiamato ogni volta che il proxy Nd è stato 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 oppure nullptr se aEvent è OT_BACKBONE_ROUTER_NDPROXY_CLEARED.

otBackboneRouterNdProxyInfo

struct otBackboneRouterNdProxyInfo otBackboneRouterNdProxyInfo

Rappresenta le informazioni del proxy ND del router Backbone.

Functions

otBackboneRouterConfigNextDuaRegistrationResponse

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

Questo metodo configura lo stato della risposta per la prossima registrazione del DUA.

Nota: disponibile solo quando OPENTHREAD_CONFIG_REFERENCE_DEVICE_ENABLE è attivato. Utilizzato solo per test e certificazione.

DA FARE. (DUA) supportano il codice di errore relativo al Coap e la procedura corrispondente a scopo di certificazione.

Dettagli
Parametri
[in] aInstance
Un puntatore a un'istanza OpenThread.
[in] aMlIid
Un puntatore all'IID locale di mesh. Se NULL, rispondi con aStatus per eventuali DUA.req in arrivo, altrimenti rispondi solo a quello con aMlIid corrispondente.
[in] aStatus
Lo stato a cui vuoi rispondere.

otBackboneRouterConfigNextMulticastListenerRegistrationResponse

void otBackboneRouterConfigNextMulticastListenerRegistrationResponse(
  otInstance *aInstance,
  uint8_t aStatus
)

Consente di configurare lo stato della risposta per la successiva registrazione del 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 a un'istanza OpenThread.
[in] aStatus
Lo stato a cui vuoi rispondere.

otBackboneRouterGetConfig

void otBackboneRouterGetConfig(
  otInstance *aInstance,
  otBackboneRouterConfig *aConfig
)

Recupera la configurazione del router backbone locale.

Disponibile quando OPENTHREAD_CONFIG_BACKBONE_ROUTER_ENABLE è attivato.

Dettagli
Parametri
[in] aInstance
Un puntatore a un'istanza OpenThread.
[out] aConfig
Un puntatore dove inserire la configurazione del router backbone locale.
Vedi anche:
otBackboneRouterSetEnabled
otBackboneRouterGetState
otBackboneRouterSetConfig
otBackboneRouterRegister

otBackboneRouterGetDomainPrefix

otError otBackboneRouterGetDomainPrefix(
  otInstance *aInstance,
  otBorderRouterConfig *aConfig
)

Questo metodo restituisce la configurazione del prefisso del dominio locale.

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

otBackboneRouterGetNdProxyInfo

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

Questo metodo riceve le informazioni del proxy ND del router Backbone.

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

otBackboneRouterGetPrimary

otError otBackboneRouterGetPrimary(
  otInstance *aInstance,
  otBackboneRouterConfig *aConfig
)

Questa funzione riceve le informazioni del router backbone principale nella rete Thread.

Dettagli
Parametri
[in] aInstance
Un puntatore a un'istanza OpenThread.
[out] aConfig
Un puntatore su dove inserire le informazioni del router backbone principale.
Valori restituiti
OT_ERROR_NONE
Informazioni sul router backbone principale ricevute.
OT_ERROR_NOT_FOUND
Non esiste alcun router backbone principale.

otBackboneRouterGetRegistrationJitter

uint8_t otBackboneRouterGetRegistrationJitter(
  otInstance *aInstance
)

Questo metodo restituisce il valore del jitter di registrazione del router Backbone.

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

otBackboneRouterGetState

otBackboneRouterState otBackboneRouterGetState(
  otInstance *aInstance
)

Recupera il router backbone otBackboneRouterState.

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

otBackboneRouterMulticastListenerAdd

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 a un'istanza OpenThread.
[in] aAddress
L'indirizzo multicast listener.
[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:
otBackboneRouterMulticastListenerClear
otBackboneRouterMulticastListenerGetNext

otBackboneRouterMulticastListenerClear

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 a un'istanza OpenThread.
Vedi anche:
otBackboneRouterMulticastListenerAdd
otBackboneRouterMulticastListenerGetNext

otBackboneRouterMulticastListenerGetNext

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

Questa funzione riceve le successive informazioni sul listener multicast (utilizzando un iteratore).

Dettagli
Parametri
[in] aInstance
Un puntatore a 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 a 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
Non sono state trovate informazioni successive sul listener multicast.
Vedi anche:
otBackboneRouterMulticastListenerClear
otBackboneRouterMulticastListenerAdd

otBackboneRouterRegister

otError otBackboneRouterRegister(
  otInstance *aInstance
)

Registra esplicitamente la configurazione del router backbone locale.

Un messaggio di richiesta dati del server SRV_DATA.ntf viene attivato per il dispositivo associato.

Disponibile quando OPENTHREAD_CONFIG_BACKBONE_ROUTER_ENABLE è attivato.

Dettagli
Parametri
[in] aInstance
Un puntatore a un'istanza OpenThread.
Valori restituiti
OT_ERROR_NO_BUFS
Spazio insufficiente per aggiungere il servizio router backbone.
OT_ERROR_NONE
Un messaggio di richiesta dati server è stato messo in coda per la consegna.
Vedi anche:
otBackboneRouterSetEnabled
otBackboneRouterGetState
otBackboneRouterGetConfig
otBackboneRouterSetConfig

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 backbone principale.

Disponibile quando OPENTHREAD_CONFIG_BACKBONE_ROUTER_ENABLE è attivato.

Dettagli
Parametri
[in] aInstance
Un puntatore a 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
)

Questo metodo imposta il callback Prefisso dominio router Backbone.

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

otBackboneRouterSetEnabled

void otBackboneRouterSetEnabled(
  otInstance *aInstance,
  bool aEnable
)

Attiva o disattiva la funzionalità backbone.

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

Se disabilitato, SRV_DATA.ntf viene attivato se il router backbone è in stato primario.

Disponibile quando OPENTHREAD_CONFIG_BACKBONE_ROUTER_ENABLE è attivato.

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

otBackboneRouterSetMulticastListenerCallback

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

Questo metodo imposta il callback listener multicast del router backbone.

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

otBackboneRouterSetNdProxyCallback

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

Questo metodo imposta il callback Proxy ND router Backbone.

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

otBackboneRouterSetRegistrationJitter

void otBackboneRouterSetRegistrationJitter(
  otInstance *aInstance,
  uint8_t aJitter
)

Questo metodo imposta il valore del jitter di registrazione del router backbone.

Dettagli
Parametri
[in] aJitter
il valore del 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 otBackboneRouterMulticastListenerIterator.

Risorse

Gli argomenti di riferimento dell'API OpenThread provengono dal codice sorgente, disponibile su GitHub. Per scoprire di più o per contribuire alla nostra documentazione, consulta le Risorse.