Пограничный маршрутизатор
Этот модуль включает функции для управления данными локальной сети с помощью пограничного маршрутизатора OpenThread.
Резюме
Функции | |
---|---|
otBorderRouterAddOnMeshPrefix ( otInstance *aInstance, const otBorderRouterConfig *aConfig) | Добавьте конфигурацию граничного маршрутизатора в данные локальной сети. |
otBorderRouterAddRoute ( otInstance *aInstance, const otExternalRouteConfig *aConfig) | Добавьте конфигурацию внешнего маршрута в данные локальной сети. |
otBorderRouterGetNetData ( otInstance *aInstance, bool aStable, uint8_t *aData, uint8_t *aDataLength) | Этот метод обеспечивает полную или стабильную копию локальных сетевых данных потока. |
otBorderRouterGetNextOnMeshPrefix ( otInstance *aInstance, otNetworkDataIterator *aIterator, otBorderRouterConfig *aConfig) | Эта функция получает следующий префикс On Mesh в данных локальной сети. |
otBorderRouterGetNextRoute ( otInstance *aInstance, otNetworkDataIterator *aIterator, otExternalRouteConfig *aConfig) | Эта функция получает следующий внешний маршрут в локальной сети данных. |
otBorderRouterRegister ( otInstance *aInstance) | Немедленно зарегистрируйте данные локальной сети в Лидере. |
otBorderRouterRemoveOnMeshPrefix ( otInstance *aInstance, const otIp6Prefix *aPrefix) | Удалите конфигурацию граничного маршрутизатора из данных локальной сети. |
otBorderRouterRemoveRoute ( otInstance *aInstance, const otIp6Prefix *aPrefix) | Удалите конфигурацию внешнего маршрута из данных локальной сети. |
otBorderRoutingGetNat64Prefix ( otInstance *aInstance, otIp6Prefix *aPrefix) | Эта функция возвращает локальный префикс NAT64. |
otBorderRoutingGetOmrPrefix ( otInstance *aInstance, otIp6Prefix *aPrefix) | Этот метод возвращает префикс маршрутизации вне сети (OMR). |
otBorderRoutingGetOnLinkPrefix ( otInstance *aInstance, otIp6Prefix *aPrefix) | Этот метод возвращает префикс on-link для соседнего инфраструктурного канала. |
otBorderRoutingInit ( otInstance *aInstance, uint32_t aInfraIfIndex, bool aInfraIfIsRunning) | Этот метод инициализирует диспетчер пограничной маршрутизации на заданном интерфейсе инфраструктуры. |
otBorderRoutingSetEnabled ( otInstance *aInstance, bool aEnabled) | Этот метод включает/отключает диспетчер пограничной маршрутизации. |
Функции
otBorderRouterAddOnMeshPrefix
otError otBorderRouterAddOnMeshPrefix( otInstance *aInstance, const otBorderRouterConfig *aConfig )
Добавьте конфигурацию граничного маршрутизатора в данные локальной сети.
Подробности | |||||||
---|---|---|---|---|---|---|---|
Параметры |
| ||||||
Возвращаемые значения |
|
otBorderRouterRemoveOnMeshPrefix
otBorderRouterRegister
otBorderRouterAddRoute
otError otBorderRouterAddRoute( otInstance *aInstance, const otExternalRouteConfig *aConfig )
Добавьте конфигурацию внешнего маршрута в данные локальной сети.
Подробности | |||||||
---|---|---|---|---|---|---|---|
Параметры |
| ||||||
Возвращаемые значения |
|
otBorderRouterRemoveRoute
otBorderRouterRegister
otBorderRouterGetNetData
otError otBorderRouterGetNetData( otInstance *aInstance, bool aStable, uint8_t *aData, uint8_t *aDataLength )
Этот метод обеспечивает полную или стабильную копию локальных сетевых данных потока.
Подробности | |||||||||
---|---|---|---|---|---|---|---|---|---|
Параметры |
|
otBorderRouterGetNextOnMeshPrefix
otError otBorderRouterGetNextOnMeshPrefix( otInstance *aInstance, otNetworkDataIterator *aIterator, otBorderRouterConfig *aConfig )
Эта функция получает следующий префикс On Mesh в данных локальной сети.
Подробности | |||||||
---|---|---|---|---|---|---|---|
Параметры |
| ||||||
Возвращаемые значения |
|
otBorderRouterGetNextRoute
otError otBorderRouterGetNextRoute( otInstance *aInstance, otNetworkDataIterator *aIterator, otExternalRouteConfig *aConfig )
Эта функция получает следующий внешний маршрут в локальной сети данных.
Подробности | |||||||
---|---|---|---|---|---|---|---|
Параметры |
| ||||||
Возвращаемые значения |
|
otBorderRouterRegister
otError otBorderRouterRegister( otInstance *aInstance )
Немедленно зарегистрируйте данные локальной сети в Лидере.
Подробности | |||
---|---|---|---|
Параметры |
| ||
Возвращаемые значения |
|
otBorderRouterAddOnMeshPrefix
otBorderRouterRemoveOnMeshPrefix
otBorderRouterAddRoute
otBorderRouterRemoveRoute
otBorderRouterRemoveOnMeshPrefix
otError otBorderRouterRemoveOnMeshPrefix( otInstance *aInstance, const otIp6Prefix *aPrefix )
Удалите конфигурацию граничного маршрутизатора из данных локальной сети.
Подробности | |||||
---|---|---|---|---|---|
Параметры |
| ||||
Возвращаемые значения |
|
otBorderRouterAddOnMeshPrefix
otBorderRouterRegister
otBorderRouterRemoveRoute
otError otBorderRouterRemoveRoute( otInstance *aInstance, const otIp6Prefix *aPrefix )
Удалите конфигурацию внешнего маршрута из данных локальной сети.
Подробности | |||||
---|---|---|---|---|---|
Параметры |
| ||||
Возвращаемые значения |
|
otBorderRouterAddRoute
otBorderRouterRegister
otBorderRoutingGetNat64Prefix
otError otBorderRoutingGetNat64Prefix( otInstance *aInstance, otIp6Prefix *aPrefix )
Эта функция возвращает локальный префикс NAT64.
Этот префикс может не рекламироваться в сети Thread.
Эта функция доступна только при OPENTHREAD_CONFIG_BORDER_ROUTING_NAT64_ENABLE
.
Подробности | |||||
---|---|---|---|---|---|
Параметры |
| ||||
Возвращаемые значения |
|
otBorderRoutingGetOmrPrefix
otError otBorderRoutingGetOmrPrefix( otInstance *aInstance, otIp6Prefix *aPrefix )
Этот метод возвращает префикс маршрутизации вне сети (OMR).
Случайно сгенерированный 64-разрядный префикс будет опубликован в сети Thread, если префикс OMR еще не создан.
Подробности | |||||
---|---|---|---|---|---|
Параметры |
| ||||
Возвращаемые значения |
|
otBorderRoutingGetOnLinkPrefix
otError otBorderRoutingGetOnLinkPrefix( otInstance *aInstance, otIp6Prefix *aPrefix )
Этот метод возвращает префикс on-link для соседнего инфраструктурного канала.
Случайно сгенерированный 64-разрядный префикс будет объявлен в инфраструктурной ссылке, если в ссылке еще не объявлен пригодный для использования префикс ссылки.
Подробности | |||||
---|---|---|---|---|---|
Параметры |
| ||||
Возвращаемые значения |
|
otBorderRoutingInit
otError otBorderRoutingInit( otInstance *aInstance, uint32_t aInfraIfIndex, bool aInfraIfIsRunning )
Этот метод инициализирует диспетчер пограничной маршрутизации на заданном интерфейсе инфраструктуры.
Подробности | |||||||||
---|---|---|---|---|---|---|---|---|---|
Параметры |
| ||||||||
Возвращаемые значения |
|
otPlatInfraIfStateChanged .
отбордерраутингсетенаблед
otError otBorderRoutingSetEnabled( otInstance *aInstance, bool aEnabled )
Этот метод включает/отключает диспетчер пограничной маршрутизации.
Подробности | |||||
---|---|---|---|---|---|
Параметры |
| ||||
Возвращаемые значения |
|
Ресурсы
Разделы справочника по API OpenThread взяты из исходного кода, доступного на GitHub . Чтобы получить дополнительную информацию или внести свой вклад в нашу документацию, обратитесь к разделу Ресурсы .