dataset.h File Reference

Detailed Description

This file defines the OpenThread Operational Dataset API (for both FTD and MTD).

#include <openthread/instance.h>
#include <openthread/ip6.h>
#include <openthread/platform/crypto.h>
#include <openthread/platform/radio.h>

Include dependency graph for dataset.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures
struct	otExtendedPanId
struct	otNetworkKey
struct	otNetworkName
struct	otOperationalDataset
struct	otOperationalDatasetComponents
struct	otOperationalDatasetTlvs
struct	otPskc
struct	otSecurityPolicy
struct	otTimestamp

Macros
#define	OT_CHANNEL_10_MASK   (1 << 10)
	Channel 10. More...
#define	OT_CHANNEL_11_MASK   (1 << 11)
	Channel 11. More...
#define	OT_CHANNEL_12_MASK   (1 << 12)
	Channel 12. More...
#define	OT_CHANNEL_13_MASK   (1 << 13)
	Channel 13. More...
#define	OT_CHANNEL_14_MASK   (1 << 14)
	Channel 14. More...
#define	OT_CHANNEL_15_MASK   (1 << 15)
	Channel 15. More...
#define	OT_CHANNEL_16_MASK   (1 << 16)
	Channel 16. More...
#define	OT_CHANNEL_17_MASK   (1 << 17)
	Channel 17. More...
#define	OT_CHANNEL_18_MASK   (1 << 18)
	Channel 18. More...
#define	OT_CHANNEL_19_MASK   (1 << 19)
	Channel 19. More...
#define	OT_CHANNEL_1_MASK   (1 << 1)
	Channel 1. More...
#define	OT_CHANNEL_20_MASK   (1 << 20)
	Channel 20. More...
#define	OT_CHANNEL_21_MASK   (1 << 21)
	Channel 21. More...
#define	OT_CHANNEL_22_MASK   (1 << 22)
	Channel 22. More...
#define	OT_CHANNEL_23_MASK   (1 << 23)
	Channel 23. More...
#define	OT_CHANNEL_24_MASK   (1 << 24)
	Channel 24. More...
#define	OT_CHANNEL_25_MASK   (1 << 25)
	Channel 25. More...
#define	OT_CHANNEL_26_MASK   (1 << 26)
	Channel 26. More...
#define	OT_CHANNEL_2_MASK   (1 << 2)
	Channel 2. More...
#define	OT_CHANNEL_3_MASK   (1 << 3)
	Channel 3. More...
#define	OT_CHANNEL_4_MASK   (1 << 4)
	Channel 4. More...
#define	OT_CHANNEL_5_MASK   (1 << 5)
	Channel 5. More...
#define	OT_CHANNEL_6_MASK   (1 << 6)
	Channel 6. More...
#define	OT_CHANNEL_7_MASK   (1 << 7)
	Channel 7. More...
#define	OT_CHANNEL_8_MASK   (1 << 8)
	Channel 8. More...
#define	OT_CHANNEL_9_MASK   (1 << 9)
	Channel 9. More...
#define	OT_EXT_PAN_ID_SIZE   8
	Size of a Thread PAN ID (bytes) More...
#define	OT_MESH_LOCAL_PREFIX_SIZE   OT_IP6_PREFIX_SIZE
	Size of the Mesh Local Prefix (bytes) More...
#define	OT_NETWORK_KEY_SIZE   16
	Size of the Thread Network Key (bytes) More...
#define	OT_NETWORK_NAME_MAX_SIZE   16
	Maximum size of the Thread Network Name field (bytes) More...
#define	OT_OPERATIONAL_DATASET_MAX_LENGTH   254
#define	OT_PSKC_MAX_SIZE   16
	Maximum size of the PSKc (bytes) More...

Typedefs
typedef uint32_t	otChannelMask
typedef void(*	otDatasetMgmtSetCallback) (otError aResult, void *aContext)
typedef struct otExtendedPanId	otExtendedPanId
typedef enum otMeshcopTlvType	otMeshcopTlvType
typedef otIp6NetworkPrefix	otMeshLocalPrefix
typedef struct otNetworkKey	otNetworkKey
typedef otCryptoKeyRef	otNetworkKeyRef
	Reference to Key. More...
typedef struct otNetworkName	otNetworkName
typedef struct otOperationalDataset	otOperationalDataset
typedef struct otOperationalDatasetComponents	otOperationalDatasetComponents
typedef struct otOperationalDatasetTlvs	otOperationalDatasetTlvs
typedef struct otPskc	otPskc
typedef otCryptoKeyRef	otPskcRef
	Reference to Key. More...
typedef struct otSecurityPolicy	otSecurityPolicy
typedef struct otTimestamp	otTimestamp

Enumerations
enum	otMeshcopTlvType {   OT_MESHCOP_TLV_CHANNEL = 0, OT_MESHCOP_TLV_PANID = 1, OT_MESHCOP_TLV_EXTPANID = 2, OT_MESHCOP_TLV_NETWORKNAME = 3,   OT_MESHCOP_TLV_PSKC = 4, OT_MESHCOP_TLV_NETWORKKEY = 5, OT_MESHCOP_TLV_NETWORK_KEY_SEQUENCE = 6, OT_MESHCOP_TLV_MESHLOCALPREFIX = 7,   OT_MESHCOP_TLV_STEERING_DATA = 8, OT_MESHCOP_TLV_BORDER_AGENT_RLOC = 9, OT_MESHCOP_TLV_COMMISSIONER_ID = 10, OT_MESHCOP_TLV_COMM_SESSION_ID = 11,   OT_MESHCOP_TLV_SECURITYPOLICY = 12, OT_MESHCOP_TLV_GET = 13, OT_MESHCOP_TLV_ACTIVETIMESTAMP = 14, OT_MESHCOP_TLV_COMMISSIONER_UDP_PORT = 15,   OT_MESHCOP_TLV_STATE = 16, OT_MESHCOP_TLV_JOINER_DTLS = 17, OT_MESHCOP_TLV_JOINER_UDP_PORT = 18, OT_MESHCOP_TLV_JOINER_IID = 19,   OT_MESHCOP_TLV_JOINER_RLOC = 20, OT_MESHCOP_TLV_JOINER_ROUTER_KEK = 21, OT_MESHCOP_TLV_PROVISIONING_URL = 32, OT_MESHCOP_TLV_VENDOR_NAME_TLV = 33,   OT_MESHCOP_TLV_VENDOR_MODEL_TLV = 34, OT_MESHCOP_TLV_VENDOR_SW_VERSION_TLV = 35, OT_MESHCOP_TLV_VENDOR_DATA_TLV = 36, OT_MESHCOP_TLV_VENDOR_STACK_VERSION_TLV = 37,   OT_MESHCOP_TLV_UDP_ENCAPSULATION_TLV = 48, OT_MESHCOP_TLV_IPV6_ADDRESS_TLV = 49, OT_MESHCOP_TLV_PENDINGTIMESTAMP = 51, OT_MESHCOP_TLV_DELAYTIMER = 52,   OT_MESHCOP_TLV_CHANNELMASK = 53, OT_MESHCOP_TLV_COUNT = 54, OT_MESHCOP_TLV_PERIOD = 55, OT_MESHCOP_TLV_SCAN_DURATION = 56,   OT_MESHCOP_TLV_ENERGY_LIST = 57, OT_MESHCOP_TLV_DISCOVERYREQUEST = 128, OT_MESHCOP_TLV_DISCOVERYRESPONSE = 129, OT_MESHCOP_TLV_JOINERADVERTISEMENT = 241 }

Functions
otError	otDatasetGeneratePskc (const char *aPassPhrase, const otNetworkName *aNetworkName, const otExtendedPanId *aExtPanId, otPskc *aPskc)
otError	otDatasetGetActive (otInstance *aInstance, otOperationalDataset *aDataset)
otError	otDatasetGetActiveTlvs (otInstance *aInstance, otOperationalDatasetTlvs *aDataset)
otError	otDatasetGetPending (otInstance *aInstance, otOperationalDataset *aDataset)
otError	otDatasetGetPendingTlvs (otInstance *aInstance, otOperationalDatasetTlvs *aDataset)
bool	otDatasetIsCommissioned (otInstance *aInstance)
otError	otDatasetParseTlvs (const otOperationalDatasetTlvs *aDatasetTlvs, otOperationalDataset *aDataset)
otError	otDatasetSendMgmtActiveGet (otInstance *aInstance, const otOperationalDatasetComponents *aDatasetComponents, const uint8_t *aTlvTypes, uint8_t aLength, const otIp6Address *aAddress)
otError	otDatasetSendMgmtActiveSet (otInstance *aInstance, const otOperationalDataset *aDataset, const uint8_t *aTlvs, uint8_t aLength, otDatasetMgmtSetCallback aCallback, void *aContext)
otError	otDatasetSendMgmtPendingGet (otInstance *aInstance, const otOperationalDatasetComponents *aDatasetComponents, const uint8_t *aTlvTypes, uint8_t aLength, const otIp6Address *aAddress)
otError	otDatasetSendMgmtPendingSet (otInstance *aInstance, const otOperationalDataset *aDataset, const uint8_t *aTlvs, uint8_t aLength, otDatasetMgmtSetCallback aCallback, void *aContext)
otError	otDatasetSetActive (otInstance *aInstance, const otOperationalDataset *aDataset)
otError	otDatasetSetActiveTlvs (otInstance *aInstance, const otOperationalDatasetTlvs *aDataset)
otError	otDatasetSetPending (otInstance *aInstance, const otOperationalDataset *aDataset)
otError	otDatasetSetPendingTlvs (otInstance *aInstance, const otOperationalDatasetTlvs *aDataset)
otError	otNetworkNameFromString (otNetworkName *aNetworkName, const char *aNameString)

Variables
OT_TOOL_PACKED_BEGIN struct otNetworkKey	OT_TOOL_PACKED_END