Router backbone

Questo modulo include le funzioni del servizio 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 relativi al 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 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.

Typedef

otBackboneRouterConfig typedef
Questa struttura rappresenta la configurazione del router backbone.
otBackboneRouterDomainPrefixCallback)(void *aContext, otBackboneRouterDomainPrefixEvent aEvent, const otIp6Prefix *aDomainPrefix) typedef
void(*
Questo puntatore di funzione viene chiamato ogni volta che il prefisso del dominio viene modificato.
otBackboneRouterMulticastListenerCallback)(void *aContext, otBackboneRouterMulticastListenerEvent aEvent, const otIp6Address *aAddress) typedef
void(*
Questo puntatore alla funzione viene chiamato ogni volta che i listener multicast cambiano.
otBackboneRouterMulticastListenerInfo typedef
Questa struttura rappresenta le informazioni di un listener multicast del router backbone.
otBackboneRouterMulticastListenerIterator typedef
uint16_t
Utilizzato per eseguire iterazioni tramite listener multicast.
otBackboneRouterNdProxyCallback)(void *aContext, otBackboneRouterNdProxyEvent aEvent, const otIp6Address *aDua) typedef
void(*
Questo puntatore di funzione viene chiamato ogni volta che il proxy Nd viene 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 registrazione DUA successiva.
otBackboneRouterConfigNextMulticastListenerRegistrationResponse(otInstance *aInstance, uint8_t aStatus)
void
Questo metodo configura lo stato della risposta per la prossima registrazione dell'ascoltatore multicast.
otBackboneRouterGetConfig(otInstance *aInstance, otBackboneRouterConfig *aConfig)
void
Questa funzione ottiene la configurazione del router backbone locale.
otBackboneRouterGetDomainPrefix(otInstance *aInstance, otBorderRouterConfig *aConfig)
Questo metodo ottiene la configurazione del prefisso di dominio locale.
otBackboneRouterGetNdProxyInfo(otInstance *aInstance, const otIp6Address *aDua, otBackboneRouterNdProxyInfo *aNdProxyInfo)
Questo metodo recupera le informazioni del proxy ND del router backbone.
otBackboneRouterGetPrimary(otInstance *aInstance, otBackboneRouterConfig *aConfig)
Questa funzione consente di recuperare le informazioni del router backbone principale nella rete di thread.
otBackboneRouterGetRegistrationJitter(otInstance *aInstance)
uint8_t
Questo metodo restituisce il valore di tremolio della registrazione del router backbone.
otBackboneRouterGetState(otInstance *aInstance)
Questa funzione acquisisce lo stato del router backbone.
otBackboneRouterMulticastListenerAdd(otInstance *aInstance, const otIp6Address *aAddress, uint32_t aTimeout)
Questo metodo aggiunge un listener multicast.
otBackboneRouterMulticastListenerClear(otInstance *aInstance)
void
Questo metodo cancella i listener multicast.
otBackboneRouterMulticastListenerGetNext(otInstance *aInstance, otBackboneRouterMulticastListenerIterator *aIterator, otBackboneRouterMulticastListenerInfo *aListenerInfo)
Questa funzione consente di ottenere le informazioni successive sull'ascoltatore multicast (utilizzando un iteratore).
otBackboneRouterRegister(otInstance *aInstance)
Questa funzione registra esplicitamente la configurazione del router backbone locale.
otBackboneRouterSetConfig(otInstance *aInstance, const otBackboneRouterConfig *aConfig)
Questa funzione imposta la configurazione del router backbone locale.
otBackboneRouterSetDomainPrefixCallback(otInstance *aInstance, otBackboneRouterDomainPrefixCallback aCallback, void *aContext)
void
Questo metodo imposta il callback del prefisso del dominio del router backbone.
otBackboneRouterSetEnabled(otInstance *aInstance, bool aEnable)
void
Questa funzione attiva o disattiva la funzionalità backbone.
otBackboneRouterSetMulticastListenerCallback(otInstance *aInstance, otBackboneRouterMulticastListenerCallback aCallback, void *aContext)
void
Questo metodo imposta il callback dell'ascoltatore multicast del router backbone.
otBackboneRouterSetNdProxyCallback(otInstance *aInstance, otBackboneRouterNdProxyCallback aCallback, void *aContext)
void
Questo metodo imposta il callback Proxy ND del router backbone.
otBackboneRouterSetRegistrationJitter(otInstance *aInstance, uint8_t aJitter)
void
Questo metodo imposta il valore del jitter di registrazione del router backbone.

Punti ristoro

otBackboneRouterConfig

Questa struttura rappresenta la configurazione del router backbone.

otBackboneRouterMulticastListenerInfo

Questa struttura rappresenta le informazioni di un listener multicast del router backbone.

otBackboneRouterNdProxyInfo

Rappresenta le informazioni del proxy ND del router backbone.

Enumerazioni

otBackboneRouterDomainPrefixEvent

 otBackboneRouterDomainPrefixEvent

Rappresenta gli eventi relativi al prefisso di dominio.

Proprietà
OT_BACKBONE_ROUTER_DOMAIN_PREFIX_ADDED

Il prefisso del dominio è stato aggiunto.

OT_BACKBONE_ROUTER_DOMAIN_PREFIX_CHANGED

Il prefisso del dominio è stato modificato.

OT_BACKBONE_ROUTER_DOMAIN_PREFIX_REMOVED

Il prefisso del dominio è stato rimosso.

otBackboneRouterMulticastListenerEvent

 otBackboneRouterMulticastListenerEvent

Rappresenta gli eventi Listener multicast.

Proprietà
OT_BACKBONE_ROUTER_MULTICAST_LISTENER_ADDED

Listener multicast aggiunto.

OT_BACKBONE_ROUTER_MULTICAST_LISTENER_REMOVED

Listener multicast rimosso o scaduto.

otBackboneRouterNdProxyEvent

 otBackboneRouterNdProxyEvent

Rappresenta gli eventi 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

Funzione backbone disabilitata.

OT_BACKBONE_ROUTER_STATE_PRIMARY

Il router backbone principale.

OT_BACKBONE_ROUTER_STATE_SECONDARY

Router backbone secondario.

Typedef

otBackboneRouterConfig

struct otBackboneRouterConfig otBackboneRouterConfig

Questa struttura rappresenta la configurazione del router backbone.

otBackboneRouterDomainPrefixCallback

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

Questo puntatore di funzione viene chiamato ogni volta che il prefisso del dominio viene modificato.

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

otBackboneRouterMulticastListenerCallback

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

Questo puntatore alla funzione viene chiamato ogni volta che i listener multicast cambiano.

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

otBackboneRouterMulticastListenerInfo

struct otBackboneRouterMulticastListenerInfo otBackboneRouterMulticastListenerInfo

Questa struttura rappresenta le informazioni di un listener multicast del router backbone.

otBackboneRouterMulticastListenerIterator

uint16_t otBackboneRouterMulticastListenerIterator

Utilizzato per eseguire iterazioni tramite listener multicast.

otBackboneRouterNdProxyCallback

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

Questo puntatore di funzione viene chiamato ogni volta che il proxy Nd viene modificato.

Dettagli
Parametri
[in] aContext
Il puntatore del contesto 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.

Functions

otBackboneRouterConfigNextDuaRegistrationResponse

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

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

Nota: disponibile solo quando OPENTHREAD_CONFIG_REFERENCE_DEVICE_ENABLE è attivo. Utilizzato solo per il test e la certificazione.

DA FARE: (DUA) supporta il codice di errore coap e la relativa procedura ai fini della 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 qualsiasi valore DUA.req. In caso contrario, rispondi solo a quello con aMlIid corrispondente.
[in] aStatus
Lo stato per rispondere.

otBackboneRouterConfigNextMulticastListenerEnrollmentResponse

void otBackboneRouterConfigNextMulticastListenerRegistrationResponse(
  otInstance *aInstance,
  uint8_t aStatus
)

Questo metodo configura lo stato della risposta per la prossima registrazione dell'ascoltatore multicast.

Nota: disponibile solo quando OPENTHREAD_CONFIG_REFERENCE_DEVICE_ENABLE è attivo. Utilizzato solo per il test e la certificazione.

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

otBackboneRouterGetConfig

void otBackboneRouterGetConfig(
  otInstance *aInstance,
  otBackboneRouterConfig *aConfig
)

Questa funzione ottiene la configurazione del router backbone locale.

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

otBackboneRouterGetDomainPrefix

otError otBackboneRouterGetDomainPrefix(
  otInstance *aInstance,
  otBorderRouterConfig *aConfig
)

Questo metodo ottiene la configurazione del prefisso di dominio locale.

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

otBackboneRouterGetNdProxyInfo

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

Questo metodo recupera le informazioni del proxy ND del router backbone.

Dettagli
Parametri
[in] aInstance
Un puntatore a un'istanza OpenThread.
[in] aDua
L'indirizzo Unicast.
[out] aNdProxyInfo
Un puntatore alle informazioni proxy ND.
Valori restituiti
OT_ERROR_NONE
Recupero informazioni proxy ND riuscito.
OT_ERROR_NOT_FOUND
Impossibile trovare l'indirizzo Domain Unicast nella tabella Proxy ND.

otBackboneRouterGetPrincipale

otError otBackboneRouterGetPrimary(
  otInstance *aInstance,
  otBackboneRouterConfig *aConfig
)

Questa funzione consente di recuperare le informazioni del router backbone principale nella rete di thread.

Dettagli
Parametri
[in] aInstance
Un puntatore a un'istanza OpenThread.
[out] aConfig
Un link a dove inserire le informazioni del router backbone principale.
Valori restituiti
OT_ERROR_NONE
Recupero delle informazioni sul router backbone principale riuscito.
OT_ERROR_NOT_FOUND
Non esiste un router backbone principale.

otBackboneRouterGetRegistrationJitter

uint8_t otBackboneRouterGetRegistrationJitter(
  otInstance *aInstance
)

Questo metodo restituisce il valore di tremolio della registrazione del router backbone.

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

otBackboneRouterGetState

otBackboneRouterState otBackboneRouterGetState(
  otInstance *aInstance
)

Questa funzione acquisisce lo stato del router backbone.

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

otBackboneRouterMulticastListenerAdd

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

Questo metodo aggiunge un listener multicast.

Nota: disponibile solo quando OPENTHREAD_CONFIG_REFERENCE_DEVICE_ENABLE è attivo. Utilizzato solo per il test e la certificazione.

Dettagli
Parametri
[in] aInstance
Un puntatore a un'istanza OpenThread.
[in] aAddress
L'indirizzo del 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 correttamente.
OT_ERROR_INVALID_ARGS
Se l'indirizzo del listener multicast non era valido.
OT_ERROR_NO_BUFS
Nessuno spazio disponibile per salvare il multicast Listener.
Vedi anche:
otBackboneRouterMulticastListenerClear
otBackboneRouterMulticastListenerGetNext

otBackboneRouterMulticastListenerClear

void otBackboneRouterMulticastListenerClear(
  otInstance *aInstance
)

Questo metodo cancella i listener multicast.

Nota: disponibile solo quando OPENTHREAD_CONFIG_REFERENCE_DEVICE_ENABLE è attivo. Utilizzato solo per il test e la certificazione.

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 consente di ottenere le informazioni successive sull'ascoltatore 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 rimandare al listener multicast successivo. Per ottenere la prima voce, l'iteratore deve essere impostato su OT_BACKBONE_ROUTER_MULTICAST_LISTENER_ITERATOR_INIT.
[out] aListenerInfo
Un puntatore a un otBackboneRouterMulticastListenerInfo in cui vengono posizionate le informazioni del listener multicast successivo (in caso di esito positivo).
Valori restituiti
OT_ERROR_NONE
Sono state trovate le informazioni sul listener multicast successivo (aListenerInfo è stato aggiornato).
OT_ERROR_NOT_FOUND
Non sono state trovate informazioni successive dell'ascoltatore multicast.
Vedi anche:
otBackboneRouterMulticastListenerClear
otBackboneRouterMulticastListenerAdd

otBackboneRouterRegistra

otError otBackboneRouterRegister(
  otInstance *aInstance
)

Questa funzione registra esplicitamente la configurazione del router backbone locale.

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
Hai accodato correttamente un messaggio Richiesta dati server per il recapito.
Vedi anche:
otBackboneRouterSetEnabled
otBackboneRouterGetState
otBackboneRouterGetConfig
otBackboneRouterSetConfig

otBackboneRouterSetConfig

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

Questa funzione imposta la configurazione del router backbone locale.

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
otBackboneRouterRegistra

otBackboneRouterSetDomainPrefixCallback

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

Questo metodo imposta il callback del prefisso del dominio del router backbone.

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

Questa funzione attiva o disattiva la funzionalità backbone.

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

otBackboneRouterSetMulticastListenerCallback

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

Questo metodo imposta il callback dell'ascoltatore multicast del router backbone.

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

otBackboneRouterSetNdProxyCallback

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

Questo metodo imposta il callback Proxy ND del router backbone.

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

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 ulteriori informazioni, o per contribuire alla nostra documentazione, consulta la pagina Risorse.