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

Этот модуль включает функции для службы OpenThread Backbone Router Service.

Резюме

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

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
}
перечислить
Представляет состояние магистрального маршрутизатора.

Typedefs

otBackboneRouterConfig typedef
Эта структура представляет конфигурацию магистрального маршрутизатора.
otBackboneRouterDomainPrefixCallback )(void *aContext, otBackboneRouterDomainPrefixEvent aEvent, const otIp6Prefix *aDomainPrefix) typedef
void(*
Этот указатель на функцию вызывается всякий раз, когда изменяется префикс домена.
otBackboneRouterMulticastListenerCallback )(void *aContext, otBackboneRouterMulticastListenerEvent aEvent, const otIp6Address *aAddress) typedef
void(*
Этот указатель на функцию вызывается всякий раз, когда меняются прослушиватели многоадресной рассылки.
otBackboneRouterMulticastListenerInfo typedef
Эта структура представляет информацию о прослушивателе многоадресной рассылки магистрального маршрутизатора.
otBackboneRouterMulticastListenerIterator typedef
uint16_t
Используется для перебора прослушивателей многоадресной рассылки.
otBackboneRouterNdProxyCallback )(void *aContext, otBackboneRouterNdProxyEvent aEvent, const otIp6Address *aDua) typedef
void(*
Этот указатель на функцию вызывается всякий раз, когда изменяется прокси 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)
Эта функция получает состояние магистрального маршрутизатора.
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)
Эта функция устанавливает конфигурацию локального магистрального маршрутизатора.
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

Добавлен Multicast Listener.

OT_BACKBONE_ROUTER_MULTICAST_LISTENER_REMOVED

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

otBackboneRouterNdProxyEvent

 otBackboneRouterNdProxyEvent

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

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

Добавлен ND Proxy.

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

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

Typedefs

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
Событие Multicast Listener.
[in] aAddress
Адрес многоадресной рассылки IPv6 прослушивателя многоадресной рассылки.

otBackboneRouterMulticastListenerInfo

struct otBackboneRouterMulticastListenerInfo otBackboneRouterMulticastListenerInfo

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

otBackboneRouterMulticastListenerIterator

uint16_t otBackboneRouterMulticastListenerIterator

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

otBackboneRouterNdProxyCallback

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

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

Подробности
Параметры
[in] aContext
Указатель контекста пользователя.
[in] aEvent
Событие ND Proxy.
[in] aDua
Домен Unicast Адрес ND Proxy, или nullptr если aEvent является OT_BACKBONE_ROUTER_NDPROXY_CLEARED .

Функции

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_REFERENCE_DEVICE_ENABLE . Используется только для тестирования и сертификации.

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

otBackboneRouterGetConfig

void otBackboneRouterGetConfig(
  otInstance *aInstance,
  otBackboneRouterConfig *aConfig
)

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

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

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
)

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

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

otBackboneRouterMulticastListenerAdd

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

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

Примечание: доступно только при 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_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 куда otBackboneRouterMulticastListenerInfo информация о следующем многоадресном otBackboneRouterMulticastListenerInfo (в случае успеха).
Возвращаемые значения
OT_ERROR_NONE
Успешно найдена следующая информация о aListenerInfo многоадресной aListenerInfo ( aListenerInfo успешно обновлен).
OT_ERROR_NOT_FOUND
Последующая информация о многоадресном слушателе не найдена.
Смотрите также:
otBackboneRouterMulticastListenerClear
otBackboneRouterMulticastListenerAdd

otBackboneRouterRegister

otError otBackboneRouterRegister(
  otInstance *aInstance
)

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

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

otBackboneRouterSetConfig

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

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

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

otBackboneRouterSetDomainPrefixCallback

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

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

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

otBackboneRouterSetEnabled

void otBackboneRouterSetEnabled(
  otInstance *aInstance,
  bool aEnable
)

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

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

otBackboneRouterSetMulticastListenerCallback

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

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

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

otBackboneRouterSetNdProxyCallback

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

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

Подробности
Параметры
[in] aInstance
Указатель на экземпляр OpenThread.
[in] aCallback
Указатель на обратный вызов ND Proxy.
[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.