Router backbone

Questo modulo include funzioni per il servizio OpenThread Backbone Router.

Sommario

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 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 `struct otBackboneRouterConfig` Questa struttura rappresenta la configurazione del router backbone.
`otBackboneRouterDomainPrefixCallback )(void aContext, otBackboneRouterDomainPrefixEvent aEvent, const otIp6Prefix aDomainPrefix)`	typedef `void(*` Questo puntatore a funzione viene chiamato ogni volta che cambia il prefisso del dominio.
`otBackboneRouterMulticastListenerCallback )(void aContext, otBackboneRouterMulticastListenerEvent aEvent, const otIp6Address aAddress)`	typedef `void(*` Questo puntatore a funzione viene chiamato ogni volta che cambiano i listener multicast.
`otBackboneRouterMulticastListenerInfo`	typedef `struct otBackboneRouterMulticastListenerInfo` Questa struttura rappresenta le informazioni sul listener multicast del router backbone.
`otBackboneRouterMulticastListenerIterator`	typedef `uint16_t` Utilizzato per scorrere i listener multicast.
`otBackboneRouterNdProxyCallback )(void aContext, otBackboneRouterNdProxyEvent aEvent, const otIp6Address aDua)`	typedef `void(*` Questo puntatore a funzione viene chiamato ogni volta che viene modificato il proxy Nd.

Funzioni
`otBackboneRouterConfigNextDuaRegistrationResponse ( otInstance aInstance, const otIp6InterfaceIdentifier aMlIid, uint8_t aStatus)`	`void` Questo metodo configura lo stato della risposta per la successiva registrazione DUA.
`otBackboneRouterConfigNextMulticastListenerRegistrationResponse ( otInstance *aInstance, uint8_t aStatus)`	`void` Questo metodo configura lo stato della risposta per la successiva registrazione del listener multicast.
`otBackboneRouterGetConfig ( otInstance aInstance, otBackboneRouterConfig aConfig)`	`void` Questa funzione ottiene la configurazione del router backbone locale.
`otBackboneRouterGetDomainPrefix ( otInstance aInstance, otBorderRouterConfig aConfig)`	`otError` Questo metodo ottiene la configurazione del prefisso di dominio locale.
`otBackboneRouterGetNdProxyInfo ( otInstance aInstance, const otIp6Address aDua,otBackboneRouterNdProxyInfo *aNdProxyInfo)`	`otError` Questo metodo ottiene le informazioni sul proxy ND del router backbone.
`otBackboneRouterGetPrimary ( otInstance aInstance, otBackboneRouterConfig aConfig)`	`otError` Questa funzione ottiene le informazioni sul router backbone primario nella rete thread.
`otBackboneRouterGetRegistrationJitter ( otInstance *aInstance)`	`uint8_t` Questo metodo restituisce il valore di jitter di registrazione del router backbone.
`otBackboneRouterGetState ( otInstance *aInstance)`	`otBackboneRouterState` Questa funzione ottiene lo stato Backbone Router.
`otBackboneRouterMulticastListenerAdd ( otInstance aInstance, const otIp6Address aAddress, uint32_t aTimeout)`	`otError` Questo metodo aggiunge un listener multicast.
`otBackboneRouterMulticastListenerClear ( otInstance *aInstance)`	`void` Questo metodo cancella gli ascoltatori multicast.
`otBackboneRouterMulticastListenerGetNext ( otInstance aInstance, otBackboneRouterMulticastListenerIterator aIterator, otBackboneRouterMulticastListenerInfo *aListenerInfo)`	`otError` Questa funzione ottiene le successive informazioni sul listener multicast (utilizzando un iteratore).
`otBackboneRouterRegister ( otInstance *aInstance)`	`otError` Questa funzione registra esplicitamente la configurazione del router backbone locale.
`otBackboneRouterSetConfig ( otInstance aInstance, const otBackboneRouterConfig aConfig)`	`otError` Questa funzione imposta la configurazione del router backbone locale.
`otBackboneRouterSetDomainPrefixCallback ( otInstance aInstance, otBackboneRouterDomainPrefixCallback aCallback, void aContext)`	`void` Questo metodo imposta il callback del prefisso di dominio del router backbone.
`otBackboneRouterSetEnabled ( otInstance *aInstance, bool aEnable)`	`void` Questa funzione abilita o disabilita la funzionalità Backbone.
`otBackboneRouterSetMulticastListenerCallback ( otInstance aInstance, otBackboneRouterMulticastListenerCallback aCallback, void aContext)`	`void` Questo metodo imposta la richiamata del listener multicast del router backbone.
`otBackboneRouterSetNdProxyCallback ( otInstance aInstance, otBackboneRouterNdProxyCallback aCallback, void aContext)`	`void` Questo metodo imposta la richiamata del proxy ND del router backbone.
`otBackboneRouterSetRegistrationJitter ( otInstance *aInstance, uint8_t aJitter)`	`void` Questo metodo imposta il valore di jitter di registrazione del router backbone.

Structs
otBackboneRouterConfig	Questa struttura rappresenta la configurazione del router backbone.
otBackboneRouterMulticastListenerInfo	Questa struttura rappresenta le informazioni sul listener multicast del router backbone.
otBackboneRouterNdProxyInfo	Rappresenta le informazioni sul proxy ND del router backbone.

Enumerazioni

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 del dominio è stato modificato.
`OT_BACKBONE_ROUTER_DOMAIN_PREFIX_REMOVED`	Il prefisso del dominio è stato rimosso.

otBackboneRouterMulticastListenerEvent

 otBackboneRouterMulticastListenerEvent

Rappresenta gli eventi del listener multicast.

Proprietà
`OT_BACKBONE_ROUTER_MULTICAST_LISTENER_ADDED`	Multicast Listener è stato aggiunto.
`OT_BACKBONE_ROUTER_MULTICAST_LISTENER_REMOVED`	Il listener multicast è stato rimosso o è scaduto.

otBackboneRouterNdProxyEvent

 otBackboneRouterNdProxyEvent

Rappresenta gli eventi proxy ND.

Proprietà
`OT_BACKBONE_ROUTER_NDPROXY_ADDED`	È stato aggiunto il proxy ND.
`OT_BACKBONE_ROUTER_NDPROXY_CLEARED`	Tutti i proxy ND sono stati cancellati.
`OT_BACKBONE_ROUTER_NDPROXY_REMOVED`	Proxy ND è stato rimosso.
`OT_BACKBONE_ROUTER_NDPROXY_RENEWED`	ND Proxy è 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 primario.
`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 a funzione viene chiamato ogni volta che cambia il prefisso del dominio.

Dettagli

Parametri

`[in] aContext`	Il puntatore al contesto dell'utente.
`[in] aEvent`	L'evento Domain Prefix.
`[in] aDomainPrefix`	Il nuovo prefisso di dominio se aggiunto o modificato, nullptr in caso contrario.

otBackboneRouterMulticastListenerCallback

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

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

Dettagli

Parametri

`[in] aContext`	Il puntatore al contesto dell'utente.
`[in] aEvent`	L'evento Multicast Listener.
`[in] aAddress`	L'indirizzo multicast Ip6 del Multicast Listener.

otBackboneRouterMulticastListenerInfo

struct otBackboneRouterMulticastListenerInfo otBackboneRouterMulticastListenerInfo

Questa struttura rappresenta le informazioni sul listener multicast del router backbone.

otBackboneRouterMulticastListenerIterator

uint16_t otBackboneRouterMulticastListenerIterator

Utilizzato per scorrere i listener multicast.

otBackboneRouterNdProxyCallback

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

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

Dettagli

Parametri

`[in] aContext`	Il puntatore al 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` .

Funzioni

otBackboneRouterConfigNextDuaRegistrationResponse

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

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

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

TODO: (DUA) supporta il codice di errore coap e il processo corrispondente ai fini della certificazione.

Dettagli

Parametri

`[in] aInstance`	Puntatore a un'istanza di OpenThread.
`[in] aMlIid`	Un puntatore all'IID locale della mesh. Se NULL, rispondi con `aStatus` per qualsiasi DUA.req in arrivo, altrimenti rispondi solo a quello con `aMlIid` corrispondente.
`[in] aStatus`	Lo stato per rispondere.

otBackboneRouterConfigNextMulticastListenerRegistrationResponse

void otBackboneRouterConfigNextMulticastListenerRegistrationResponse(
  otInstance *aInstance,
  uint8_t aStatus
)

Questo metodo configura lo stato della risposta per la successiva registrazione del listener multicast.

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

Dettagli

Parametri

`[in] aInstance`	Puntatore a un'istanza di 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`	Puntatore a un'istanza di OpenThread.
`[out] aConfig`	Un puntatore in cui inserire la configurazione del router backbone locale.

Guarda anche:
otBackboneRouterSetEnabled
otBackboneRouterGetState
otBackboneRouterSetConfig
otBackboneRouterRegister

otBackboneRouterGetDomainPrefix

otError otBackboneRouterGetDomainPrefix(
  otInstance *aInstance,
  otBorderRouterConfig *aConfig
)

Questo metodo ottiene la configurazione del prefisso di dominio locale.

Dettagli

Parametri

`[in] aInstance`	Puntatore a un'istanza di OpenThread.
`[out] aConfig`	Un puntatore alla configurazione del prefisso di dominio.

Valori restituiti

`OT_ERROR_NONE`	Hai ottenuto con successo la configurazione del prefisso di dominio.
`OT_ERROR_NOT_FOUND`	Nessun prefisso di dominio è stato configurato.

otBackboneRouterGetNdProxyInfo

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

Questo metodo ottiene le informazioni sul proxy ND del router backbone.

Dettagli

Parametri

`[in] aInstance`	Puntatore a un'istanza di OpenThread.
`[in] aDua`	L'indirizzo unicast del dominio.
`[out] aNdProxyInfo`	Un puntatore alle informazioni sul proxy ND.

Valori restituiti

`OT_ERROR_NONE`	Ottenuto con successo le informazioni del proxy ND.
`OT_ERROR_NOT_FOUND`	Impossibile trovare l'indirizzo unicast di dominio nella tabella proxy ND.

otBackboneRouterGetPrimary

otError otBackboneRouterGetPrimary(
  otInstance *aInstance,
  otBackboneRouterConfig *aConfig
)

Questa funzione ottiene le informazioni sul router backbone primario nella rete thread.

Dettagli

Parametri

`[in] aInstance`	Puntatore a un'istanza di OpenThread.
`[out] aConfig`	Un puntatore a dove inserire le informazioni sul router backbone primario.

Valori restituiti

`OT_ERROR_NONE`	Informazioni sul router backbone principale ottenute correttamente.
`OT_ERROR_NOT_FOUND`	Non esiste alcun router backbone primario.

otBackboneRouterGetRegistrationJitter

uint8_t otBackboneRouterGetRegistrationJitter(
  otInstance *aInstance
)

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

Dettagli
ritorna	Il valore di jitter di registrazione del router backbone.

Guarda anche:
otBackboneRouterSetRegistrationJitter

otBackboneRouterGetState

otBackboneRouterState otBackboneRouterGetState(
  otInstance *aInstance
)

Questa funzione ottiene lo stato del router backbone.

Dettagli

Parametri

[in] aInstance

Puntatore a un'istanza di OpenThread.

Valori restituiti

`OT_BACKBONE_ROUTER_STATE_DISABLED`	La funzionalità Backbone è disabilitata.
`OT_BACKBONE_ROUTER_STATE_SECONDARY`	Router backbone secondario.
`OT_BACKBONE_ROUTER_STATE_PRIMARY`	Il router backbone primario.

Guarda anche:
otBackboneRouterSetEnabled
otBackboneRouterGetConfig
otBackboneRouterSetConfig
otBackboneRouterRegister

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 è abilitato. Utilizzato solo per test e certificazione.

Dettagli

Parametri

`[in] aInstance`	Puntatore a un'istanza di OpenThread.
`[in] aAddress`	L'indirizzo del listener multicast.
`[in] aTimeout`	Il timeout (in secondi) del Multicast Listener 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.

Guarda anche:
otBackboneRouterMulticastListenerClear
otBackboneRouterMulticastListenerGetNext

otBackboneRouterMulticastListenerClear

void otBackboneRouterMulticastListenerClear(
  otInstance *aInstance
)

Questo metodo cancella gli ascoltatori multicast.

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

Dettagli

Parametri

[in] aInstance

Puntatore a un'istanza di OpenThread.

Guarda anche:
otBackboneRouterMulticastListenerAdd
otBackboneRouterMulticastListenerGetNext

otBackboneRouterMulticastListenerGetNext

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

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

Dettagli

Parametri

`[in] aInstance`	Puntatore a un'istanza di OpenThread.
`[in,out] aIterator`	Un puntatore all'iteratore. In caso di successo, l'iteratore verrà aggiornato in modo da puntare al prossimo Multicast Listener. 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` cui vengono `otBackboneRouterMulticastListenerInfo` informazioni del prossimo Multicast Listener (in caso di successo).

Valori restituiti

`OT_ERROR_NONE`	Trovate con successo le successive informazioni sul listener multicast ( `aListenerInfo` è stato aggiornato con successo).
`OT_ERROR_NOT_FOUND`	Non sono state trovate informazioni successive sul listener multicast.

Guarda anche:
otBackboneRouterMulticastListenerClear
otBackboneRouterMulticastListenerAdd

otBackboneRouterRegister

otError otBackboneRouterRegister(
  otInstance *aInstance
)

Questa funzione registra esplicitamente la configurazione del router backbone locale.

Dettagli

Parametri

[in] aInstance

Puntatore a un'istanza di OpenThread.

Valori restituiti

`OT_ERROR_NO_BUFS`	Spazio insufficiente per aggiungere il servizio Backbone Router.
`OT_ERROR_NONE`	Accodato correttamente un messaggio di richiesta dati server per la consegna.

Guarda 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`	Puntatore a un'istanza di OpenThread.
`[in] aConfig`	Un puntatore alla configurazione del router backbone per avere effetto.

Valori restituiti

`OT_ERROR_NONE`	Configurazione aggiornata con successo.
`OT_ERROR_INVALID_ARGS`	La configurazione in `aConfig` non è valida.

Guarda anche:
otBackboneRouterSetEnabled
otBackboneRouterGetState
otBackboneRouterGetConfig
otBackboneRouterRegister

otBackboneRouterSetDomainPrefixCallback

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

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

Dettagli

Parametri

`[in] aInstance`	Puntatore a un'istanza di OpenThread.
`[in] aCallback`	Un puntatore alla richiamata del prefisso di dominio.
`[in] aContext`	Un puntatore al contesto utente.

otBackboneRouterSetEnabled

void otBackboneRouterSetEnabled(
  otInstance *aInstance,
  bool aEnable
)

Questa funzione abilita o disabilita la funzionalità Backbone.

Dettagli

Parametri

`[in] aInstance`	Puntatore a un'istanza di OpenThread.
`[in] aEnable`	TRUE per abilitare la funzionalità Backbone, FALSE in caso contrario.

Guarda anche:
otBackboneRouterGetState
otBackboneRouterGetConfig
otBackboneRouterSetConfig
otBackboneRouterRegister

otBackboneRouterSetMulticastListenerCallback

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

Questo metodo imposta la richiamata del listener multicast del router backbone.

Dettagli

Parametri

`[in] aInstance`	Puntatore a un'istanza di OpenThread.
`[in] aCallback`	Un puntatore alla richiamata Multicast Listener.
`[in] aContext`	Un puntatore al contesto utente.

otBackboneRouterSetNdProxyCallback

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

Questo metodo imposta la richiamata del proxy ND del router backbone.

Dettagli

Parametri

`[in] aInstance`	Puntatore a un'istanza di OpenThread.
`[in] aCallback`	Puntatore alla richiamata proxy ND.
`[in] aContext`	Un puntatore al contesto utente.

otBackboneRouterSetRegistrationJitter

void otBackboneRouterSetRegistrationJitter(
  otInstance *aInstance,
  uint8_t aJitter
)

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

Dettagli

Parametri

[in] aJitter

il valore di jitter di registrazione del router backbone da impostare.

Guarda anche:
otBackboneRouterGetRegistrationJitter

Macro

OT_BACKBONE_ROUTER_MULTICAST_LISTENER_ITERATOR_INIT

 OT_BACKBONE_ROUTER_MULTICAST_LISTENER_ITERATOR_INIT 0

Inizializzatore per otBackboneRouterMulticastListenerIterator.

Router backbone

Sommario

Enumerazioni

Typedef

Funzioni

Structs

Enumerazioni

otBackboneRouterDomainPrefixEvent

otBackboneRouterMulticastListenerEvent

otBackboneRouterNdProxyEvent

otBackboneRouterState

Typedef

otBackboneRouterConfig

otBackboneRouterDomainPrefixCallback

otBackboneRouterMulticastListenerCallback

otBackboneRouterMulticastListenerInfo

otBackboneRouterMulticastListenerIterator

otBackboneRouterNdProxyCallback

Funzioni

otBackboneRouterConfigNextDuaRegistrationResponse

otBackboneRouterConfigNextMulticastListenerRegistrationResponse

otBackboneRouterGetConfig

otBackboneRouterGetDomainPrefix

otBackboneRouterGetNdProxyInfo

otBackboneRouterGetPrimary

otBackboneRouterGetRegistrationJitter

otBackboneRouterGetState

otBackboneRouterMulticastListenerAdd

otBackboneRouterMulticastListenerClear

otBackboneRouterMulticastListenerGetNext

otBackboneRouterRegister

otBackboneRouterSetConfig

otBackboneRouterSetDomainPrefixCallback

otBackboneRouterSetEnabled

otBackboneRouterSetMulticastListenerCallback

otBackboneRouterSetNdProxyCallback

otBackboneRouterSetRegistrationJitter

Macro

OT_BACKBONE_ROUTER_MULTICAST_LISTENER_ITERATOR_INIT