Border Router
This module includes functions to manage local network data with the OpenThread Border Router.
Summary
Functions |
|
---|---|
otBorderRouterAddOnMeshPrefix(otInstance *aInstance, const otBorderRouterConfig *aConfig)
|
Add a border router configuration to the local network data.
|
otBorderRouterAddRoute(otInstance *aInstance, const otExternalRouteConfig *aConfig)
|
Add an external route configuration to the local network data.
|
otBorderRouterGetNetData(otInstance *aInstance, bool aStable, uint8_t *aData, uint8_t *aDataLength)
|
This method provides a full or stable copy of the local Thread Network Data.
|
otBorderRouterGetNextOnMeshPrefix(otInstance *aInstance, otNetworkDataIterator *aIterator, otBorderRouterConfig *aConfig)
|
This function gets the next On Mesh Prefix in the local Network Data.
|
otBorderRouterGetNextRoute(otInstance *aInstance, otNetworkDataIterator *aIterator, otExternalRouteConfig *aConfig)
|
This function gets the next external route in the local Network Data.
|
otBorderRouterRegister(otInstance *aInstance)
|
Immediately register the local network data with the Leader.
|
otBorderRouterRemoveOnMeshPrefix(otInstance *aInstance, const otIp6Prefix *aPrefix)
|
Remove a border router configuration from the local network data.
|
otBorderRouterRemoveRoute(otInstance *aInstance, const otIp6Prefix *aPrefix)
|
Remove an external route configuration from the local network data.
|
Functions
otBorderRouterAddOnMeshPrefix
OTAPI otError OTCALL otBorderRouterAddOnMeshPrefix( otInstance *aInstance, const otBorderRouterConfig *aConfig )
Add a border router configuration to the local network data.
Details | |||||||
---|---|---|---|---|---|---|---|
Parameters |
|
||||||
Return Values |
|
otBorderRouterRemoveOnMeshPrefix
otBorderRouterRegister
otBorderRouterAddRoute
OTAPI otError OTCALL otBorderRouterAddRoute( otInstance *aInstance, const otExternalRouteConfig *aConfig )
Add an external route configuration to the local network data.
Details | |||||||
---|---|---|---|---|---|---|---|
Parameters |
|
||||||
Return Values |
|
otBorderRouterRemoveRoute
otBorderRouterRegister
otBorderRouterGetNetData
OTAPI otError OTCALL otBorderRouterGetNetData( otInstance *aInstance, bool aStable, uint8_t *aData, uint8_t *aDataLength )
This method provides a full or stable copy of the local Thread Network Data.
Details | |||||||||
---|---|---|---|---|---|---|---|---|---|
Parameters |
|
otBorderRouterGetNextOnMeshPrefix
OTAPI otError OTCALL otBorderRouterGetNextOnMeshPrefix( otInstance *aInstance, otNetworkDataIterator *aIterator, otBorderRouterConfig *aConfig )
This function gets the next On Mesh Prefix in the local Network Data.
Details | |||||||
---|---|---|---|---|---|---|---|
Parameters |
|
||||||
Return Values |
|
otBorderRouterGetNextRoute
OTAPI otError OTCALL otBorderRouterGetNextRoute( otInstance *aInstance, otNetworkDataIterator *aIterator, otExternalRouteConfig *aConfig )
This function gets the next external route in the local Network Data.
Details | |||||||
---|---|---|---|---|---|---|---|
Parameters |
|
||||||
Return Values |
|
otBorderRouterRegister
OTAPI otError OTCALL otBorderRouterRegister( otInstance *aInstance )
Immediately register the local network data with the Leader.
Details | |||
---|---|---|---|
Parameters |
|
||
Return Values |
|
otBorderRouterAddOnMeshPrefix
otBorderRouterRemoveOnMeshPrefix
otBorderRouterAddRoute
otBorderRouterRemoveRoute
otBorderRouterRemoveOnMeshPrefix
OTAPI otError OTCALL otBorderRouterRemoveOnMeshPrefix( otInstance *aInstance, const otIp6Prefix *aPrefix )
Remove a border router configuration from the local network data.
Details | |||||
---|---|---|---|---|---|
Parameters |
|
||||
Return Values |
|
otBorderRouterAddOnMeshPrefix
otBorderRouterRegister
otBorderRouterRemoveRoute
OTAPI otError OTCALL otBorderRouterRemoveRoute( otInstance *aInstance, const otIp6Prefix *aPrefix )
Remove an external route configuration from the local network data.
Details | |||||
---|---|---|---|---|---|
Parameters |
|
||||
Return Values |
|
otBorderRouterAddRoute
otBorderRouterRegister