Google は、黒人コミュニティのための人種的公平の促進に取り組んでいます。詳細をご覧ください。

運用データセット

このモジュールには、DatasetUpdaterの関数が含まれています。

概要

データセットアップデータ機能が有効になっている場合、このモジュールの関数は(つまり、利用可能なOPENTHREAD_CONFIG_DATASET_UPDATER_ENABLE 1に設定されています)。さらに、この機能はFTDビルドでのみ使用できます。

列挙

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
}
列挙型
この列挙は、meshcopTLVタイプを表します。

Typedef

otChannelMask typedef
uint32_t
このタイプはチャネルマスクを表します。
otDatasetMgmtSetCallback )(otError aResult, void *aContext) typedef
void(*
この関数ポインタは、MGMT_SET要求への応答が受信されたとき、またはタイムアウトしたときに呼び出されます。
otDatasetUpdaterCallback )(otError aError, void *aContext) typedef
void(*
このコールバック関数ポインターは、データセット更新要求が終了したときに呼び出され、データセット更新要求の成功または失敗のステータスを報告します。
otExtendedPanId typedef
この構造は、拡張PANIDを表します。
otMeshLocalPrefix typedef
この構造は、メッシュローカルプレフィックスを表します。
otMeshcopTlvType typedef
この列挙は、meshcopTLVタイプを表します。
otNetworkKey typedef
struct otNetworkKey
この構造は、スレッドネットワークキーを表します。
otNetworkKeyRef typedef
このデータ型は、NetworkKeyへのKeyRefを表します。
otNetworkName typedef
この構造はネットワーク名を表します。
otOperationalDataset typedef
この構造は、アクティブまたは保留中の運用データセットを表します。
otOperationalDatasetComponents typedef
この構造は、アクティブまたは保留中の運用データセットにさまざまなコンポーネントが存在することを表します。
otOperationalDatasetTlvs typedef
この構造は、アクティブまたは保留中の運用データセットを表します。
otPskc typedef
struct otPskc
この構造はPSKcを表します。
otPskcRef typedef
このデータ型は、PSKcへのKeyRefを表します。
otSecurityPolicy typedef
この構造はセキュリティポリシーを表しています。

変数

OT_TOOL_PACKED_END

関数

otDatasetCreateNewNetwork ( otInstance *aInstance, otOperationalDataset *aDataset)
このメソッドは、新しいネットワークを形成するときに使用する新しい運用データセットを作成します。
otDatasetGeneratePskc (const char *aPassPhrase, const otNetworkName *aNetworkName, const otExtendedPanId *aExtPanId, otPskc *aPskc)
この関数は、指定されたパスフレーズ、ネットワーク名、および拡張PANIDからPSKcを生成します。
otDatasetGetActive ( otInstance *aInstance, otOperationalDataset *aDataset)
この関数は、アクティブな運用データセットを取得します。
otDatasetGetActiveTlvs ( otInstance *aInstance, otOperationalDatasetTlvs *aDataset)
この関数は、アクティブな運用データセットを取得します。
otDatasetGetDelayTimerMinimal ( otInstance *aInstance)
uint32_t
最小限の遅延タイマーを取得します。
otDatasetGetPending ( otInstance *aInstance, otOperationalDataset *aDataset)
この関数は、保留中の操作データセットを取得します。
otDatasetGetPendingTlvs ( otInstance *aInstance, otOperationalDatasetTlvs *aDataset)
この関数は、保留中の操作データセットを取得します。
otDatasetIsCommissioned ( otInstance *aInstance)
bool
この関数は、有効なネットワークがアクティブな運用データセットに存在するかどうかを示します。
otDatasetParseTlvs (const otOperationalDatasetTlvs *aDatasetTlvs, otOperationalDataset *aDataset)
この関数は、から運用データセットを解析しotOperationalDatasetTlvs
otDatasetSendMgmtActiveGet ( otInstance *aInstance, const otOperationalDatasetComponents *aDatasetComponents, const uint8_t *aTlvTypes, uint8_t aLength, const otIp6Address *aAddress)
この関数はMGMT_ACTIVE_GETを送信します。
otDatasetSendMgmtActiveSet ( otInstance *aInstance, const otOperationalDataset *aDataset, const uint8_t *aTlvs, uint8_t aLength, otDatasetMgmtSetCallback aCallback, void *aContext)
この関数はMGMT_ACTIVE_SETを送信します。
otDatasetSendMgmtPendingGet ( otInstance *aInstance, const otOperationalDatasetComponents *aDatasetComponents, const uint8_t *aTlvTypes, uint8_t aLength, const otIp6Address *aAddress)
この関数はMGMT_PENDING_GETを送信します。
otDatasetSendMgmtPendingSet ( otInstance *aInstance, const otOperationalDataset *aDataset, const uint8_t *aTlvs, uint8_t aLength, otDatasetMgmtSetCallback aCallback, void *aContext)
この関数はMGMT_PENDING_SETを送信します。
otDatasetSetActive ( otInstance *aInstance, const otOperationalDataset *aDataset)
この関数は、アクティブな運用データセットを設定します。
otDatasetSetActiveTlvs ( otInstance *aInstance, const otOperationalDatasetTlvs *aDataset)
この関数は、アクティブな運用データセットを設定します。
otDatasetSetDelayTimerMinimal ( otInstance *aInstance, uint32_t aDelayTimerMinimal)
最小遅延タイマーを設定します。
otDatasetSetPending ( otInstance *aInstance, const otOperationalDataset *aDataset)
この関数は、保留中の操作データセットを設定します。
otDatasetSetPendingTlvs ( otInstance *aInstance, const otOperationalDatasetTlvs *aDataset)
この関数は、保留中の操作データセットを設定します。
otDatasetUpdaterCancelUpdate ( otInstance *aInstance)
void
この関数は、進行中の(存在する場合)運用データセット更新要求をキャンセルします。
otDatasetUpdaterIsUpdateOngoing ( otInstance *aInstance)
bool
この関数は、進行中の操作データセット更新要求があるかどうかを示します。
otDatasetUpdaterRequestUpdate ( otInstance *aInstance, const otOperationalDataset *aDataset, otDatasetUpdaterCallback aCallback, void *aContext)
この関数は、運用データセットの更新を要求します。
otNetworkNameFromString ( otNetworkName *aNetworkName, const char *aNameString)
この機能は、設定otNetworkName所与ヌルからインスタンスがC文字列を終了しました。

構造体

otExtendedPanId

この構造は、拡張PANIDを表します。

otNetworkKey

この構造は、スレッドネットワークキーを表します。

otNetworkName

この構造はネットワーク名を表します。

otOperationalDataset

この構造は、アクティブまたは保留中の運用データセットを表します。

otOperationalDatasetComponents

この構造は、アクティブまたは保留中の運用データセットにさまざまなコンポーネントが存在することを表します。

otOperationalDatasetTlvs

この構造は、アクティブまたは保留中の運用データセットを表します。

otPskc

この構造はPSKcを表します。

otSecurityPolicy

この構造はセキュリティポリシーを表しています。

列挙

otMeshcopTlvType

 otMeshcopTlvType

この列挙は、meshcopTLVタイプを表します。

プロパティ
OT_MESHCOP_TLV_ACTIVETIMESTAMP

meshcopアクティブタイムスタンプTLV

OT_MESHCOP_TLV_BORDER_AGENT_RLOC

meshcop Border Agent Locator TLV

OT_MESHCOP_TLV_CHANNEL

meshcopチャネルTLV

OT_MESHCOP_TLV_CHANNELMASK

meshcopチャネルマスクTLV

OT_MESHCOP_TLV_COMMISSIONER_ID

meshcopコミッショナーIDTLV

OT_MESHCOP_TLV_COMMISSIONER_UDP_PORT

meshcopコミッショナーUDPポートTLV

OT_MESHCOP_TLV_COMM_SESSION_ID

meshcopコミッショナーセッションIDTLV

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拡張パンIDTLV

OT_MESHCOP_TLV_GET

meshcop Get TLV

OT_MESHCOP_TLV_IPV6_ADDRESS_TLV

meshcopIPv6アドレスTLV

OT_MESHCOP_TLV_JOINERADVERTISEMENT

meshcopジョイナーアドバタイズメントTLV

OT_MESHCOP_TLV_JOINER_DTLS

meshcopジョイナーDTLSカプセル化TLV

OT_MESHCOP_TLV_JOINER_IID

メッシュコップジョイナーIIDTLV

OT_MESHCOP_TLV_JOINER_RLOC

meshcopジョイナールーターロケーターTLV

OT_MESHCOP_TLV_JOINER_ROUTER_KEK

meshcopジョイナールーターKEKTLV

OT_MESHCOP_TLV_JOINER_UDP_PORT

meshcopジョイナーUDPポートTLV

OT_MESHCOP_TLV_MESHLOCALPREFIX

meshcopメッシュローカルプレフィックスTLV

OT_MESHCOP_TLV_NETWORKKEY

meshcopネットワークキーTLV

OT_MESHCOP_TLV_NETWORKNAME

meshcopネットワーク名TLV

OT_MESHCOP_TLV_NETWORK_KEY_SEQUENCE

meshcopネットワークキーシーケンスTLV

OT_MESHCOP_TLV_PANID

meshcop Pan Id TLV

OT_MESHCOP_TLV_PENDINGTIMESTAMP

meshcop保留中のタイムスタンプTLV

OT_MESHCOP_TLV_PERIOD

メッシュコップ期間TLV

OT_MESHCOP_TLV_PROVISIONING_URL

meshcopプロビジョニングURLTLV

OT_MESHCOP_TLV_PSKC

meshcop PSKc TLV

OT_MESHCOP_TLV_SCAN_DURATION

meshcopスキャン期間TLV

OT_MESHCOP_TLV_SECURITYPOLICY

meshcopセキュリティポリシーTLV

OT_MESHCOP_TLV_STATE

メッシュコップ状態TLV

OT_MESHCOP_TLV_STEERING_DATA

meshcopステアリングデータTLV

OT_MESHCOP_TLV_UDP_ENCAPSULATION_TLV

meshcopUDPカプセル化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

Typedef

otChannelMask

uint32_t otChannelMask

このタイプはチャネルマスクを表します。

otDatasetMgmtSetCallback

void(* otDatasetMgmtSetCallback)(otError aResult, void *aContext)

この関数ポインタは、MGMT_SET要求への応答が受信されたとき、またはタイムアウトしたときに呼び出されます。

詳細
パラメーター
[in] aResult
操作の結果。
[in] aContext
アプリケーション固有のコンテキストへのポインタ。
戻り値
OT_ERROR_NONE
要求はリーダーによって受け入れられました。
OT_ERROR_REJECTED
要求はリーダーによって拒否されました。
OT_ERROR_PARSE
応答の解析中にエラーが発生しました。
OT_ERROR_ABORT
リクエストはピアによってリセットされました。
OT_ERROR_RESPONSE_TIMEOUT
タイムアウト期間中に応答または確認応答を受信しませんでした。

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

この構造は、拡張PANIDを表します。

otMeshLocalPrefix

otIp6NetworkPrefix otMeshLocalPrefix

この構造は、メッシュローカルプレフィックスを表します。

otMeshcopTlvType

enum otMeshcopTlvType otMeshcopTlvType

この列挙は、meshcopTLVタイプを表します。

otNetworkKey

struct otNetworkKey otNetworkKey

この構造は、スレッドネットワークキーを表します。

otNetworkKeyRef

otCryptoKeyRef otNetworkKeyRef

このデータ型は、NetworkKeyへのKeyRefを表します。

キーへの参照

otNetworkName

struct otNetworkName otNetworkName

この構造はネットワーク名を表します。

otNetworkName C列(すなわち、終了ヌルであるm8ヌルチャーとchar配列MUST端\0 )。

otOperationalDataset

struct otOperationalDataset otOperationalDataset

この構造は、アクティブまたは保留中の運用データセットを表します。

データセットのコンポーネントはオプションです。 mComponetsコンポーネントがデータセット内に存在する構造を指定します。

otOperationalDatasetComponents

struct otOperationalDatasetComponents otOperationalDatasetComponents

この構造は、アクティブまたは保留中の運用データセットにさまざまなコンポーネントが存在することを表します。

otOperationalDatasetTlvs

struct otOperationalDatasetTlvs otOperationalDatasetTlvs

この構造は、アクティブまたは保留中の運用データセットを表します。

運用データセットは、スレッドで指定されたとおりにTLVエンコードされます。

otPskc

struct otPskc otPskc

この構造はPSKcを表します。

otPskcRef

otCryptoKeyRef otPskcRef

このデータ型は、PSKcへのKeyRefを表します。

キーへの参照

otSecurityPolicy

struct otSecurityPolicy otSecurityPolicy

この構造はセキュリティポリシーを表しています。

変数

OT_TOOL_PACKED_END

OT_TOOL_PACKED_BEGIN struct otNetworkKey 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
)

この関数は、指定されたパスフレーズ、ネットワーク名、および拡張PANIDからPSKcを生成します。

PSKcは、コミッショナーセッションを確立するために使用されます。

詳細
パラメーター
[in] aPassPhrase
コミッショニングパスフレーズ。
[in] aNetworkName
PSKc計算のネットワーク名。
[in] aExtPanId
PSKc計算用の拡張PANID。
[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。

otDatasetParseTlvs

otError otDatasetParseTlvs(
  const otOperationalDatasetTlvs *aDatasetTlvs,
  otOperationalDataset *aDataset
)

この関数は、から運用データセットを解析しotOperationalDatasetTlvs

詳細
パラメーター
[in] aDatasetTlvs
データセットTLVへのポインタ。
[out] aDataset
データセットが配置される場所へのポインタ。
戻り値
OT_ERROR_NONE
正常に設定さaDatasetからaDatasetTlvs
OT_ERROR_INVALID_ARGS
aDatasetTlvs無効です。

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の場合、デフォルトとしてリーダーALOCを使用します。
戻り値
OT_ERROR_NONE
meshcopdatasetコマンドを正常に送信します。
OT_ERROR_NO_BUFS
送信するバッファスペースが不足しています。

otDatasetSendMgmtActiveSet

otError otDatasetSendMgmtActiveSet(
  otInstance *aInstance,
  const otOperationalDataset *aDataset,
  const uint8_t *aTlvs,
  uint8_t aLength,
  otDatasetMgmtSetCallback aCallback,
  void *aContext
)

この関数はMGMT_ACTIVE_SETを送信します。

詳細
パラメーター
[in] aInstance
OpenThreadインスタンスへのポインタ。
[in] aDataset
運用データセットへのポインタ。
[in] aTlvs
TLVへのポインタ。
[in] aLength
TLVの長さ。
[in] aCallback
応答の受信またはタイムアウト時に呼び出される関数へのポインター。
[in] aContext
アプリケーション固有のコンテキストへのポインタaCallback
戻り値
OT_ERROR_NONE
meshcopdatasetコマンドを正常に送信します。
OT_ERROR_NO_BUFS
送信するバッファスペースが不足しています。
OT_ERROR_BUSY
以前のリクエストは進行中です。

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の場合、デフォルトとしてリーダーALOCを使用します。
戻り値
OT_ERROR_NONE
meshcopdatasetコマンドを正常に送信します。
OT_ERROR_NO_BUFS
送信するバッファスペースが不足しています。

otDatasetSendMgmtPendingSet

otError otDatasetSendMgmtPendingSet(
  otInstance *aInstance,
  const otOperationalDataset *aDataset,
  const uint8_t *aTlvs,
  uint8_t aLength,
  otDatasetMgmtSetCallback aCallback,
  void *aContext
)

この関数はMGMT_PENDING_SETを送信します。

詳細
パラメーター
[in] aInstance
OpenThreadインスタンスへのポインタ。
[in] aDataset
運用データセットへのポインタ。
[in] aTlvs
TLVへのポインタ。
[in] aLength
TLVの長さ。
[in] aCallback
応答の受信またはタイムアウト時に呼び出される関数へのポインター。
[in] aContext
アプリケーション固有のコンテキストへのポインタaCallback
戻り値
OT_ERROR_NONE
meshcopdatasetコマンドを正常に送信します。
OT_ERROR_NO_BUFS
送信するバッファスペースが不足しています。
OT_ERROR_BUSY
以前のリクエストは進行中です。

otDatasetSetActive

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

この関数は、アクティブな運用データセットを設定します。

データセットにアクティブタイムスタンプが含まれていない場合、データセットは部分的にしか完成していません。

部分的に完全なアクティブデータセットを持つデバイスでスレッドが有効になっている場合、デバイスはデータセット内の既存の情報を使用して既存のスレッドネットワークに接続しようとします。ネットワークに接続するために必要なのは、スレッドネットワークキーのみです。

チャネルがデータセットに含まれていない場合、デバイスはさまざまなチャネルにMLEアナウンスメッセージを送信して、他のチャネルのネイバーを検索します。

デバイスがスレッドネットワークに正常に接続されると、デバイスはその親から完全なアクティブデータセットを取得します。ルーター対応デバイスは、完全なアクティブデータセットが作成されるまで、ルーターまたはリーダーの役割に移行しないことに注意してください。

詳細
パラメーター
[in] aInstance
OpenThreadインスタンスへのポインタ。
[in] aDataset
アクティブな運用データセットへのポインタ。
戻り値
OT_ERROR_NONE
アクティブな運用データセットを正常に設定しました。
OT_ERROR_NO_BUFS
Active OperationalDatasetを設定するためのバッファースペースが不十分です。
OT_ERROR_NOT_IMPLEMENTED
プラットフォームは設定機能を実装していません。

otDatasetSetActiveTlvs

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

この関数は、アクティブな運用データセットを設定します。

データセットにアクティブタイムスタンプが含まれていない場合、データセットは部分的にしか完成していません。

部分的に完全なアクティブデータセットを持つデバイスでスレッドが有効になっている場合、デバイスはデータセット内の既存の情報を使用して既存のスレッドネットワークに接続しようとします。ネットワークに接続するために必要なのは、スレッドネットワークキーのみです。

チャネルがデータセットに含まれていない場合、デバイスはさまざまなチャネルにMLEアナウンスメッセージを送信して、他のチャネルのネイバーを検索します。

デバイスがスレッドネットワークに正常に接続されると、デバイスはその親から完全なアクティブデータセットを取得します。ルーター対応デバイスは、完全なアクティブデータセットが作成されるまで、ルーターまたはリーダーの役割に移行しないことに注意してください。

詳細
パラメーター
[in] aInstance
OpenThreadインスタンスへのポインタ。
[in] aDataset
アクティブな運用データセットへのポインタ。
戻り値
OT_ERROR_NONE
アクティブな運用データセットを正常に設定しました。
OT_ERROR_NO_BUFS
Active OperationalDatasetを設定するためのバッファースペースが不十分です。
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
)

この関数は、運用データセットの更新を要求します。

aDataset更新するフィールドとその新しい値を含める必要があります。 ActiveまたはPendingTimestampフィールドを含めることはできません。 [遅延]フィールドはオプションです。指定しない場合、デフォルト値(1000ミリ秒)が使用されます。

詳細
パラメーター
[in] aInstance
OpenThreadインスタンスへのポインタ。
[in] aDataset
変更するフィールドを含むデータセットへのポインタ。
[in] aCallback
データセット更新要求がいつ終了するかを示すコールバック。
[in] aContext
コールバックに渡される任意のコンテキスト。
戻り値
OT_ERROR_NONE
データセットの更新は、(正常に起動しaCallback完了時に呼び出されます)。
OT_ERROR_INVALID_STATE
デバイスが無効になっています(MLEが無効になっています)。
OT_ERROR_INVALID_ARGS
aDataset有効ではありません(アクティブまたは保留中のタイムスタンプ含みます)。
OT_ERROR_BUSY
更新を開始できません。前の更新が進行中です。
OT_ERROR_NO_BUFS
データセットを保存するためのバッファを割り当てることができませんでした。

otNetworkNameFromString

otError otNetworkNameFromString(
  otNetworkName *aNetworkName,
  const char *aNameString
)

この機能は、設定otNetworkName所与ヌルからインスタンスがC文字列を終了しました。

この関数は、指定されたことを検証aNameString UTF-8エンコーディングを以下、その長さがより長くないOT_NETWORK_NAME_MAX_SIZE

詳細
パラメーター
[out] aNetworkName
ポインタotNetworkNameセットに。
[in] aNameString
名前Cの文字列。
戻り値
OT_ERROR_NONE
正常に設定さaNetworkNameからaNameString
OT_ERROR_INVALID_ARGS
aNameStrng無効(長すぎるまたはUTF-8エンコーディングに従わない)です。

マクロ

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

スレッドのサイズPANID(バイト)

OT_MESH_LOCAL_PREFIX_SIZE

 OT_MESH_LOCAL_PREFIX_SIZE OT_IP6_PREFIX_SIZE

メッシュローカルプレフィックスのサイズ(バイト)

OT_NETWORK_KEY_SIZE

 OT_NETWORK_KEY_SIZE 16

スレッドネットワークキーのサイズ(バイト)

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の最大サイズ(バイト)