Functions | |
OTAPI otError OTCALL | otBorderRouterGetNetData (otInstance *aInstance, bool aStable, uint8_t *aData, uint8_t *aDataLength) |
OTAPI otError OTCALL | otBorderRouterAddOnMeshPrefix (otInstance *aInstance, const otBorderRouterConfig *aConfig) |
OTAPI otError OTCALL | otBorderRouterRemoveOnMeshPrefix (otInstance *aInstance, const otIp6Prefix *aPrefix) |
OTAPI otError OTCALL | otBorderRouterGetNextOnMeshPrefix (otInstance *aInstance, otNetworkDataIterator *aIterator, otBorderRouterConfig *aConfig) |
OTAPI otError OTCALL | otBorderRouterAddRoute (otInstance *aInstance, const otExternalRouteConfig *aConfig) |
OTAPI otError OTCALL | otBorderRouterRemoveRoute (otInstance *aInstance, const otIp6Prefix *aPrefix) |
otError | otBorderRouterGetNextRoute (otInstance *aInstance, otNetworkDataIterator *aIterator, otExternalRouteConfig *aConfig) |
OTAPI otError OTCALL | otBorderRouterRegister (otInstance *aInstance) |
OTAPI otError OTCALL otBorderRouterAddOnMeshPrefix | ( | otInstance * | aInstance, |
const otBorderRouterConfig * | aConfig | ||
) |
Add a border router configuration to the local network data.
[in] | aInstance | A pointer to an OpenThread instance. |
[in] | aConfig | A pointer to the border router configuration. |
OT_ERROR_NONE | Successfully added the configuration to the local network data. |
OT_ERROR_INVALID_ARGS | One or more configuration parameters were invalid. |
OT_ERROR_NO_BUFS | Not enough room is available to add the configuration to the local network data. |
OTAPI otError OTCALL otBorderRouterAddRoute | ( | otInstance * | aInstance, |
const otExternalRouteConfig * | aConfig | ||
) |
Add an external route configuration to the local network data.
[in] | aInstance | A pointer to an OpenThread instance. |
[in] | aConfig | A pointer to the external route configuration. |
OT_ERROR_NONE | Successfully added the configuration to the local network data. |
OT_ERROR_INVALID_ARGS | One or more configuration parameters were invalid. |
OT_ERROR_NO_BUFS | Not enough room is available to add the configuration to the local network data. |
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.
[in] | aInstance | A pointer to an OpenThread instance. |
[in] | aStable | TRUE when copying the stable version, FALSE when copying the full version. |
[out] | aData | A pointer to the data buffer. |
[in,out] | aDataLength | On entry, size of the data buffer pointed to by aData . On exit, number of copied bytes. |
OTAPI otError OTCALL otBorderRouterGetNextOnMeshPrefix | ( | otInstance * | aInstance, |
otNetworkDataIterator * | aIterator, | ||
otBorderRouterConfig * | aConfig | ||
) |
This function gets the next On Mesh Prefix in the local Network Data.
[in] | aInstance | A pointer to an OpenThread instance. |
[in,out] | aIterator | A pointer to the Network Data iterator context. To get the first on-mesh entry it should be set to OT_NETWORK_DATA_ITERATOR_INIT. |
[out] | aConfig | A pointer to where the On Mesh Prefix information will be placed. |
OT_ERROR_NONE | Successfully found the next On Mesh prefix. |
OT_ERROR_NOT_FOUND | No subsequent On Mesh prefix exists in the Thread Network Data. |
otError otBorderRouterGetNextRoute | ( | otInstance * | aInstance, |
otNetworkDataIterator * | aIterator, | ||
otExternalRouteConfig * | aConfig | ||
) |
This function gets the next external route in the local Network Data.
[in] | aInstance | A pointer to an OpenThread instance. |
[in,out] | aIterator | A pointer to the Network Data iterator context. To get the first external route entry it should be set to OT_NETWORK_DATA_ITERATOR_INIT. |
[out] | aConfig | A pointer to where the External Route information will be placed. |
OT_ERROR_NONE | Successfully found the next External Route. |
OT_ERROR_NOT_FOUND | No subsequent external route entry exists in the Thread Network Data. |
Immediately register the local network data with the Leader.
[in] | aInstance | A pointer to an OpenThread instance. |
retval OT_ERROR_NONE Successfully queued a Server Data Request message for delivery.
OTAPI otError OTCALL otBorderRouterRemoveOnMeshPrefix | ( | otInstance * | aInstance, |
const otIp6Prefix * | aPrefix | ||
) |
Remove a border router configuration from the local network data.
[in] | aInstance | A pointer to an OpenThread instance. |
[in] | aPrefix | A pointer to an IPv6 prefix. |
OT_ERROR_NONE | Successfully removed the configuration from the local network data. |
OTAPI otError OTCALL otBorderRouterRemoveRoute | ( | otInstance * | aInstance, |
const otIp6Prefix * | aPrefix | ||
) |
Remove an external route configuration from the local network data.
[in] | aInstance | A pointer to an OpenThread instance. |
[in] | aPrefix | A pointer to an IPv6 prefix. |
OT_ERROR_NONE | Successfully removed the configuration from the local network data. |