пограничный агент

Этот модуль включает функции для роли пограничного агента потока.

Краткое содержание

Перечисления

otBorderAgentState {
OT_BORDER_AGENT_STATE_STOPPED = 0,
OT_BORDER_AGENT_STATE_STARTED = 1,
OT_BORDER_AGENT_STATE_ACTIVE = 2
}		 перечисление
Определяет состояние пограничного агента.

Определения типов

otBorderAgentId определение типа
Представляет идентификатор пограничного агента.
otBorderAgentState определение типа
Определяет состояние пограничного агента.

Переменные

OT_TOOL_PACKED_END

Функции

otBorderAgentGetId ( otInstance *aInstance, otBorderAgentId *aId)
Получает случайно сгенерированный идентификатор пограничного агента.
otBorderAgentGetState ( otInstance *aInstance)
Получает состояние otBorderAgentState роли пограничного агента потока.
otBorderAgentGetUdpPort ( otInstance *aInstance)
uint16_t
Получает UDP-порт службы пограничного агента потока.
otBorderAgentSetId ( otInstance *aInstance, const otBorderAgentId *aId)
Устанавливает идентификатор пограничного агента.

Структуры

otBorderAgentId

Представляет идентификатор пограничного агента.

Перечисления

отбордерагентстате

 otBorderAgentState

Определяет состояние пограничного агента.

Характеристики
OT_BORDER_AGENT_STATE_ACTIVE

Пограничный агент связан с внешним уполномоченным.

OT_BORDER_AGENT_STATE_STARTED

Пограничный агент запущен.

OT_BORDER_AGENT_STATE_STOPPED

Роль пограничного агента отключена.

Определения типов

otBorderAgentId

struct otBorderAgentId otBorderAgentId

Представляет идентификатор пограничного агента.

отбордерагентстате

enum otBorderAgentState otBorderAgentState

Определяет состояние пограничного агента.

Переменные

OT_TOOL_PACKED_END

OT_TOOL_PACKED_BEGIN struct otBorderAgentId OT_TOOL_PACKED_END

Функции

otBorderAgentGetId

otError otBorderAgentGetId(
  otInstance *aInstance,
  otBorderAgentId *aId
)

Получает случайно сгенерированный идентификатор пограничного агента.

Идентификатор сохраняется в постоянном хранилище и сохраняется после перезагрузки. Типичный вариант использования идентификатора должен быть опубликован в службе mDNS MeshCoP в качестве значения id TXT для клиента, чтобы идентифицировать это устройство пограничного маршрутизатора/агента.

Подробности
Параметры
[in] aInstance
Указатель на экземпляр OpenThread.
[out] aId
Указатель на буфер для получения идентификатора.
Возвращаемые значения
OT_ERROR_NONE
В случае успешного получения идентификатора пограничного агента.
...
Если не удалось получить идентификатор пограничного агента.
Смотрите также:
отбордерагентсетид

otBorderAgentGetState

otBorderAgentState otBorderAgentGetState(
  otInstance *aInstance
)

Получает состояние otBorderAgentState роли пограничного агента потока.

Подробности
Параметры
[in] aInstance
Указатель на экземпляр OpenThread.
Возвращает
Текущее состояние otBorderAgentState пограничного агента.

otBorderAgentGetUdpPort

uint16_t otBorderAgentGetUdpPort(
  otInstance *aInstance
)

Получает UDP-порт службы пограничного агента потока.

Подробности
Параметры
[in] aInstance
Указатель на экземпляр OpenThread.
Возвращает
UDP-порт пограничного агента.

отбордерагентсетид

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

Устанавливает идентификатор пограничного агента.

Идентификатор пограничного агента будет сохранен в постоянном хранилище и выдержит перезагрузку. Необходимо установить идентификатор только один раз после сброса настроек. Если идентификатор никогда не устанавливался путем вызова этой функции, будет сгенерирован случайный идентификатор, который будет возвращен при вызове otBorderAgentGetId .

Подробности
Параметры
[in] aInstance
Указатель на экземпляр OpenThread.
[out] aId
Указатель на идентификатор пограничного агента.
Возвращаемые значения
OT_ERROR_NONE
В случае успеха установите идентификатор пограничного агента.
...
Если не удалось установить идентификатор пограничного агента.
Смотрите также:
otBorderAgentGetId

Макросы

OT_BORDER_AGENT_ID_LENGTH

 OT_BORDER_AGENT_ID_LENGTH (16)

Длина идентификатора пограничного агента/маршрутизатора в байтах.

Ресурсы

Разделы справочника по API OpenThread взяты из исходного кода, доступного на GitHub . Чтобы получить дополнительную информацию или внести свой вклад в нашу документацию, обратитесь к разделу Ресурсы .