thread_ftd.h File Reference

This file defines the OpenThread Thread API (FTD only). More...

#include <openthread/link.h>
#include <openthread/message.h>
#include <openthread/types.h>

Go to the source code of this file.

Typedefs
typedef enum otThreadChildTableEvent	otThreadChildTableEvent
	This enumeration defines the constants used in otThreadChildTableCallback to indicate whether a child is added or removed.
typedef void(*	otThreadChildTableCallback) (otThreadChildTableEvent aEvent, const otChildInfo *aChildInfo)
	This function pointer is called to notify that a child is being added to or removed from child table. More...

Enumerations
enum	otThreadChildTableEvent {   OT_THREAD_CHILD_TABLE_EVENT_CHILD_ADDED,   OT_THREAD_CHILD_TABLE_EVENT_CHILD_REMOVED }
	This enumeration defines the constants used in otThreadChildTableCallback to indicate whether a child is added or removed. More...

Functions
OTAPI uint8_t OTCALL	otThreadGetMaxAllowedChildren (otInstance *aInstance)
	Get the maximum number of children currently allowed. More...
OTAPI otError OTCALL	otThreadSetMaxAllowedChildren (otInstance *aInstance, uint8_t aMaxChildren)
	Set the maximum number of children currently allowed. More...
OTAPI bool OTCALL	otThreadIsRouterRoleEnabled (otInstance *aInstance)
	This function indicates whether or not the Router Role is enabled. More...
OTAPI void OTCALL	otThreadSetRouterRoleEnabled (otInstance *aInstance, bool aEnabled)
	This function sets whether or not the Router Role is enabled. More...
OTAPI otError OTCALL	otThreadSetPreferredRouterId (otInstance *aInstance, uint8_t aRouterId)
	Set the preferred Router Id. More...
OTAPI uint8_t OTCALL	otThreadGetLocalLeaderWeight (otInstance *aInstance)
	Get the Thread Leader Weight used when operating in the Leader role. More...
OTAPI void OTCALL	otThreadSetLocalLeaderWeight (otInstance *aInstance, uint8_t aWeight)
	Set the Thread Leader Weight used when operating in the Leader role. More...
OTAPI uint32_t OTCALL	otThreadGetLocalLeaderPartitionId (otInstance *aInstance)
	Get the Thread Leader Partition Id used when operating in the Leader role. More...
OTAPI void OTCALL	otThreadSetLocalLeaderPartitionId (otInstance *aInstance, uint32_t aPartitionId)
	Set the Thread Leader Partition Id used when operating in the Leader role. More...
OTAPI uint16_t OTCALL	otThreadGetJoinerUdpPort (otInstance *aInstance)
	Get the Joiner UDP Port. More...
OTAPI otError OTCALL	otThreadSetJoinerUdpPort (otInstance *aInstance, uint16_t aJoinerUdpPort)
	Set the Joiner UDP Port. More...
otError	otThreadSetSteeringData (otInstance *aInstance, const otExtAddress *aExtAddress)
	Set Steering data out of band. More...
OTAPI uint32_t OTCALL	otThreadGetContextIdReuseDelay (otInstance *aInstance)
	Get the CONTEXT_ID_REUSE_DELAY parameter used in the Leader role. More...
OTAPI void OTCALL	otThreadSetContextIdReuseDelay (otInstance *aInstance, uint32_t aDelay)
	Set the CONTEXT_ID_REUSE_DELAY parameter used in the Leader role. More...
OTAPI uint8_t OTCALL	otThreadGetNetworkIdTimeout (otInstance *aInstance)
	Get the NETWORK_ID_TIMEOUT parameter used in the Router role. More...
OTAPI void OTCALL	otThreadSetNetworkIdTimeout (otInstance *aInstance, uint8_t aTimeout)
	Set the NETWORK_ID_TIMEOUT parameter used in the Leader role. More...
OTAPI uint8_t OTCALL	otThreadGetRouterUpgradeThreshold (otInstance *aInstance)
	Get the ROUTER_UPGRADE_THRESHOLD parameter used in the REED role. More...
OTAPI void OTCALL	otThreadSetRouterUpgradeThreshold (otInstance *aInstance, uint8_t aThreshold)
	Set the ROUTER_UPGRADE_THRESHOLD parameter used in the Leader role. More...
OTAPI otError OTCALL	otThreadReleaseRouterId (otInstance *aInstance, uint8_t aRouterId)
	Release a Router ID that has been allocated by the device in the Leader role. More...
OTAPI otError OTCALL	otThreadBecomeRouter (otInstance *aInstance)
	Attempt to become a router. More...
OTAPI otError OTCALL	otThreadBecomeLeader (otInstance *aInstance)
	Become a leader and start a new partition. More...
OTAPI uint8_t OTCALL	otThreadGetRouterDowngradeThreshold (otInstance *aInstance)
	Get the ROUTER_DOWNGRADE_THRESHOLD parameter used in the Router role. More...
OTAPI void OTCALL	otThreadSetRouterDowngradeThreshold (otInstance *aInstance, uint8_t aThreshold)
	Set the ROUTER_DOWNGRADE_THRESHOLD parameter used in the Leader role. More...
OTAPI uint8_t OTCALL	otThreadGetRouterSelectionJitter (otInstance *aInstance)
	Get the ROUTER_SELECTION_JITTER parameter used in the REED/Router role. More...
OTAPI void OTCALL	otThreadSetRouterSelectionJitter (otInstance *aInstance, uint8_t aRouterJitter)
	Set the ROUTER_SELECTION_JITTER parameter used in the REED/Router role. More...
OTAPI otError OTCALL	otThreadGetChildInfoById (otInstance *aInstance, uint16_t aChildId, otChildInfo *aChildInfo)
	The function retains diagnostic information for an attached Child by its Child ID or RLOC16. More...
OTAPI otError OTCALL	otThreadGetChildInfoByIndex (otInstance *aInstance, uint8_t aChildIndex, otChildInfo *aChildInfo)
	The function retains diagnostic information for an attached Child by the internal table index. More...
OTAPI uint8_t OTCALL	otThreadGetRouterIdSequence (otInstance *aInstance)
	Get the current Router ID Sequence. More...
uint8_t	otThreadGetMaxRouterId (otInstance *aInstance)
	The function returns the maximum allowed router ID. More...
OTAPI otError OTCALL	otThreadGetRouterInfo (otInstance *aInstance, uint16_t aRouterId, otRouterInfo *aRouterInfo)
	The function retains diagnostic information for a given Thread Router. More...
OTAPI otError OTCALL	otThreadGetEidCacheEntry (otInstance *aInstance, uint8_t aIndex, otEidCacheEntry *aEntry)
	This function gets an EID cache entry. More...
OTAPI const uint8_t *OTCALL	otThreadGetPSKc (otInstance *aInstance)
	Get the thrPSKc. More...
OTAPI otError OTCALL	otThreadSetPSKc (otInstance *aInstance, const uint8_t *aPSKc)
	Set the thrPSKc. More...
OTAPI int8_t OTCALL	otThreadGetParentPriority (otInstance *aInstance)
	Get the assigned parent priority. More...
OTAPI otError OTCALL	otThreadSetParentPriority (otInstance *aInstance, int8_t aParentPriority)
	Set the parent priority. More...
otThreadChildTableCallback	otThreadGetChildTableCallback (otInstance *aInstance)
	This function gets the child table callback function. More...
void	otThreadSetChildTableCallback (otInstance *aInstance, otThreadChildTableCallback aCallback)
	This function sets the child table callback function. More...

Detailed Description

This file defines the OpenThread Thread API (FTD only).