Agente di confine

Questo modulo include funzioni per il ruolo di agente di confine Thread.

Riepilogo

Enumerazioni
otBorderAgentState{
  OT_BORDER_AGENT_STATE_STOPPED = 0,
  OT_BORDER_AGENT_STATE_STARTED = 1,
  OT_BORDER_AGENT_STATE_ACTIVE = 2
} 		enum
Definisce lo stato dell'agente di confine.

Definizione di tipo
otBorderAgentId typedef
Rappresenta un ID agente di confine.
otBorderAgentState typedef
Definisce lo stato dell'agente di confine.

Variabili
OT_TOOL_PACKED_END

Funzioni
otBorderAgentGetId(otInstance *aInstance, otBorderAgentId *aId)
Recupera l'ID agente di confine generato casualmente.
otBorderAgentGetState(otInstance *aInstance)
Recupera il valore otBorderAgentState del ruolo Agente di confine Thread.
otBorderAgentGetUdpPort(otInstance *aInstance)
uint16_t
Visualizza la porta UDP del servizio Thread Border Agent.
otBorderAgentSetId(otInstance *aInstance, const otBorderAgentId *aId)
Imposta l'ID agente di confine.

Strutture
AgenteAgenteot

Rappresenta un ID agente di confine.

Enumerazioni

OtBorderAgentState

 otBorderAgentState

Definisce lo stato dell'agente di confine.

Proprietà
OT_BORDER_AGENT_STATE_ACTIVE

L'agente di confine è connesso a un commissario esterno.

OT_BORDER_AGENT_STATE_STARTED

L'agente di confine è stato avviato.

OT_BORDER_AGENT_STATE_STOPPED

Il ruolo di agente di confine è disabilitato.

Definizione di tipo

ID agente di confine

struct otBorderAgentId otBorderAgentId

Rappresenta un ID agente di confine.

OtBorderAgentState

enum otBorderAgentState otBorderAgentState

Definisce lo stato dell'agente di confine.

Variabili

OT_TOOL_PACKED_END

OT_TOOL_PACKED_BEGIN struct otBorderAgentId OT_TOOL_PACKED_END

Funzioni

OtBorderAgentGetId

otError otBorderAgentGetId(
  otInstance *aInstance,
  otBorderAgentId *aId
)

Recupera l'ID agente di confine generato casualmente.

L'ID viene salvato nello spazio di archiviazione permanente e rimane in vigore anche dopo i riavvii. Il tipico caso d'uso dell'ID deve essere pubblicato nel servizio mDNS MeshCoP come valore TXT id per consentire al client di identificare questo router/agente di confine.

Dettagli
Parametri
[in] aInstance
Un puntatore su un'istanza OpenThread.
[out] aId
Un puntatore sul buffer per ricevere l'ID.
Valori restituiti
OT_ERROR_NONE
Se l'ID agente di confine è stato recuperato correttamente.
...
Se non è stato possibile recuperare l'ID Border Agent.
Vedi anche:
otBorderAgentSetId

OtBorderAgentGetState

otBorderAgentState otBorderAgentGetState(
  otInstance *aInstance
)

Recupera il valore otBorderAgentState del ruolo Agente di confine Thread.

Dettagli
Parametri
[in] aInstance
Un puntatore su un'istanza OpenThread.
Restituisce
L'attuale otBorderAgentState dell'agente di confine.

OtBorderAgentGetUdpPort

uint16_t otBorderAgentGetUdpPort(
  otInstance *aInstance
)

Visualizza la porta UDP del servizio Thread Border Agent.

Dettagli
Parametri
[in] aInstance
Un puntatore su un'istanza OpenThread.
Restituisce
Porta UDP dell'agente di confine.

ID agente di confine

otError otBorderAgentSetId(
  otInstance *aInstance,
  const otBorderAgentId *aId
)

Imposta l'ID agente di confine.

L'ID dell'agente di confine verrà salvato nell'archiviazione permanente e rimarrà dopo il riavvio. È necessario impostare l'ID solo una volta dopo il ripristino dei dati di fabbrica. Se l'ID non è mai stato impostato chiamando questa funzione, verrà generato un ID casuale che verrà restituito quando verrà richiamato otBorderAgentGetId.

Dettagli
Parametri
[in] aInstance
Un puntatore su un'istanza OpenThread.
[out] aId
Un puntatore sull'ID agente di frontiera.
Valori restituiti
OT_ERROR_NONE
Se l'ID agente di confine è stato impostato correttamente.
...
Se non è stato possibile impostare l'ID agente di confine.
Vedi anche:
otBorderAgentGetId

Macro

OT_BORDER_AGENT_ID_LENGTH

 OT_BORDER_AGENT_ID_LENGTH (16)

La lunghezza dell'agente di confine/ID router in byte.

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.