操作數據集

該模塊包括用於數據集更新程序的功能。

概要

啟用數據集更新程序功能（即OPENTHREAD_CONFIG_DATASET_UPDATER_ENABLE設置為1）時，此模塊中的功能可用。此外，此功能僅在FTD構建上可用。

枚舉
`anonymous enum { OT_SECURITY_POLICY_OBTAIN_MASTER_KEY = 1 << 7, OT_SECURITY_POLICY_NATIVE_COMMISSIONING = 1 << 6, OT_SECURITY_POLICY_ROUTERS = 1 << 5, OT_SECURITY_POLICY_EXTERNAL_COMMISSIONER = 1 << 4, OT_SECURITY_POLICY_BEACONS = 1 << 3 }`	枚舉該枚舉定義了安全策略TLV標誌。
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_MASTERKEY = 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 }	枚舉此枚舉表示meshcop TLV類型。

枚舉

anonymous enum {
 OT_SECURITY_POLICY_OBTAIN_MASTER_KEY = 1 << 7,
 OT_SECURITY_POLICY_NATIVE_COMMISSIONING = 1 << 6,
 OT_SECURITY_POLICY_ROUTERS = 1 << 5,
 OT_SECURITY_POLICY_EXTERNAL_COMMISSIONER = 1 << 4,
 OT_SECURITY_POLICY_BEACONS = 1 << 3
 }

枚舉

該枚舉定義了安全策略TLV標誌。

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_MASTERKEY = 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
 }

枚舉

此枚舉表示meshcop TLV類型。

類型定義
`otChannelMask`	類型定義 `uint32_t` 此類型表示通道掩碼。
`otDatasetUpdaterCallback )(otError aError, void *aContext)`	類型定義 `void(*` 當數據集更新請求完成時，將報告此數據集更新請求的成功或失敗狀態，從而調用此回調函數指針。
`otExtendedPanId`	類型定義 `struct otExtendedPanId` 此結構表示擴展PAN ID。
`otMasterKey`	類型定義 `struct otMasterKey` 此結構表示線程主密鑰。
`otMeshLocalPrefix`	類型定義 `otIp6NetworkPrefix` 該結構表示網格局部前綴。
`otMeshcopTlvType`	類型定義 `enum otMeshcopTlvType` 此枚舉表示meshcop TLV類型。
`otNetworkName`	類型定義 `struct otNetworkName` 此結構表示網絡名稱。
`otOperationalDataset`	類型定義 `struct otOperationalDataset` 此結構表示活動或待處理的操作數據集。
`otOperationalDatasetComponents`	類型定義 `struct otOperationalDatasetComponents` 此結構表示“活動”或“待處理”操作數據集中不同組件的存在。
`otOperationalDatasetTlvs`	類型定義 `struct otOperationalDatasetTlvs` 此結構表示活動或待處理的操作數據集。
`otPskc`	類型定義 `struct otPskc` 該結構表示PSKc。
`otSecurityPolicy`	類型定義 `struct otSecurityPolicy` 此結構表示安全策略。

變數
`OT_TOOL_PACKED_END`	`OT_TOOL_PACKED_BEGIN struct otMasterKey`

職能
`otDatasetCreateNewNetwork ( otInstance aInstance, otOperationalDataset aDataset)`	`otError` 此方法創建一個新的操作數據集，以在形成新網絡時使用。
`otDatasetGeneratePskc (const char aPassPhrase, const otNetworkName aNetworkName, const otExtendedPanId aExtPanId, otPskc aPskc)`	`otError` 此功能根據給定的密碼，網絡名稱和擴展的PAN ID生成PSKc。
`otDatasetGetActive ( otInstance aInstance, otOperationalDataset aDataset)`	`otError` 該函數獲取活動操作數據集。
`otDatasetGetActiveTlvs ( otInstance aInstance, otOperationalDatasetTlvs aDataset)`	`otError` 該函數獲取活動操作數據集。
`otDatasetGetDelayTimerMinimal ( otInstance *aInstance)`	`uint32_t` 獲得最少的延遲計時器。
`otDatasetGetPending ( otInstance aInstance, otOperationalDataset aDataset)`	`otError` 此函數獲取待處理的操作數據集。
`otDatasetGetPendingTlvs ( otInstance aInstance, otOperationalDatasetTlvs aDataset)`	`otError` 此函數獲取待處理的操作數據集。
`otDatasetIsCommissioned ( otInstance *aInstance)`	`bool` 此功能指示“活動操作數據集”中是否存在有效網絡。
`otDatasetSendMgmtActiveGet ( otInstance aInstance, const otOperationalDatasetComponents aDatasetComponents, const uint8_t aTlvTypes, uint8_t aLength, const otIp6Address aAddress)`	`otError` 該函數發送MGMT_ACTIVE_GET。
`otDatasetSendMgmtActiveSet ( otInstance aInstance, const otOperationalDataset aDataset, const uint8_t *aTlvs, uint8_t aLength)`	`otError` 該函數發送MGMT_ACTIVE_SET。
`otDatasetSendMgmtPendingGet ( otInstance aInstance, const otOperationalDatasetComponents aDatasetComponents, const uint8_t aTlvTypes, uint8_t aLength, const otIp6Address aAddress)`	`otError` 該函數發送MGMT_PENDING_GET。
`otDatasetSendMgmtPendingSet ( otInstance aInstance, const otOperationalDataset aDataset, const uint8_t *aTlvs, uint8_t aLength)`	`otError` 該函數發送MGMT_PENDING_SET。
`otDatasetSetActive ( otInstance aInstance, const otOperationalDataset aDataset)`	`otError` 此功能設置活動操作數據集。
`otDatasetSetActiveTlvs ( otInstance aInstance, const otOperationalDatasetTlvs aDataset)`	`otError` 此功能設置活動操作數據集。
`otDatasetSetDelayTimerMinimal ( otInstance *aInstance, uint32_t aDelayTimerMinimal)`	`otError` 設置最小延遲計時器。
`otDatasetSetPending ( otInstance aInstance, const otOperationalDataset aDataset)`	`otError` 此功能設置待處理的操作數據集。
`otDatasetSetPendingTlvs ( otInstance aInstance, const otOperationalDatasetTlvs aDataset)`	`otError` 此功能設置待處理的操作數據集。
`otDatasetUpdaterCancelUpdate ( otInstance *aInstance)`	`void` 此功能取消正在進行的（如果有的話）“操作數據集”更新請求。
`otDatasetUpdaterIsUpdateOngoing ( otInstance *aInstance)`	`bool` 此功能指示是否有正在進行的操作數據集更新請求。
`otDatasetUpdaterRequestUpdate ( otInstance aInstance, const otOperationalDataset aDataset, otDatasetUpdaterCallback aCallback, void *aContext, uint32_t aReryWaitInterval)`	`otError` 此功能請求更新操作數據集。

結構
otExtendedPanId	此結構表示擴展PAN ID。
otMasterKey	此結構表示線程主密鑰。
otNetworkName	此結構表示網絡名稱。
otOperationalDataset	此結構表示活動或待處理的操作數據集。
otOperationalDatasetComponents	此結構表示“活動”或“待處理”操作數據集中不同組件的存在。
otOperationalDatasetTlvs	此結構表示活動或待處理的操作數據集。
otPskc	該結構表示PSKc。
otSecurityPolicy	此結構表示安全策略。

枚舉

匿名枚舉

 anonymous enum

該枚舉定義了安全策略TLV標誌。

物產
`OT_SECURITY_POLICY_BEACONS`	啟用信標。
`OT_SECURITY_POLICY_EXTERNAL_COMMISSIONER`	允許外部專員。
`OT_SECURITY_POLICY_NATIVE_COMMISSIONING`	本地調試。
`OT_SECURITY_POLICY_OBTAIN_MASTER_KEY`	獲取主密鑰。
`OT_SECURITY_POLICY_ROUTERS`	路由器已啟用。

otMeshcopTlvType

 otMeshcopTlvType

此枚舉表示meshcop TLV類型。

物產
`OT_MESHCOP_TLV_ACTIVETIMESTAMP`	meshcop活動時間戳TLV
`OT_MESHCOP_TLV_BORDER_AGENT_RLOC`	meshcop邊界代理定位器TLV
`OT_MESHCOP_TLV_CHANNEL`	meshcop通道TLV
`OT_MESHCOP_TLV_CHANNELMASK`	meshcop通道掩碼TLV
`OT_MESHCOP_TLV_COMMISSIONER_ID`	meshcop專員ID TLV
`OT_MESHCOP_TLV_COMMISSIONER_UDP_PORT`	meshcop專員UDP端口TLV
`OT_MESHCOP_TLV_COMM_SESSION_ID`	meshcop專員會話ID TLV
`OT_MESHCOP_TLV_COUNT`	meshcop計數TLV
`OT_MESHCOP_TLV_DELAYTIMER`	meshcop延遲計時器TLV
`OT_MESHCOP_TLV_DISCOVERYREQUEST`	meshcop發現請求TLV
`OT_MESHCOP_TLV_DISCOVERYRESPONSE`	meshcop發現響應TLV
`OT_MESHCOP_TLV_ENERGY_LIST`	meshcop能源清單TLV
`OT_MESHCOP_TLV_EXTPANID`	meshcop擴展Pan ID TLV
`OT_MESHCOP_TLV_GET`	meshcop獲取TLV
`OT_MESHCOP_TLV_IPV6_ADDRESS_TLV`	meshcop IPv6地址TLV
`OT_MESHCOP_TLV_JOINERADVERTISEMENT`	meshcop細木工廣告TLV
`OT_MESHCOP_TLV_JOINER_DTLS`	meshcop Joiner DTLS封裝TLV
`OT_MESHCOP_TLV_JOINER_IID`	meshcop Joiner IID TLV
`OT_MESHCOP_TLV_JOINER_RLOC`	meshcop Joiner路由器定位器TLV
`OT_MESHCOP_TLV_JOINER_ROUTER_KEK`	meshcop Joiner路由器KEK TLV
`OT_MESHCOP_TLV_JOINER_UDP_PORT`	meshcop Joiner UDP端口TLV
`OT_MESHCOP_TLV_MASTERKEY`	meshcop網絡主密鑰TLV
`OT_MESHCOP_TLV_MESHLOCALPREFIX`	meshcop網格本地前綴TLV
`OT_MESHCOP_TLV_NETWORKNAME`	meshcop網絡名稱TLV
`OT_MESHCOP_TLV_NETWORK_KEY_SEQUENCE`	meshcop網絡密鑰序列TLV
`OT_MESHCOP_TLV_PANID`	meshcop泛ID TLV
`OT_MESHCOP_TLV_PENDINGTIMESTAMP`	meshcop等待時間戳TLV
`OT_MESHCOP_TLV_PERIOD`	Meshcop期間TLV
`OT_MESHCOP_TLV_PROVISIONING_URL`	meshcop供應URL TLV
`OT_MESHCOP_TLV_PSKC`	Meshcop PSKc TLV
`OT_MESHCOP_TLV_SCAN_DURATION`	meshcop掃描持續時間TLV
`OT_MESHCOP_TLV_SECURITYPOLICY`	meshcop安全策略TLV
`OT_MESHCOP_TLV_STATE`	Meshcop國家TLV
`OT_MESHCOP_TLV_STEERING_DATA`	meshcop轉向數據TLV
`OT_MESHCOP_TLV_UDP_ENCAPSULATION_TLV`	meshcop UDP封裝TLV
`OT_MESHCOP_TLV_VENDOR_DATA_TLV`	meshcop供應商數據TLV
`OT_MESHCOP_TLV_VENDOR_MODEL_TLV`	meshcop供應商模型TLV
`OT_MESHCOP_TLV_VENDOR_NAME_TLV`	meshcop供應商名稱TLV
`OT_MESHCOP_TLV_VENDOR_STACK_VERSION_TLV`	meshcop供應商堆棧版本TLV
`OT_MESHCOP_TLV_VENDOR_SW_VERSION_TLV`	meshcop供應商SW版本TLV

類型定義

otChannelMask

uint32_t otChannelMask

此類型表示通道掩碼。

otDatasetUpdaterCallback

void(* otDatasetUpdaterCallback)(otError aError, void *aContext)

當數據集更新請求完成時，將報告此數據集更新請求的成功或失敗狀態，從而調用此回調函數指針。

細節

參量

`[in] aError`	錯誤狀態。 OT_ERROR_NONE表示數據集更新成功。 OT_ERROR_INVALID_STATE指示由於無效狀態（禁用MLE）導致的故障。 OT_ERROR_ALREADY表示由於網絡內的另一台設備請求衝突的數據集更新而導致的故障。
`[in] aContext`	指向任意上下文的指針（由用戶在`otDatasetUpdaterRequestUpdate()` ）。

otExtendedPanId

struct otExtendedPanId otExtendedPanId

此結構表示擴展PAN ID。

otMasterKey

struct otMasterKey otMasterKey

此結構表示線程主密鑰。

otMeshLocalPrefix

otIp6NetworkPrefix otMeshLocalPrefix

該結構表示網格局部前綴。

otMeshcopTlvType

enum otMeshcopTlvType otMeshcopTlvType

此枚舉表示meshcop TLV類型。

otNetworkName

struct otNetworkName otNetworkName

此結構表示網絡名稱。

otOperationalDataset

struct otOperationalDataset otOperationalDataset

此結構表示活動或待處理的操作數據集。

數據集中的組件是可選的。 mComponets結構指定數據mComponets存在哪些組件。

otOperationalDatasetComponents

struct otOperationalDatasetComponents otOperationalDatasetComponents

此結構表示“活動”或“待處理”操作數據集中不同組件的存在。

otOperationalDatasetTlvs

struct otOperationalDatasetTlvs otOperationalDatasetTlvs

此結構表示活動或待處理的操作數據集。

操作數據集是按線程指定的TLV編碼的。

otPskc

struct otPskc otPskc

該結構表示PSKc。

otSecurityPolicy

struct otSecurityPolicy otSecurityPolicy

此結構表示安全策略。

變數

OT_TOOL_PACKED_END

OT_TOOL_PACKED_BEGIN struct otMasterKey OT_TOOL_PACKED_END

職能

otDatasetCreateNewNetwork

otError otDatasetCreateNewNetwork(
  otInstance *aInstance,
  otOperationalDataset *aDataset
)

此方法創建一個新的操作數據集，以在形成新網絡時使用。

細節

參量

`[in] aInstance`	指向OpenThread實例的指針。
`[out] aDataset`	操作數據集。

返回值

`OT_ERROR_NONE`	成功創建了新的操作數據集。
`OT_ERROR_FAILED`	無法為新參數生成隨機值。

otDatasetGeneratePskc

otError otDatasetGeneratePskc(
  const char *aPassPhrase,
  const otNetworkName *aNetworkName,
  const otExtendedPanId *aExtPanId,
  otPskc *aPskc
)

此功能根據給定的密碼，網絡名稱和擴展的PAN ID生成PSKc。

PSKc用於建立專員會議。

細節

參量

`[in] aPassPhrase`	調試密碼短語。
`[in] aNetworkName`	PSKc計算的網絡名稱。
`[in] aExtPanId`	用於PSKc計算的擴展PAN ID。
`[out] aPskc`	指向變量的指針，以輸出生成的PSKc。

返回值

`OT_ERROR_NONE`	成功生成PSKc。
`OT_ERROR_INVALID_ARGS`	如果任何輸入參數無效。

otDatasetGetActive

otError otDatasetGetActive(
  otInstance *aInstance,
  otOperationalDataset *aDataset
)

該函數獲取活動操作數據集。

細節

參量

`[in] aInstance`	指向OpenThread實例的指針。
`[out] aDataset`	指向活動操作數據集放置位置的指針。

返回值

`OT_ERROR_NONE`	成功檢索活動操作數據集。
`OT_ERROR_NOT_FOUND`	設置存儲中沒有相應的值。

otDatasetGetActiveTlvs

otError otDatasetGetActiveTlvs(
  otInstance *aInstance,
  otOperationalDatasetTlvs *aDataset
)

該函數獲取活動操作數據集。

細節

參量

`[in] aInstance`	指向OpenThread實例的指針。
`[out] aDataset`	指向活動操作數據集放置位置的指針。

返回值

`OT_ERROR_NONE`	成功檢索活動操作數據集。
`OT_ERROR_NOT_FOUND`	設置存儲中沒有相應的值。

otDatasetGetDelayTimerMinimal

uint32_t otDatasetGetDelayTimerMinimal(
  otInstance *aInstance
)

獲得最少的延遲計時器。

細節

參量

[in] aInstance

指向OpenThread實例的指針。

返回值

the

最小延遲計時器的值（以毫秒為單位）。

otDatasetGetPending

otError otDatasetGetPending(
  otInstance *aInstance,
  otOperationalDataset *aDataset
)

此函數獲取待處理的操作數據集。

細節

參量

`[in] aInstance`	指向OpenThread實例的指針。
`[out] aDataset`	指向待定操作數據集放置位置的指針。

返回值

`OT_ERROR_NONE`	成功檢索了待處理的操作數據集。
`OT_ERROR_NOT_FOUND`	設置存儲中沒有相應的值。

otDatasetGetPendingTlvs

otError otDatasetGetPendingTlvs(
  otInstance *aInstance,
  otOperationalDatasetTlvs *aDataset
)

此函數獲取待處理的操作數據集。

細節

參量

`[in] aInstance`	指向OpenThread實例的指針。
`[out] aDataset`	指向待定操作數據集放置位置的指針。

返回值

`OT_ERROR_NONE`	成功檢索待處理的操作數據集。
`OT_ERROR_NOT_FOUND`	設置存儲中沒有相應的值。

otDatasetIsCommissioned

bool otDatasetIsCommissioned(
  otInstance *aInstance
)

此功能指示“活動操作數據集”中是否存在有效網絡。

細節

參量

[in] aInstance

指向OpenThread實例的指針。

退貨

如果有效操作數據集中存在有效網絡，則為TRUE，否則為FALSE。

otDatasetSendMgmtActiveGet

otError otDatasetSendMgmtActiveGet(
  otInstance *aInstance,
  const otOperationalDatasetComponents *aDatasetComponents,
  const uint8_t *aTlvTypes,
  uint8_t aLength,
  const otIp6Address *aAddress
)

該函數發送MGMT_ACTIVE_GET。

細節

參量

`[in] aInstance`	指向OpenThread實例的指針。
`[in] aDatasetComponents`	指向數據集組件結構的指針，該結構指定要請求的組件。
`[in] aTlvTypes`	指向包含其他原始TLV類型的數組的指針。
`[in] aLength`	`aTlvTypes`的長度。
`[in] aAddress`	指向IPv6目標的指針（如果為NULL）將默認使用Leader ALOC。

返回值

`OT_ERROR_NONE`	成功發送meshcop數據集命令。
`OT_ERROR_NO_BUFS`	緩衝區空間不足，無法發送。

otDatasetSendMgmtActiveSet

otError otDatasetSendMgmtActiveSet(
  otInstance *aInstance,
  const otOperationalDataset *aDataset,
  const uint8_t *aTlvs,
  uint8_t aLength
)

該函數發送MGMT_ACTIVE_SET。

細節

參量

`[in] aInstance`	指向OpenThread實例的指針。
`[in] aDataset`	指向操作數據集的指針。
`[in] aTlvs`	指向TLV的指針。
`[in] aLength`	TLV的長度。

返回值

`OT_ERROR_NONE`	成功發送meshcop數據集命令。
`OT_ERROR_NO_BUFS`	緩衝區空間不足，無法發送。

otDatasetSendMgmtPendingGet

otError otDatasetSendMgmtPendingGet(
  otInstance *aInstance,
  const otOperationalDatasetComponents *aDatasetComponents,
  const uint8_t *aTlvTypes,
  uint8_t aLength,
  const otIp6Address *aAddress
)

此函數發送MGMT_PENDING_GET。

細節

參量

`[in] aInstance`	指向OpenThread實例的指針。
`[in] aDatasetComponents`	指向數據集組件結構的指針，該結構指定要請求的組件。
`[in] aTlvTypes`	指向包含其他原始TLV類型的數組的指針。
`[in] aLength`	`aTlvTypes`的長度。
`[in] aAddress`	指向IPv6目標的指針（如果為NULL）將默認使用Leader ALOC。

返回值

`OT_ERROR_NONE`	成功發送meshcop數據集命令。
`OT_ERROR_NO_BUFS`	緩衝區空間不足，無法發送。

otDatasetSendMgmtPendingSet

otError otDatasetSendMgmtPendingSet(
  otInstance *aInstance,
  const otOperationalDataset *aDataset,
  const uint8_t *aTlvs,
  uint8_t aLength
)

該函數發送MGMT_PENDING_SET。

細節

參量

`[in] aInstance`	指向OpenThread實例的指針。
`[in] aDataset`	指向操作數據集的指針。
`[in] aTlvs`	指向TLV的指針。
`[in] aLength`	TLV的長度。

返回值

`OT_ERROR_NONE`	成功發送meshcop數據集命令。
`OT_ERROR_NO_BUFS`	緩衝區空間不足，無法發送。

otDatasetSetActive

otError otDatasetSetActive(
  otInstance *aInstance,
  const otOperationalDataset *aDataset
)

此功能設置活動操作數據集。

如果數據集不包括活動時間戳記，則該數據集僅部分完成。

如果在具有部分完整的活動數據集的設備上啟用了線程，則該設備將嘗試使用數據集中的任何現有信息連接到現有的線程網絡。僅需要線程主密鑰即可連接到網絡。

如果數據集中未包含頻道，則設備將通過不同的頻道發送MLE Announce消息，以查找其他頻道上的鄰居。

如果設備成功連接到線程網絡，則設備將從其父級檢索完整的活動數據集。請注意，具有路由器功能的設備只有擁有完整的活動數據集，才能轉換為路由器或領導者角色。

細節

參量

`[in] aInstance`	指向OpenThread實例的指針。
`[in] aDataset`	指向活動操作數據集的指針。

返回值

`OT_ERROR_NONE`	成功設置活動操作數據集。
`OT_ERROR_NO_BUFS`	緩衝區空間不足，無法設置活動操作數據集。
`OT_ERROR_NOT_IMPLEMENTED`	該平台未實現設置功能。

otDatasetSetActiveTlvs

otError otDatasetSetActiveTlvs(
  otInstance *aInstance,
  const otOperationalDatasetTlvs *aDataset
)

此功能設置活動操作數據集。

如果數據集不包括活動時間戳記，則該數據集僅部分完成。

如果數據集中未包含頻道，則設備將通過不同的頻道發送MLE Announce消息，以查找其他頻道上的鄰居。

細節

參量

`[in] aInstance`	指向OpenThread實例的指針。
`[in] aDataset`	指向活動操作數據集的指針。

返回值

`OT_ERROR_NONE`	成功設置活動操作數據集。
`OT_ERROR_NO_BUFS`	緩衝區空間不足，無法設置活動操作數據集。
`OT_ERROR_NOT_IMPLEMENTED`	該平台未實現設置功能。

otDatasetSetDelayTimerMinimal

otError otDatasetSetDelayTimerMinimal(
  otInstance *aInstance,
  uint32_t aDelayTimerMinimal
)

設置最小延遲計時器。

細節

參量

`[in] aInstance`	指向OpenThread實例的指針。
`[in] aDelayTimerMinimal`	最小延遲計時器的值（以毫秒為單位）。

返回值

`OT_ERROR_NONE`	成功設置最小延遲計時器。
`OT_ERROR_INVALID_ARGS`	如果`aDelayTimerMinimal`無效。

otDatasetSetPending

otError otDatasetSetPending(
  otInstance *aInstance,
  const otOperationalDataset *aDataset
)

此功能設置待處理的操作數據集。

細節

參量

`[in] aInstance`	指向OpenThread實例的指針。
`[in] aDataset`	指向待處理操作數據集的指針。

返回值

`OT_ERROR_NONE`	成功設置待處理操作數據集。
`OT_ERROR_NO_BUFS`	緩衝區空間不足，無法設置待處理操作數據集。
`OT_ERROR_NOT_IMPLEMENTED`	該平台未實現設置功能。

otDatasetSetPendingTlvs

otError otDatasetSetPendingTlvs(
  otInstance *aInstance,
  const otOperationalDatasetTlvs *aDataset
)

此功能設置待處理的操作數據集。

細節

參量

`[in] aInstance`	指向OpenThread實例的指針。
`[in] aDataset`	指向待處理操作數據集的指針。

返回值

`OT_ERROR_NONE`	成功設置待處理操作數據集。
`OT_ERROR_NO_BUFS`	緩衝區空間不足，無法設置待處理操作數據集。
`OT_ERROR_NOT_IMPLEMENTED`	該平台未實現設置功能。

otDatasetUpdaterCancelUpdate

void otDatasetUpdaterCancelUpdate(
  otInstance *aInstance
)

此功能取消正在進行的（如果有的話）“操作數據集”更新請求。

細節

參量

[in] aInstance

指向OpenThread實例的指針。

otDatasetUpdaterIsUpdateOngoing

bool otDatasetUpdaterIsUpdateOngoing(
  otInstance *aInstance
)

此功能指示是否有正在進行的操作數據集更新請求。

細節

參量

[in] aInstance

指向OpenThread實例的指針。

返回值

`TRUE`	正在進行更新。
`FALSE`	沒有正在進行的更新。

otDatasetUpdaterRequestUpdate

otError otDatasetUpdaterRequestUpdate(
  otInstance *aInstance,
  const otOperationalDataset *aDataset,
  otDatasetUpdaterCallback aCallback,
  void *aContext,
  uint32_t aReryWaitInterval
)

此功能請求更新操作數據集。

aDataset應該包含要更新的字段及其新值。它不能包含活動或待處理時間戳字段。延遲字段是可選的，如果未提供，則將使用默認值（1000毫秒）。

細節

參量

`[in] aInstance`	指向OpenThread實例的指針。
`[in] aDataset`	指向包含要更改字段的數據集的指針。
`[in] aCallback`	指示數據集更新請求何時完成的回調。
`[in] aContext`	傳遞給回調的任意上下文。
`[in] aRetryWaitInterval`	重試後發送Pending數據集之後的等待時間（間隔以毫秒為單位）。

返回值

`OT_ERROR_NONE`	數據集更新成功啟動（ `aCallback`將調用`aCallback` ）。
`OT_ERROR_INVALID_STATE`	設備被禁用（MLE被禁用）。
`OT_ERROR_INVALID_ARGS`	`aDataset`無效（包含活動或待定時間戳記）。
`OT_ERROR_BUSY`	無法開始更新，上一個正在進行。
`OT_ERROR_NO_BUFS`	無法分配緩衝區以保存數據集。

巨集

OT_CHANNEL_10_MASK

 OT_CHANNEL_10_MASK (1 << 10)

頻道10。

OT_CHANNEL_11_MASK

 OT_CHANNEL_11_MASK (1 << 11)

頻道11。

OT_CHANNEL_12_MASK

 OT_CHANNEL_12_MASK (1 << 12)

頻道12。

OT_CHANNEL_13_MASK

 OT_CHANNEL_13_MASK (1 << 13)

頻道13。

OT_CHANNEL_14_MASK

 OT_CHANNEL_14_MASK (1 << 14)

頻道14。

OT_CHANNEL_15_MASK

 OT_CHANNEL_15_MASK (1 << 15)

頻道15。

OT_CHANNEL_16_MASK

 OT_CHANNEL_16_MASK (1 << 16)

頻道16。

OT_CHANNEL_17_MASK

 OT_CHANNEL_17_MASK (1 << 17)

頻道17。

OT_CHANNEL_18_MASK

 OT_CHANNEL_18_MASK (1 << 18)

頻道18。

OT_CHANNEL_19_MASK

 OT_CHANNEL_19_MASK (1 << 19)

頻道19。

OT_CHANNEL_1_MASK

 OT_CHANNEL_1_MASK (1 << 1)

頻道1。

OT_CHANNEL_20_MASK

 OT_CHANNEL_20_MASK (1 << 20)

頻道20。

OT_CHANNEL_21_MASK

 OT_CHANNEL_21_MASK (1 << 21)

頻道21。

OT_CHANNEL_22_MASK

 OT_CHANNEL_22_MASK (1 << 22)

頻道22。

OT_CHANNEL_23_MASK

 OT_CHANNEL_23_MASK (1 << 23)

頻道23。

OT_CHANNEL_24_MASK

 OT_CHANNEL_24_MASK (1 << 24)

頻道24。

OT_CHANNEL_25_MASK

 OT_CHANNEL_25_MASK (1 << 25)

頻道25。

OT_CHANNEL_26_MASK

 OT_CHANNEL_26_MASK (1 << 26)

頻道26。

OT_CHANNEL_2_MASK

 OT_CHANNEL_2_MASK (1 << 2)

頻道2。

OT_CHANNEL_3_MASK

 OT_CHANNEL_3_MASK (1 << 3)

頻道3。

OT_CHANNEL_4_MASK

 OT_CHANNEL_4_MASK (1 << 4)

頻道4。

OT_CHANNEL_5_MASK

 OT_CHANNEL_5_MASK (1 << 5)

頻道5。

OT_CHANNEL_6_MASK

 OT_CHANNEL_6_MASK (1 << 6)

頻道6。

OT_CHANNEL_7_MASK

 OT_CHANNEL_7_MASK (1 << 7)

頻道7。

OT_CHANNEL_8_MASK

 OT_CHANNEL_8_MASK (1 << 8)

頻道8。

OT_CHANNEL_9_MASK

 OT_CHANNEL_9_MASK (1 << 9)

頻道9。

OT_EXT_PAN_ID_SIZE

 OT_EXT_PAN_ID_SIZE 8

線程PAN ID的大小（字節）

OT_MASTER_KEY_SIZE

 OT_MASTER_KEY_SIZE 16

線程主密鑰的大小（字節）

OT_MESH_LOCAL_PREFIX_SIZE

 OT_MESH_LOCAL_PREFIX_SIZE OT_IP6_PREFIX_SIZE

網格本地前綴的大小（字節）

OT_NETWORK_NAME_MAX_SIZE

 OT_NETWORK_NAME_MAX_SIZE 16

線程網絡名稱字段的最大大小（字節）

OT_OPERATIONAL_DATASET_MAX_LENGTH

 OT_OPERATIONAL_DATASET_MAX_LENGTH 254

操作數據集的最大長度（以字節為單位）。

OT_PSKC_MAX_SIZE

 OT_PSKC_MAX_SIZE 16

PSKc的最大大小（字節）