This module includes functions that control Network Data configuration. More...

Functions
OTAPI ThreadError OTCALL	otNetDataGetLeader (otInstance aInstance, bool aStable, uint8_t aData, uint8_t *aDataLength)

OTAPI ThreadError OTCALL	otNetDataGetLocal (otInstance aInstance, bool aStable, uint8_t aData, uint8_t *aDataLength)

OTAPI ThreadError OTCALL	otNetDataGetNextPrefixInfo (otInstance aInstance, bool aLocal, otNetworkDataIterator aIterator, otBorderRouterConfig *aConfig)

OTAPI ThreadError OTCALL	otNetDataAddPrefixInfo (otInstance aInstance, const otBorderRouterConfig aConfig)

OTAPI ThreadError OTCALL	otNetDataRemovePrefixInfo (otInstance aInstance, const otIp6Prefix aPrefix)

OTAPI ThreadError OTCALL	otNetDataAddRoute (otInstance aInstance, const otExternalRouteConfig aConfig)

OTAPI ThreadError OTCALL	otNetDataRemoveRoute (otInstance aInstance, const otIp6Prefix aPrefix)

OTAPI ThreadError OTCALL	otNetDataRegister (otInstance *aInstance)

OTAPI uint8_t OTCALL	otNetDataGetVersion (otInstance *aInstance)

OTAPI uint8_t OTCALL	otNetDataGetStableVersion (otInstance *aInstance)

Detailed Description

This module includes functions that control Network Data configuration.

Function Documentation

OTAPI ThreadError OTCALL otNetDataAddPrefixInfo	(	otInstance *	aInstance,
		const otBorderRouterConfig *	aConfig
	)

Add a border router configuration to the local network data.

Parameters

[in]	aInstance	A pointer to an OpenThread instance.
[in]	aConfig	A pointer to the border router configuration.

Return values

kThreadErrorNone	Successfully added the configuration to the local network data.
kThreadErrorInvalidArgs	One or more configuration parameters were invalid.
kThreadErrorSize	Not enough room is available to add the configuration to the local network data.

See Also: otRemoveBorderRouter; otSendServerData

OTAPI ThreadError OTCALL otNetDataAddRoute	(	otInstance *	aInstance,
		const otExternalRouteConfig *	aConfig
	)

Add an external route configuration to the local network data.

Parameters

[in]	aInstance	A pointer to an OpenThread instance.
[in]	aConfig	A pointer to the external route configuration.

Return values

kThreadErrorNone	Successfully added the configuration to the local network data.
kThreadErrorInvalidArgs	One or more configuration parameters were invalid.
kThreadErrorSize	Not enough room is available to add the configuration to the local network data.

See Also: otRemoveExternalRoute; otSendServerData

OTAPI ThreadError OTCALL otNetDataGetLeader	(	otInstance *	aInstance,
		bool	aStable,
		uint8_t *	aData,
		uint8_t *	aDataLength
	)

This method provides a full or stable copy of the Leader's Thread Network Data.

Parameters

[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 ThreadError OTCALL otNetDataGetLocal	(	otInstance *	aInstance,
		bool	aStable,
		uint8_t *	aData,
		uint8_t *	aDataLength
	)

This method provides a full or stable copy of the local Thread Network Data.

Parameters

[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 ThreadError OTCALL otNetDataGetNextPrefixInfo	(	otInstance *	aInstance,
		bool	aLocal,
		otNetworkDataIterator *	aIterator,
		otBorderRouterConfig *	aConfig
	)

This function gets the next On Mesh Prefix in the Network Data.

Parameters

[in]	aInstance	A pointer to an OpenThread instance.
[in]	aLocal	TRUE to retrieve from the local Network Data, FALSE for partition's Network Data
[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.

Return values

kThreadError_None	Successfully found the next On Mesh prefix.
kThreadError_NotFound	No subsequent On Mesh prefix exists in the Thread Network Data.

OTAPI uint8_t OTCALL otNetDataGetStableVersion ( otInstance * aInstance )

Get the Stable Network Data Version.

Parameters

[in] aInstance A pointer to an OpenThread instance.

Returns: The Stable Network Data Version.

OTAPI uint8_t OTCALL otNetDataGetVersion ( otInstance * aInstance )

Get the Network Data Version.

Parameters

[in] aInstance A pointer to an OpenThread instance.

Returns: The Network Data Version.

OTAPI ThreadError OTCALL otNetDataRegister ( otInstance * aInstance )

Immediately register the local network data with the Leader.

Parameters

[in] aInstance A pointer to an OpenThread instance.

retval kThreadErrorNone Successfully queued a Server Data Request message for delivery.

See Also: otAddBorderRouter; otRemoveBorderRouter; otAddExternalRoute; otRemoveExternalRoute

OTAPI ThreadError OTCALL otNetDataRemovePrefixInfo	(	otInstance *	aInstance,
		const otIp6Prefix *	aPrefix
	)

Remove a border router configuration from the local network data.

Parameters

[in]	aInstance	A pointer to an OpenThread instance.
[in]	aPrefix	A pointer to an IPv6 prefix.

Return values

kThreadErrorNone Successfully removed the configuration from the local network data.

See Also: otAddBorderRouter; otSendServerData

OTAPI ThreadError OTCALL otNetDataRemoveRoute	(	otInstance *	aInstance,
		const otIp6Prefix *	aPrefix
	)

Remove an external route configuration from the local network data.

Parameters

[in]	aInstance	A pointer to an OpenThread instance.
[in]	aPrefix	A pointer to an IPv6 prefix.

Return values

kThreadErrorNone Successfully removed the configuration from the local network data.

See Also: otAddExternalRoute; otSendServerData

Functions

Detailed Description

Function Documentation