Магистральный маршрутизатор

Этот модуль включает функции для службы магистрального маршрутизатора OpenThread.

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

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

otBackboneRouterDomainPrefixEvent {
OT_BACKBONE_ROUTER_DOMAIN_PREFIX_ADDED = 0,
OT_BACKBONE_ROUTER_DOMAIN_PREFIX_REMOVED = 1,
OT_BACKBONE_ROUTER_DOMAIN_PREFIX_CHANGED = 2
}		 перечисление
Представляет события префикса домена.
otBackboneRouterMulticastListenerEvent {
OT_BACKBONE_ROUTER_MULTICAST_LISTENER_ADDED = 0,
OT_BACKBONE_ROUTER_MULTICAST_LISTENER_REMOVED = 1
}		 перечисление
Представляет события прослушивателя многоадресной рассылки.
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
}		 перечисление
Представляет события прокси-сервера ND.
otBackboneRouterState {
OT_BACKBONE_ROUTER_STATE_DISABLED = 0,
OT_BACKBONE_ROUTER_STATE_SECONDARY = 1,
OT_BACKBONE_ROUTER_STATE_PRIMARY = 2
}		 перечисление
Представляет состояние магистрального маршрутизатора.

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

otBackboneRouterConfig определение типа
Представляет конфигурацию магистрального маршрутизатора.
otBackboneRouterDomainPrefixCallback )(void *aContext, otBackboneRouterDomainPrefixEvent aEvent, const otIp6Prefix *aDomainPrefix) определение типа
void(*
Указатель вызывается всякий раз, когда изменяется префикс домена.
otBackboneRouterMulticastListenerCallback )(void *aContext, otBackboneRouterMulticastListenerEvent aEvent, const otIp6Address *aAddress) определение типа
void(*
Указатель вызывается всякий раз, когда изменяются прослушиватели многоадресной рассылки.
otBackboneRouterMulticastListenerInfo определение типа
Представляет информацию об приемнике многоадресной рассылки магистрального маршрутизатора.
otBackboneRouterMulticastListenerIterator определение типа
uint16_t
Используется для итерации прослушивателей многоадресной рассылки.
otBackboneRouterNdProxyCallback )(void *aContext, otBackboneRouterNdProxyEvent aEvent, const otIp6Address *aDua) определение типа
void(*
Указатель вызывается всякий раз, когда изменяется Nd Proxy.
otBackboneRouterNdProxyInfo определение типа
Представляет информацию о прокси-сервере ND магистрального маршрутизатора.

Функции

otBackboneRouterConfigNextDuaRegistrationResponse ( otInstance *aInstance, const otIp6InterfaceIdentifier *aMlIid, uint8_t aStatus)
void
Настраивает статус ответа для следующей регистрации DUA.
otBackboneRouterConfigNextMulticastListenerRegistrationResponse ( otInstance *aInstance, uint8_t aStatus)
void
Настраивает статус ответа для следующей регистрации прослушивателя многоадресной рассылки.
otBackboneRouterGetConfig ( otInstance *aInstance, otBackboneRouterConfig *aConfig)
void
Получает конфигурацию локального магистрального маршрутизатора.
otBackboneRouterGetDomainPrefix ( otInstance *aInstance, otBorderRouterConfig *aConfig)
Получает локальную конфигурацию префикса домена.
otBackboneRouterGetNdProxyInfo ( otInstance *aInstance, const otIp6Address *aDua, otBackboneRouterNdProxyInfo *aNdProxyInfo)
Получает информацию о прокси-сервере ND магистрального маршрутизатора.
otBackboneRouterGetPrimary ( otInstance *aInstance, otBackboneRouterConfig *aConfig)
Получает информацию об основном магистральном маршрутизаторе в сети потоков.
otBackboneRouterGetRegistrationJitter ( otInstance *aInstance)
uint8_t
Возвращает значение дрожания регистрации магистрального маршрутизатора.
otBackboneRouterGetState ( otInstance *aInstance)
Получает otBackboneRouterState магистрального маршрутизатора.
otBackboneRouterMulticastListenerAdd ( otInstance *aInstance, const otIp6Address *aAddress, uint32_t aTimeout)
Добавляет прослушиватель многоадресной рассылки со значением времени ожидания в секундах.
otBackboneRouterMulticastListenerClear ( otInstance *aInstance)
void
Очищает прослушиватели многоадресной рассылки.
otBackboneRouterMulticastListenerGetNext ( otInstance *aInstance, otBackboneRouterMulticastListenerIterator *aIterator, otBackboneRouterMulticastListenerInfo *aListenerInfo)
Получает информацию о следующем прослушивателе многоадресной рассылки (используя итератор).
otBackboneRouterRegister ( otInstance *aInstance)
Явно регистрирует конфигурацию локального магистрального маршрутизатора.
otBackboneRouterSetConfig ( otInstance *aInstance, const otBackboneRouterConfig *aConfig)
Задает локальную конфигурацию магистрального маршрутизатора otBackboneRouterConfig .
otBackboneRouterSetDomainPrefixCallback ( otInstance *aInstance, otBackboneRouterDomainPrefixCallback aCallback, void *aContext)
void
Устанавливает обратный вызов префикса домена магистрального маршрутизатора.
otBackboneRouterSetEnabled ( otInstance *aInstance, bool aEnable)
void
Включает или отключает функциональность Backbone.
otBackboneRouterSetMulticastListenerCallback ( otInstance *aInstance, otBackboneRouterMulticastListenerCallback aCallback, void *aContext)
void
Устанавливает обратный вызов прослушивателя многоадресной рассылки магистрального маршрутизатора.
otBackboneRouterSetNdProxyCallback ( otInstance *aInstance, otBackboneRouterNdProxyCallback aCallback, void *aContext)
void
Устанавливает обратный вызов прокси-сервера ND магистрального маршрутизатора.
otBackboneRouterSetRegistrationJitter ( otInstance *aInstance, uint8_t aJitter)
void
Устанавливает значение дрожания регистрации магистрального маршрутизатора.

Структуры

otBackboneRouterConfig

Представляет конфигурацию магистрального маршрутизатора.

otBackboneRouterMulticastListenerInfo

Представляет информацию об приемнике многоадресной рассылки магистрального маршрутизатора.

otBackboneRouterNdProxyInfo

Представляет информацию о прокси-сервере ND магистрального маршрутизатора.

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

otBackboneRouterDomainPrefixEvent

 otBackboneRouterDomainPrefixEvent

Представляет события префикса домена.

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

Добавлен префикс домена.

OT_BACKBONE_ROUTER_DOMAIN_PREFIX_CHANGED

Префикс домена был изменен.

OT_BACKBONE_ROUTER_DOMAIN_PREFIX_REMOVED

Префикс домена удален.

otBackboneRouterMulticastListenerEvent

 otBackboneRouterMulticastListenerEvent

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

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

Добавлен прослушиватель многоадресной рассылки.

OT_BACKBONE_ROUTER_MULTICAST_LISTENER_REMOVED

Прослушиватель многоадресной рассылки был удален или срок его действия истек.

otBackboneRouterNdProxyEvent

 otBackboneRouterNdProxyEvent

Представляет события прокси-сервера ND.

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

Добавлен прокси ND.

OT_BACKBONE_ROUTER_NDPROXY_CLEARED

Все прокси ND были очищены.

OT_BACKBONE_ROUTER_NDPROXY_REMOVED

ND Proxy был удален.

OT_BACKBONE_ROUTER_NDPROXY_RENEWED

ND Proxy был обновлен.

otBackboneRouterState

 otBackboneRouterState

Представляет состояние магистрального маршрутизатора.

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

Функция магистрали отключена.

OT_BACKBONE_ROUTER_STATE_PRIMARY

Основной магистральный маршрутизатор.

OT_BACKBONE_ROUTER_STATE_SECONDARY

Вторичный магистральный маршрутизатор.

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

otBackboneRouterConfig

struct otBackboneRouterConfig otBackboneRouterConfig

Представляет конфигурацию магистрального маршрутизатора.

otBackboneRouterDomainPrefixCallback

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

Указатель вызывается всякий раз, когда изменяется префикс домена.

Подробности
Параметры
[in] aContext
Указатель пользовательского контекста.
[in] aEvent
Событие «Префикс домена».
[in] aDomainPrefix
Новый префикс домена, если он добавлен или изменен, в противном случае — nullptr.

otBackboneRouterMulticastListenerCallback

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

Указатель вызывается всякий раз, когда изменяются прослушиватели многоадресной рассылки.

Подробности
Параметры
[in] aContext
Указатель пользовательского контекста.
[in] aEvent
Событие прослушивателя многоадресной рассылки.
[in] aAddress
Многоадресный IPv6-адрес прослушивателя многоадресной рассылки.

otBackboneRouterMulticastListenerInfo

struct otBackboneRouterMulticastListenerInfo otBackboneRouterMulticastListenerInfo

Представляет информацию об приемнике многоадресной рассылки магистрального маршрутизатора.

otBackboneRouterMulticastListenerIterator

uint16_t otBackboneRouterMulticastListenerIterator

Используется для итерации прослушивателей многоадресной рассылки.

otBackboneRouterNdProxyCallback

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

Указатель вызывается всякий раз, когда изменяется Nd Proxy.

Подробности
Параметры
[in] aContext
Указатель пользовательского контекста.
[in] aEvent
Событие ND Proxy.
[in] aDua
Одноадресный адрес домена прокси-сервера ND или nullptr , если aEvent имеет значение OT_BACKBONE_ROUTER_NDPROXY_CLEARED .

otBackboneRouterNdProxyInfo

struct otBackboneRouterNdProxyInfo otBackboneRouterNdProxyInfo

Представляет информацию о прокси-сервере ND магистрального маршрутизатора.

Функции

otBackboneRouterConfigNextDuaRegistrationResponse

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

Настраивает статус ответа для следующей регистрации DUA.

Примечание. Доступно только при включенном OPENTHREAD_CONFIG_REFERENCE_DEVICE_ENABLE . Используется только для испытаний и сертификации.

TODO: (DUA) поддержка кода ошибки coap и соответствующего процесса для целей сертификации.

Подробности
Параметры
[in] aInstance
Указатель на экземпляр OpenThread.
[in] aMlIid
Указатель на Mesh Local IID. Если NULL, ответьте с помощью aStatus для любого поступающего DUA.req, в противном случае ответьте только на тот, у которого есть соответствующий aMlIid .
[in] aStatus
Статус для ответа.

otBackboneRouterConfigNextMulticastListenerRegistrationResponse

void otBackboneRouterConfigNextMulticastListenerRegistrationResponse(
  otInstance *aInstance,
  uint8_t aStatus
)

Настраивает статус ответа для следующей регистрации прослушивателя многоадресной рассылки.

Доступно, если включены OPENTHREAD_CONFIG_BACKBONE_ROUTER_ENABLE , OPENTHREAD_CONFIG_BACKBONE_ROUTER_MULTICAST_ROUTING_ENABLE и OPENTHREAD_CONFIG_REFERENCE_DEVICE_ENABLE .

Подробности
Параметры
[in] aInstance
Указатель на экземпляр OpenThread.
[in] aStatus
Статус для ответа.

otBackboneRouterGetConfig

void otBackboneRouterGetConfig(
  otInstance *aInstance,
  otBackboneRouterConfig *aConfig
)

Получает конфигурацию локального магистрального маршрутизатора.

Доступно, если включен OPENTHREAD_CONFIG_BACKBONE_ROUTER_ENABLE .

Подробности
Параметры
[in] aInstance
Указатель на экземпляр OpenThread.
[out] aConfig
Указатель, куда поместить конфигурацию локального магистрального маршрутизатора.
Смотрите также:
otBackboneRouterSetEnabled
otBackboneRouterGetState
otBackboneRouterSetConfig
otBackboneRouterРегистрация

otBackboneRouterGetDomainPrefix

otError otBackboneRouterGetDomainPrefix(
  otInstance *aInstance,
  otBorderRouterConfig *aConfig
)

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

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

otBackboneRouterGetNdProxyInfo

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

Получает информацию о прокси-сервере ND магистрального маршрутизатора.

Подробности
Параметры
[in] aInstance
Указатель на экземпляр OpenThread.
[in] aDua
Индивидуальный адрес домена.
[out] aNdProxyInfo
Указатель на информацию о прокси-сервере ND.
Возвращаемые значения
OT_ERROR_NONE
Успешно получена информация о прокси-сервере ND.
OT_ERROR_NOT_FOUND
Не удалось найти адрес одноадресной рассылки домена в таблице прокси-сервера ND.

otBackboneRouterGetPrimary

otError otBackboneRouterGetPrimary(
  otInstance *aInstance,
  otBackboneRouterConfig *aConfig
)

Получает информацию об основном магистральном маршрутизаторе в сети потоков.

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

otBackboneRouterGetRegistrationJitter

uint8_t otBackboneRouterGetRegistrationJitter(
  otInstance *aInstance
)

Возвращает значение дрожания регистрации магистрального маршрутизатора.

Подробности
Возвращает
Значение дрожания регистрации магистрального маршрутизатора.
Смотрите также:
otBackboneRouterSetRegistrationJitter

otBackboneRouterGetState

otBackboneRouterState otBackboneRouterGetState(
  otInstance *aInstance
)

Получает otBackboneRouterState магистрального маршрутизатора.

Подробности
Параметры
[in] aInstance
Указатель на экземпляр OpenThread.
Возвращаемые значения
OT_BACKBONE_ROUTER_STATE_DISABLED
Функциональность магистрали отключена.
OT_BACKBONE_ROUTER_STATE_SECONDARY
Вторичный магистральный маршрутизатор.
OT_BACKBONE_ROUTER_STATE_PRIMARY
Основной магистральный маршрутизатор.
Смотрите также:
otBackboneRouterSetEnabled
otBackboneRouterGetConfig
otBackboneRouterSetConfig
otBackboneRouterРегистрация

otBackboneRouterMulticastListenerAdd

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

Добавляет прослушиватель многоадресной рассылки со значением времени ожидания в секундах.

Передайте 0 , чтобы использовать время ожидания MLR по умолчанию.

Доступно, если включены OPENTHREAD_CONFIG_BACKBONE_ROUTER_ENABLE , OPENTHREAD_CONFIG_BACKBONE_ROUTER_MULTICAST_ROUTING_ENABLE и OPENTHREAD_CONFIG_REFERENCE_DEVICE_ENABLE .

Подробности
Параметры
[in] aInstance
Указатель на экземпляр OpenThread.
[in] aAddress
Адрес прослушивателя многоадресной рассылки.
[in] aTimeout
Тайм-аут (в секундах) прослушивателя многоадресной рассылки или 0, чтобы использовать тайм-аут MLR по умолчанию.
Возвращаемые значения
OT_ERROR_NONE
Если прослушиватель многоадресной рассылки был успешно добавлен.
OT_ERROR_INVALID_ARGS
Если адрес прослушивателя многоадресной рассылки недействителен.
OT_ERROR_NO_BUFS
Недостаточно места для сохранения прослушивателя многоадресной рассылки.
Смотрите также:
otBackboneRouterMulticastListenerClear
otBackboneRouterMulticastListenerGetNext

otBackboneRouterMulticastListenerClear

void otBackboneRouterMulticastListenerClear(
  otInstance *aInstance
)

Очищает прослушиватели многоадресной рассылки.

Доступно, если включены OPENTHREAD_CONFIG_BACKBONE_ROUTER_ENABLE , OPENTHREAD_CONFIG_BACKBONE_ROUTER_MULTICAST_ROUTING_ENABLE и OPENTHREAD_CONFIG_REFERENCE_DEVICE_ENABLE .

Подробности
Параметры
[in] aInstance
Указатель на экземпляр OpenThread.
Смотрите также:
otBackboneRouterMulticastListenerAdd
otBackboneRouterMulticastListenerGetNext

otBackboneRouterMulticastListenerGetNext

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

Получает информацию о следующем прослушивателе многоадресной рассылки (используя итератор).

Подробности
Параметры
[in] aInstance
Указатель на экземпляр OpenThread.
[in,out] aIterator
Указатель на итератор. В случае успеха итератор будет обновлен, чтобы указывать на следующего прослушивателя многоадресной рассылки. Чтобы получить первую запись, итератор должен быть установлен в OT_BACKBONE_ROUTER_MULTICAST_LISTENER_ITERATOR_INIT.
[out] aListenerInfo
Указатель на otBackboneRouterMulticastListenerInfo , куда помещается информация о следующем прослушивателе многоадресной рассылки (в случае успеха).
Возвращаемые значения
OT_ERROR_NONE
Информация о следующем прослушивателе многоадресной рассылки успешно найдена ( aListenerInfo успешно обновлена).
OT_ERROR_NOT_FOUND
Последующая информация об прослушивателе многоадресной рассылки не найдена.
Смотрите также:
otBackboneRouterMulticastListenerClear
otBackboneRouterMulticastListenerAdd

otBackboneRouterРегистрация

otError otBackboneRouterRegister(
  otInstance *aInstance
)

Явно регистрирует конфигурацию локального магистрального маршрутизатора.

Для подключенного устройства запускается сообщение запроса данных сервера SRV_DATA.ntf .

Доступно, если включен OPENTHREAD_CONFIG_BACKBONE_ROUTER_ENABLE .

Подробности
Параметры
[in] aInstance
Указатель на экземпляр OpenThread.
Возвращаемые значения
OT_ERROR_NO_BUFS
Недостаточно места для добавления службы магистрального маршрутизатора.
OT_ERROR_NONE
Сообщение запроса данных сервера успешно помещено в очередь для доставки.
Смотрите также:
otBackboneRouterSetEnabled
otBackboneRouterGetState
otBackboneRouterGetConfig
otBackboneRouterSetConfig

otBackboneRouterSetConfig

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

Задает локальную конфигурацию магистрального маршрутизатора otBackboneRouterConfig .

Сообщение запроса данных сервера SRV_DATA.ntf инициируется автоматически, если набор данных BBR изменяется для основного магистрального маршрутизатора.

Доступно, если включен OPENTHREAD_CONFIG_BACKBONE_ROUTER_ENABLE .

Подробности
Параметры
[in] aInstance
Указатель на экземпляр OpenThread.
[in] aConfig
Указатель на вступившую в силу конфигурацию магистрального маршрутизатора.
Возвращаемые значения
OT_ERROR_NONE
Успешно обновлена ​​конфигурация.
OT_ERROR_INVALID_ARGS
Конфигурация в aConfig недействительна.
Смотрите также:
otBackboneRouterSetEnabled
otBackboneRouterGetState
otBackboneRouterGetConfig
otBackboneRouterРегистрация

otBackboneRouterSetDomainPrefixCallback

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

Устанавливает обратный вызов префикса домена магистрального маршрутизатора.

Подробности
Параметры
[in] aInstance
Указатель на экземпляр OpenThread.
[in] aCallback
Указатель на обратный вызов префикса домена.
[in] aContext
Указатель пользовательского контекста.

otBackboneRouterSetEnabled

void otBackboneRouterSetEnabled(
  otInstance *aInstance,
  bool aEnable
)

Включает или отключает функциональность Backbone.

Если этот параметр включен, сообщение запроса данных сервера SRV_DATA.ntf запускается для подключенного устройства, если в потоке сетевых данных нет службы магистрального маршрутизатора.

Если отключено, SRV_DATA.ntf запускается, если магистральный маршрутизатор находится в основном состоянии.

Доступно, если включен OPENTHREAD_CONFIG_BACKBONE_ROUTER_ENABLE .

Подробности
Параметры
[in] aInstance
Указатель на экземпляр OpenThread.
[in] aEnable
TRUE для включения функций Backbone, FALSE в противном случае.
Смотрите также:
otBackboneRouterGetState
otBackboneRouterGetConfig
otBackboneRouterSetConfig
otBackboneRouterРегистрация

otBackboneRouterSetMulticastListenerCallback

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

Устанавливает обратный вызов прослушивателя многоадресной рассылки магистрального маршрутизатора.

Подробности
Параметры
[in] aInstance
Указатель на экземпляр OpenThread.
[in] aCallback
Указатель на обратный вызов прослушивателя многоадресной рассылки.
[in] aContext
Указатель пользовательского контекста.

otBackboneRouterSetNdProxyCallback

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

Устанавливает обратный вызов прокси-сервера ND магистрального маршрутизатора.

Подробности
Параметры
[in] aInstance
Указатель на экземпляр OpenThread.
[in] aCallback
Указатель на обратный вызов прокси-сервера ND.
[in] aContext
Указатель пользовательского контекста.

otBackboneRouterSetRegistrationJitter

void otBackboneRouterSetRegistrationJitter(
  otInstance *aInstance,
  uint8_t aJitter
)

Устанавливает значение дрожания регистрации магистрального маршрутизатора.

Подробности
Параметры
[in] aJitter
устанавливаемое значение дрожания регистрации магистрального маршрутизатора.
Смотрите также:
otBackboneRouterGetRegistrationJitter

Макросы

OT_BACKBONE_ROUTER_MULTICAST_LISTENER_ITERATOR_INIT

 OT_BACKBONE_ROUTER_MULTICAST_LISTENER_ITERATOR_INIT 0

Инициализатор для otBackboneRouterMulticastListenerIterator.

Ресурсы

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