Router/Leader

This module includes functions that manage configuration parameters for the Thread Router and Leader roles. More...

Functions
OTAPI uint8_t OTCALL	otThreadGetLocalLeaderWeight (otInstance *aInstance)
OTAPI void OTCALL	otThreadSetLocalLeaderWeight (otInstance *aInstance, uint8_t aWeight)
OTAPI uint32_t OTCALL	otThreadGetLocalLeaderPartitionId (otInstance *aInstance)
OTAPI void OTCALL	otThreadSetLocalLeaderPartitionId (otInstance *aInstance, uint32_t aPartitionId)
OTAPI uint16_t OTCALL	otThreadGetJoinerUdpPort (otInstance *aInstance)
OTAPI ThreadError OTCALL	otThreadSetJoinerUdpPort (otInstance *aInstance, uint16_t aJoinerUdpPort)

Detailed Description

This module includes functions that manage configuration parameters for the Thread Router and Leader roles.

Function Documentation

OTAPI uint16_t OTCALL otThreadGetJoinerUdpPort

(

otInstance *

aInstance

)

Get the Joiner UDP Port.

Parameters

[in]

aInstance

A pointer to an OpenThread instance.

Returns

The Joiner UDP Port number.

See Also

otThreadSetJoinerUdpPort

OTAPI uint32_t OTCALL otThreadGetLocalLeaderPartitionId

(

otInstance *

aInstance

)

Get the Thread Leader Partition Id used when operating in the Leader role.

Parameters

[in]

aInstance

A pointer to an OpenThread instance.

Returns

The Thread Leader Partition Id value.

OTAPI uint8_t OTCALL otThreadGetLocalLeaderWeight

(

otInstance *

aInstance

)

Get the Thread Leader Weight used when operating in the Leader role.

Parameters

[in]

aInstance

A pointer to an OpenThread instance.

Returns

The Thread Leader Weight value.

See Also

otThreadSetLeaderWeight

OTAPI ThreadError OTCALL otThreadSetJoinerUdpPort	(	otInstance *	aInstance,
		uint16_t	aJoinerUdpPort
	)

Set the Joiner UDP Port

Parameters

[in]	aInstance	A pointer to an OpenThread instance.
[in]	aJoinerUdpPort	The Joiner UDP Port number.

Return values

kThreadErrorNone

Successfully set the Joiner UDP Port.

See Also

otThreadGetJoinerUdpPort

OTAPI void OTCALL otThreadSetLocalLeaderPartitionId	(	otInstance *	aInstance,
		uint32_t	aPartitionId
	)

Set the Thread Leader Partition Id used when operating in the Leader role.

Parameters

[in]	aInstance	A pointer to an OpenThread instance.
[in]	aPartitionId	The Thread Leader Partition Id value.

OTAPI void OTCALL otThreadSetLocalLeaderWeight	(	otInstance *	aInstance,
		uint8_t	aWeight
	)

Set the Thread Leader Weight used when operating in the Leader role.

Parameters

[in]	aInstance	A pointer to an OpenThread instance.
[in]	aWeight	The Thread Leader Weight value..

See Also

otThreadGetLeaderWeight