This module includes functions for Operational Dataset configuration. More...

Functions
OTAPI bool OTCALL	otDatasetIsCommissioned (otInstance *aInstance)

OTAPI ThreadError OTCALL	otDatasetGetActive (otInstance aInstance, otOperationalDataset aDataset)

OTAPI ThreadError OTCALL	otDatasetSetActive (otInstance aInstance, const otOperationalDataset aDataset)

OTAPI ThreadError OTCALL	otDatasetGetPending (otInstance aInstance, otOperationalDataset aDataset)

OTAPI ThreadError OTCALL	otDatasetSetPending (otInstance aInstance, const otOperationalDataset aDataset)

OTAPI ThreadError OTCALL	otDatasetSendMgmtActiveGet (otInstance aInstance, const uint8_t aTlvTypes, uint8_t aLength, const otIp6Address *aAddress)

OTAPI ThreadError OTCALL	otDatasetSendMgmtActiveSet (otInstance aInstance, const otOperationalDataset aDataset, const uint8_t *aTlvs, uint8_t aLength)

OTAPI ThreadError OTCALL	otDatasetSendMgmtPendingGet (otInstance aInstance, const uint8_t aTlvTypes, uint8_t aLength, const otIp6Address *aAddress)

OTAPI ThreadError OTCALL	otDatasetSendMgmtPendingSet (otInstance aInstance, const otOperationalDataset aDataset, const uint8_t *aTlvs, uint8_t aLength)

OTAPI uint32_t OTCALL	otDatasetGetDelayTimerMinimal (otInstance *aInstance)

OTAPI ThreadError OTCALL	otDatasetSetDelayTimerMinimal (otInstance *aInstance, uint32_t aDelayTimerMinimal)

Detailed Description

This module includes functions for Operational Dataset configuration.

Function Documentation

OTAPI ThreadError OTCALL otDatasetGetActive	(	otInstance *	aInstance,
		otOperationalDataset *	aDataset
	)

This function gets the Active Operational Dataset.

Parameters

[in]	aInstance	A pointer to an OpenThread instance.
[out]	aDataset	A pointer to where the Active Operational Dataset will be placed.

Return values

kThreadError_None	Successfully retrieved the Active Operational Dataset.
kThreadError_InvalidArgs	`aDataset` was NULL.

OTAPI uint32_t OTCALL otDatasetGetDelayTimerMinimal ( otInstance * aInstance )

Get minimal delay timer.

Parameters

[in] aInstance A pointer to an OpenThread instance.

Return values

the	value of minimal delay timer (in ms).

OTAPI ThreadError OTCALL otDatasetGetPending	(	otInstance *	aInstance,
		otOperationalDataset *	aDataset
	)

This function gets the Pending Operational Dataset.

Parameters

[in]	aInstance	A pointer to an OpenThread instance.
[out]	aDataset	A pointer to where the Pending Operational Dataset will be placed.

Return values

kThreadError_None	Successfully retrieved the Pending Operational Dataset.
kThreadError_InvalidArgs	`aDataset` was NULL.

OTAPI bool OTCALL otDatasetIsCommissioned ( otInstance * aInstance )

This function indicates whether a valid network is present in the Active Operational Dataset or not.

Parameters

[in] aInstance A pointer to an OpenThread instance.

Returns: TRUE if a valid network is present in the Active Operational Dataset, FALSE otherwise.

OTAPI ThreadError OTCALL otDatasetSendMgmtActiveGet	(	otInstance *	aInstance,
		const uint8_t *	aTlvTypes,
		uint8_t	aLength,
		const otIp6Address *	aAddress
	)

This function sends MGMT_ACTIVE_GET.

Parameters

[in]	aInstance	A pointer to an OpenThread instance.
[in]	aTlvTypes	A pointer to the TLV Types.
[in]	aLength	The length of TLV Types.
[in]	aAddress	A pointer to the IPv6 destination, if it is NULL, will use Leader ALOC as default.

Return values

kThreadError_None	Successfully send the meshcop dataset command.
kThreadError_NoBufs	Insufficient buffer space to send.

OTAPI ThreadError OTCALL otDatasetSendMgmtActiveSet	(	otInstance *	aInstance,
		const otOperationalDataset *	aDataset,
		const uint8_t *	aTlvs,
		uint8_t	aLength
	)

This function sends MGMT_ACTIVE_SET.

Parameters

[in]	aInstance	A pointer to an OpenThread instance.
[in]	aDataset	A pointer to operational dataset.
[in]	aTlvs	A pointer to TLVs.
[in]	aLength	The length of TLVs.

Return values

kThreadError_None	Successfully send the meshcop dataset command.
kThreadError_NoBufs	Insufficient buffer space to send.

OTAPI ThreadError OTCALL otDatasetSendMgmtPendingGet	(	otInstance *	aInstance,
		const uint8_t *	aTlvTypes,
		uint8_t	aLength,
		const otIp6Address *	aAddress
	)

This function sends MGMT_PENDING_GET.

Parameters

[in]	aInstance	A pointer to an OpenThread instance.
[in]	aTlvTypes	A pointer to the TLV Types.
[in]	aLength	The length of TLV Types.
[in]	aAddress	A pointer to the IPv6 destination, if it is NULL, will use Leader ALOC as default.

Return values

kThreadError_None	Successfully send the meshcop dataset command.
kThreadError_NoBufs	Insufficient buffer space to send.

OTAPI ThreadError OTCALL otDatasetSendMgmtPendingSet	(	otInstance *	aInstance,
		const otOperationalDataset *	aDataset,
		const uint8_t *	aTlvs,
		uint8_t	aLength
	)

This function sends MGMT_PENDING_SET.

Parameters

[in]	aInstance	A pointer to an OpenThread instance.
[in]	aDataset	A pointer to operational dataset.
[in]	aTlvs	A pointer to TLVs.
[in]	aLength	The length of TLVs.

Return values

kThreadError_None	Successfully send the meshcop dataset command.
kThreadError_NoBufs	Insufficient buffer space to send.

OTAPI ThreadError OTCALL otDatasetSetActive	(	otInstance *	aInstance,
		const otOperationalDataset *	aDataset
	)

This function sets the Active Operational Dataset.

Parameters

[in]	aInstance	A pointer to an OpenThread instance.
[in]	aDataset	A pointer to the Active Operational Dataset.

Return values

kThreadError_None	Successfully set the Active Operational Dataset.
kThreadError_NoBufs	Insufficient buffer space to set the Active Operational Datset.
kThreadError_InvalidArgs	`aDataset` was NULL.

OTAPI ThreadError OTCALL otDatasetSetDelayTimerMinimal	(	otInstance *	aInstance,
		uint32_t	aDelayTimerMinimal
	)

Set minimal delay timer.

Parameters

[in]	aInstance	A pointer to an OpenThread instance.
[in]	aDelayTimerMinimal	The value of minimal delay timer (in ms).

Return values

kThreadError_None	Successfully set minimal delay timer.
kThreadError_InvalidArgs	If `aDelayTimerMinimal` is not valid.

OTAPI ThreadError OTCALL otDatasetSetPending	(	otInstance *	aInstance,
		const otOperationalDataset *	aDataset
	)

This function sets the Pending Operational Dataset.

Parameters

[in]	aInstance	A pointer to an OpenThread instance.
[in]	aDataset	A pointer to the Pending Operational Dataset.

Return values

kThreadError_None	Successfully set the Pending Operational Dataset.
kThreadError_NoBufs	Insufficient buffer space to set the Pending Operational Dataset.
kThreadError_InvalidArgs	`aDataset` was NULL.

Functions

Detailed Description

Function Documentation