Agent obramowania

Ten moduł zawiera funkcje roli agenta granicznej wątku.

Podsumowanie

Wyliczenia
otBorderAgentState{
  OT_BORDER_AGENT_STATE_STOPPED = 0,
  OT_BORDER_AGENT_STATE_STARTED = 1,
  OT_BORDER_AGENT_STATE_ACTIVE = 2
} 		enum | typ wyliczeniowy
Określa agenta agenta granicznego.

Definicja typów
otBorderAgentId definicja typu
Reprezentuje identyfikator agenta granicznego.
otBorderAgentState definicja typu
Określa agenta agenta granicznego.

Zmienne
OT_TOOL_PACKED_END

Funkcje
otBorderAgentGetId(otInstance *aInstance, otBorderAgentId *aId)
Pobiera losowo wygenerowany identyfikator agenta granicznego.
otBorderAgentGetState(otInstance *aInstance)
Pobiera otBorderAgentState roli agenta granicznej wątku.
otBorderAgentGetUdpPort(otInstance *aInstance)
uint16_t
Pobiera port UDP usługi agenta wątków.
otBorderAgentSetId(otInstance *aInstance, const otBorderAgentId *aId)
Ustawia identyfikator agenta granicy.

Struktury
otBorderAgentId

Reprezentuje identyfikator agenta granicznego.

Wyliczenia

OtBorderAgentState

 otBorderAgentState

Określa agenta agenta granicznego.

Właściwości
OT_BORDER_AGENT_STATE_ACTIVE

Agent graniczny jest połączony z zewnętrznym komisarzem.

OT_BORDER_AGENT_STATE_STARTED

Agent obramowania został uruchomiony.

OT_BORDER_AGENT_STATE_STOPPED

Rola agenta granicznego jest wyłączona.

Definicja typów

Identyfikator agenta (otBorderAgentId)

struct otBorderAgentId otBorderAgentId

Reprezentuje identyfikator agenta granicznego.

OtBorderAgentState

enum otBorderAgentState otBorderAgentState

Określa agenta agenta granicznego.

Zmienne

ROZPOCZĘCIE_NAZWY_END

OT_TOOL_PACKED_BEGIN struct otBorderAgentId OT_TOOL_PACKED_END

Funkcje

Identyfikator otBorderAgentGetId

otError otBorderAgentGetId(
  otInstance *aInstance,
  otBorderAgentId *aId
)

Pobiera losowo wygenerowany identyfikator agenta granicznego.

Identyfikator jest zapisywany w pamięci trwałej i przetrwa po ponownym uruchomieniu. Typowym przypadkiem użycia identyfikatora jest opublikowanie jego identyfikatora w usłudze MeshCoP mDNS w postaci wartości TXT dla klienta id, aby zidentyfikować to urządzenie graniczne/agenta.

Szczegóły
Parametry
[in] aInstance
Wskaźnik do instancji OpenThread.
[out] aId
Wskaźnik pozwalający na wykrycie identyfikatora.
Wartości zwracane
OT_ERROR_NONE
Jeśli identyfikator agenta granicznego został pobrany,
...
Nie udało się pobrać identyfikatora agenta granicznego.
Zobacz też:
otBorderAgentSetId

otBorderAgentGetState,

otBorderAgentState otBorderAgentGetState(
  otInstance *aInstance
)

Pobiera otBorderAgentState roli agenta granicznej wątku.

Szczegóły
Parametry
[in] aInstance
Wskaźnik do instancji OpenThread.
Zwroty
Bieżący element otBorderAgentState agenta granicznego.

otBorderAgentGetUdpPort,

uint16_t otBorderAgentGetUdpPort(
  otInstance *aInstance
)

Pobiera port UDP usługi agenta wątków.

Szczegóły
Parametry
[in] aInstance
Wskaźnik do instancji OpenThread.
Zwroty
Port UDP agenta granicznego.

IdentyfikatorOotBorderAgentSet

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

Ustawia identyfikator agenta granicy.

Identyfikator agenta granicznego zostanie zapisany w pamięci trwałej i będzie w stanie przetrwać ponowne uruchomienie. Wymagane jest ponowne skonfigurowanie identyfikatora tylko raz po przywróceniu ustawień fabrycznych. Jeśli identyfikator nigdy nie został ustawiony przez wywołanie tej funkcji, zostanie wygenerowany losowy identyfikator i zostanie on zwrócony po wywołaniu funkcji otBorderAgentGetId.

Szczegóły
Parametry
[in] aInstance
Wskaźnik do instancji OpenThread.
[out] aId
Wskaźnik do identyfikatora agenta granicznego.
Wartości zwracane
OT_ERROR_NONE
Jeśli identyfikator agenta granicznego został ustawiony.
...
Jeśli nie udało się ustawić identyfikatora agenta granicznego.
Zobacz też:
otBorderAgentGetId

Makra

OT_BORDER_AGENT_ID_LENGTH

 OT_BORDER_AGENT_ID_LENGTH (16)

Długość agenta granicy/identyfikatora agenta w bajtach.

Zasoby

Tematy referencyjne interfejsu API OpenThread pochodzą z kodu źródłowego dostępnego w GitHub. Aby dowiedzieć się więcej lub dodać treści do naszej dokumentacji, zapoznaj się z materiałami.