運用データセット
このモジュールには、データセット更新ツールの関数が含まれています。
概要
このモジュールの関数は、Dataset Updater 機能が有効な場合(つまり OPENTHREAD_CONFIG_DATASET_UPDATER_ENABLE
が 1 に設定されている場合)に使用できます。また、この機能は FTD のビルドでのみ利用できます。
Typedef |
|
---|---|
otChannelMask
|
typedefuint32_t
このタイプはチャンネル マスクを表します。 |
otDatasetMgmtSetCallback)(otError aResult, void *aContext)
|
typedefvoid(*
この関数ポインタは、MGMT_SET リクエストに対するレスポンスが受信されたとき、またはタイムアウトしたときに呼び出されます。 |
otDatasetUpdaterCallback)(otError aError, void *aContext)
|
typedefvoid(*
このコールバック関数ポインタは、データセット更新リクエストが終了したときに呼び出され、データセット更新リクエストの成功または失敗のステータスを報告します。 |
otExtendedPanId
|
typedefstruct otExtendedPanId
この構造は、拡張 PAN ID を表します。 |
otMeshLocalPrefix
|
typedef この構造は、メッシュ ローカル プレフィックスを表します。 |
otMeshcopTlvType
|
typedefenum otMeshcopTlvType
この列挙型は、 MeshCop TLV のタイプを表します。 |
otNetworkKey
|
typedefstruct otNetworkKey
この構造体は、スレッド ネットワーク キーを表します。 |
otNetworkKeyRef
|
typedef このデータ型は KeyRef から NetworkKey を表します。 |
otNetworkName
|
typedefstruct otNetworkName
この構造はネットワーク名を表します。 |
otOperationalDataset
|
typedefstruct otOperationalDataset
この構造は、有効または保留中の運用データセットを表します。 |
otOperationalDatasetComponents
|
typedef この構造は、運用データセットまたは保留中の運用データセットにさまざまなコンポーネントが存在することを表します。 |
otOperationalDatasetTlvs
|
typedefstruct otOperationalDatasetTlvs
この構造は、有効または保留中の運用データセットを表します。 |
otPskc
|
typedefstruct otPskc
この構造体は PSKc を表します。 |
otPskcRef
|
typedef このデータ型は KeyPS、PSKc を表します。 |
otSecurityPolicy
|
typedefstruct otSecurityPolicy
この構造はセキュリティ ポリシーを表します。 |
変数 |
|
---|---|
OT_TOOL_PACKED_END
|
OT_TOOL_PACKED_BEGIN struct otNetworkKey
|
関数 |
|
---|---|
otDatasetCreateNewNetwork(otInstance *aInstance, otOperationalDataset *aDataset)
|
このメソッドは、新しいネットワークを形成するときに使用する新しいオペレーショナル データセットを作成します。
|
otDatasetGeneratePskc(const char *aPassPhrase, const otNetworkName *aNetworkName, const otExtendedPanId *aExtPanId, otPskc *aPskc)
|
この関数は、指定されたパスフレーズ、ネットワーク名、拡張 PAN ID から 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)
|
この関数は、Pending Operational Dataset を設定します。
|
otDatasetSetPendingTlvs(otInstance *aInstance, const otOperationalDatasetTlvs *aDataset)
|
この関数は、Pending Operational Dataset を設定します。
|
otDatasetUpdaterCancelUpdate(otInstance *aInstance)
|
void
この関数は、進行中のオペレーション データセット更新リクエスト(ある場合)をキャンセルします。
|
otDatasetUpdaterIsUpdateOngoing(otInstance *aInstance)
|
bool
この関数は、オペレーション データセットの更新リクエストが進行中かどうかを示します。
|
otDatasetUpdaterRequestUpdate(otInstance *aInstance, const otOperationalDataset *aDataset, otDatasetUpdaterCallback aCallback, void *aContext)
|
この関数は、運用データセットの更新をリクエストします。
|
otNetworkNameFromString(otNetworkName *aNetworkName, const char *aNameString)
|
この関数は、指定された null で終わる C 文字列から
otNetworkName インスタンスを設定します。 |
構造体 |
|
---|---|
otExtendedPanId |
この構造は、拡張 PAN ID を表します。 |
otNetworkKey |
この構造体は、スレッド ネットワーク キーを表します。 |
otNetworkName |
この構造はネットワーク名を表します。 |
otOperationalDataset |
この構造は、有効または保留中の運用データセットを表します。 |
otOperationalDatasetComponents |
この構造は、運用データセットまたは保留中の運用データセットにさまざまなコンポーネントが存在することを表します。 |
otOperationalDatasetTlvs |
この構造は、有効または保留中の運用データセットを表します。 |
otPskc |
この構造体は PSKc を表します。 |
otSecurityPolicy |
この構造はセキュリティ ポリシーを表します。 |
列挙型
otMeshcopTlvType
otMeshcopTlvType
この列挙型は、 MeshCop TLV のタイプを表します。
Typedef
OTChannelMask
uint32_t otChannelMask
このタイプはチャンネル マスクを表します。
otDatasetMgmtSetCallback
void(* otDatasetMgmtSetCallback)(otError aResult, void *aContext)
この関数ポインタは、MGMT_SET リクエストに対するレスポンスが受信されたとき、またはタイムアウトしたときに呼び出されます。
詳細 | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
パラメータ |
|
||||||||||
戻り値 |
|
otDatasetUpdaterCallback
void(* otDatasetUpdaterCallback)(otError aError, void *aContext)
このコールバック関数ポインタは、データセット更新リクエストが終了したときに呼び出され、データセット更新リクエストの成功または失敗のステータスを報告します。
詳細 | |||||
---|---|---|---|---|---|
パラメータ |
|
otNetworkKeyRef(OTNetworkKeyRef)
otCryptoKeyRef otNetworkKeyRef
このデータ型は KeyRef から NetworkKey を表します。
キーへの参照
otNetworkName
struct otNetworkName otNetworkName
この構造はネットワーク名を表します。
otNetworkName
は null で終わる C 文字列(つまり、 m8
文字配列の末尾は null 文字 \0
でなければなりません。
otOperationalDataset
struct otOperationalDataset otOperationalDataset
この構造は、有効または保留中の運用データセットを表します。
データセット内のコンポーネントはオプションです。mComponets
構造体は、データセット内に存在するコンポーネントを指定します。
otOperationalDatasetComponents のセット
struct otOperationalDatasetComponents otOperationalDatasetComponents
この構造は、運用データセットまたは保留中の運用データセットにさまざまなコンポーネントが存在することを表します。
otOperationalDatasetTlvs
struct otOperationalDatasetTlvs otOperationalDatasetTlvs
この構造は、有効または保留中の運用データセットを表します。
運用データセットは、Thread で指定された TLV エンコードです。
変数
OT_TOOL_PACKED_END
OT_TOOL_PACKED_BEGIN struct otNetworkKey OT_TOOL_PACKED_END
関数
otDatasetCreateNewNetwork(新規作成)
otError otDatasetCreateNewNetwork( otInstance *aInstance, otOperationalDataset *aDataset )
このメソッドは、新しいネットワークを形成するときに使用する新しいオペレーショナル データセットを作成します。
詳細 | |||||
---|---|---|---|---|---|
パラメータ |
|
||||
戻り値 |
|
otDatasetGeneratePskc
otError otDatasetGeneratePskc( const char *aPassPhrase, const otNetworkName *aNetworkName, const otExtendedPanId *aExtPanId, otPskc *aPskc )
この関数は、指定されたパスフレーズ、ネットワーク名、拡張 PAN ID から PSKc を生成します。
PSKc は、コミッショナー セッションを確立するために使用されます。
詳細 | |||||||||
---|---|---|---|---|---|---|---|---|---|
パラメータ |
|
||||||||
戻り値 |
|
otDatasetGetActive
otError otDatasetGetActive( otInstance *aInstance, otOperationalDataset *aDataset )
この関数は、有効な運用データセットを取得します。
詳細 | |||||
---|---|---|---|---|---|
パラメータ |
|
||||
戻り値 |
|
otDatasetGetActiveTlvs
otError otDatasetGetActiveTlvs( otInstance *aInstance, otOperationalDatasetTlvs *aDataset )
この関数は、有効な運用データセットを取得します。
詳細 | |||||
---|---|---|---|---|---|
パラメータ |
|
||||
戻り値 |
|
otDatasetGetDelayTimerMinimal
uint32_t otDatasetGetDelayTimerMinimal( otInstance *aInstance )
遅延タイマーを最小にする。
詳細 | |||
---|---|---|---|
パラメータ |
|
||
戻り値 |
|
otDatasetGetPending
otError otDatasetGetPending( otInstance *aInstance, otOperationalDataset *aDataset )
この関数は、保留中の運用データセットを取得します。
詳細 | |||||
---|---|---|---|---|---|
パラメータ |
|
||||
戻り値 |
|
otDatasetGetPendingTlvs
otError otDatasetGetPendingTlvs( otInstance *aInstance, otOperationalDatasetTlvs *aDataset )
この関数は、保留中の運用データセットを取得します。
詳細 | |||||
---|---|---|---|---|---|
パラメータ |
|
||||
戻り値 |
|
otDatasetIsCommissioned
bool otDatasetIsCommissioned( otInstance *aInstance )
この関数は、有効な運用データセットに有効なネットワークが存在するかどうかを示します。
詳細 | |||
---|---|---|---|
パラメータ |
|
||
戻り値 |
有効な運用データセットに有効なネットワークが存在する場合は TRUE、それ以外の場合は FALSE。
|
otDatasetParseTlvs
otError otDatasetParseTlvs( const otOperationalDatasetTlvs *aDatasetTlvs, otOperationalDataset *aDataset )
この関数は、otOperationalDatasetTlvs
からオペレーショナル データセットを解析します。
詳細 | |||||
---|---|---|---|---|---|
パラメータ |
|
||||
戻り値 |
|
otDatasetSendMgmtActiveGet
otError otDatasetSendMgmtActiveGet( otInstance *aInstance, const otOperationalDatasetComponents *aDatasetComponents, const uint8_t *aTlvTypes, uint8_t aLength, const otIp6Address *aAddress )
この関数は MGMT_ACTIVE_GET を送信します。
詳細 | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
パラメータ |
|
||||||||||
戻り値 |
|
otDatasetSendMgmtActiveSet
otError otDatasetSendMgmtActiveSet( otInstance *aInstance, const otOperationalDataset *aDataset, const uint8_t *aTlvs, uint8_t aLength, otDatasetMgmtSetCallback aCallback, void *aContext )
この関数は MGMT_ACTIVE_SET を送信します。
詳細 | |||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
パラメータ |
|
||||||||||||
戻り値 |
|
otDatasetSendMgmtPendingGet
otError otDatasetSendMgmtPendingGet( otInstance *aInstance, const otOperationalDatasetComponents *aDatasetComponents, const uint8_t *aTlvTypes, uint8_t aLength, const otIp6Address *aAddress )
この関数は MGMT_PENDING_GET を送信します。
詳細 | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
パラメータ |
|
||||||||||
戻り値 |
|
otDatasetSendMgmtPendingSet
otError otDatasetSendMgmtPendingSet( otInstance *aInstance, const otOperationalDataset *aDataset, const uint8_t *aTlvs, uint8_t aLength, otDatasetMgmtSetCallback aCallback, void *aContext )
この関数は MGMT_PENDING_SET を送信します。
詳細 | |||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
パラメータ |
|
||||||||||||
戻り値 |
|
otDatasetSetActive
otError otDatasetSetActive( otInstance *aInstance, const otOperationalDataset *aDataset )
この関数は、有効な運用データセットを設定します。
データセットにアクティブなタイムスタンプが含まれていない場合、データセットは部分的にしか完成していません。
部分的に完了したアクティブなデータセットがあるデバイスで Thread が有効になっている場合、そのデバイスはデータセット内の既存の情報を使用して既存の Thread ネットワークへの接続を試みます。ネットワークに接続するには、Thread ネットワークキーのみが必要です。
チャネルがデータセットに含まれていない場合、デバイスはさまざまなチャネルで MLE Announce メッセージを送信して、他のチャネルで隣接するものを探します。
デバイスが Thread ネットワークに正常に接続されると、デバイスは親からアクティブ データセット全体を取得します。ルーター対応デバイスは、完全なアクティブ データセットになるまでルーターまたはリーダーのロールに移行しません。
詳細 | |||||||
---|---|---|---|---|---|---|---|
パラメータ |
|
||||||
戻り値 |
|
otDatasetSetActiveTlvs
otError otDatasetSetActiveTlvs( otInstance *aInstance, const otOperationalDatasetTlvs *aDataset )
この関数は、有効な運用データセットを設定します。
データセットにアクティブなタイムスタンプが含まれていない場合、データセットは部分的にしか完成していません。
部分的に完了したアクティブなデータセットがあるデバイスで Thread が有効になっている場合、そのデバイスはデータセット内の既存の情報を使用して既存の Thread ネットワークへの接続を試みます。ネットワークに接続するには、Thread ネットワークキーのみが必要です。
チャネルがデータセットに含まれていない場合、デバイスはさまざまなチャネルで MLE Announce メッセージを送信して、他のチャネルで隣接するものを探します。
デバイスが Thread ネットワークに正常に接続されると、デバイスは親からアクティブ データセット全体を取得します。ルーター対応デバイスは、完全なアクティブ データセットになるまでルーターまたはリーダーのロールに移行しません。
詳細 | |||||||
---|---|---|---|---|---|---|---|
パラメータ |
|
||||||
戻り値 |
|
otDatasetSetDelayTimerMinimal
otError otDatasetSetDelayTimerMinimal( otInstance *aInstance, uint32_t aDelayTimerMinimal )
遅延タイマーを最小にする。
詳細 | |||||
---|---|---|---|---|---|
パラメータ |
|
||||
戻り値 |
|
otDatasetSetPending
otError otDatasetSetPending( otInstance *aInstance, const otOperationalDataset *aDataset )
この関数は、Pending Operational Dataset を設定します。
詳細 | |||||||
---|---|---|---|---|---|---|---|
パラメータ |
|
||||||
戻り値 |
|
otDatasetSetPendingTlvs
otError otDatasetSetPendingTlvs( otInstance *aInstance, const otOperationalDatasetTlvs *aDataset )
この関数は、Pending Operational Dataset を設定します。
詳細 | |||||||
---|---|---|---|---|---|---|---|
パラメータ |
|
||||||
戻り値 |
|
otDatasetUpdaterCancelUpdate
void otDatasetUpdaterCancelUpdate( otInstance *aInstance )
この関数は、進行中のオペレーション データセット更新リクエスト(ある場合)をキャンセルします。
詳細 | |||
---|---|---|---|
パラメータ |
|
otDatasetUpdaterIsUpdateOngoing(英語)
bool otDatasetUpdaterIsUpdateOngoing( otInstance *aInstance )
この関数は、オペレーション データセットの更新リクエストが進行中かどうかを示します。
詳細 | |||||
---|---|---|---|---|---|
パラメータ |
|
||||
戻り値 |
|
otDatasetUpdaterRequestUpdate
otError otDatasetUpdaterRequestUpdate( otInstance *aInstance, const otOperationalDataset *aDataset, otDatasetUpdaterCallback aCallback, void *aContext )
この関数は、運用データセットの更新をリクエストします。
aDataset
には、更新するフィールドとその新しい値を含める必要があります。このフィールドには、有効なタイムスタンプ フィールドや保留中のタイムスタンプ フィールドを含めることはできません。遅延フィールドは省略できます。省略すると、デフォルト値(1, 000 ミリ秒)が使用されます。
詳細 | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
パラメータ |
|
||||||||||
戻り値 |
|
otNetworkNameFromString
otError otNetworkNameFromString( otNetworkName *aNetworkName, const char *aNameString )
この関数は、指定された null で終わる C 文字列から otNetworkName
インスタンスを設定します。
また、この関数は、指定された aNameString
が UTF-8 エンコードに従っていることと、その長さが OT_NETWORK_NAME_MAX_SIZE
以下であることも検証します。
詳細 | |||||
---|---|---|---|---|---|
パラメータ |
|
||||
戻り値 |
|
マクロ
チャネル 10_MASK
OT_CHANNEL_10_MASK (1 << 10)
チャンネル 10.
チャネル_11_MASK
OT_CHANNEL_11_MASK (1 << 11)
チャンネル 11.
チャネル_12_MASK
OT_CHANNEL_12_MASK (1 << 12)
チャンネル 12.
チャネル_13_MASK
OT_CHANNEL_13_MASK (1 << 13)
チャンネル 13.
チャネル_14_MASK
OT_CHANNEL_14_MASK (1 << 14)
チャンネル 14.
チャネル_15_マスク
OT_CHANNEL_15_MASK (1 << 15)
チャンネル 15.
チャネル_16_MASK
OT_CHANNEL_16_MASK (1 << 16)
チャンネル 16.
チャネル_17_MASK
OT_CHANNEL_17_MASK (1 << 17)
チャンネル 17.
チャネル_18_MASK
OT_CHANNEL_18_MASK (1 << 18)
チャンネル 18.
チャネル_19_マスク
OT_CHANNEL_19_MASK (1 << 19)
チャンネル 19.
チャネル_1_マスク
OT_CHANNEL_1_MASK (1 << 1)
チャンネル 1.
チャネル 20_MASK
OT_CHANNEL_20_MASK (1 << 20)
チャンネル 20.
チャネル_21_MASK
OT_CHANNEL_21_MASK (1 << 21)
チャンネル 21.
チャネル_22_MASK
OT_CHANNEL_22_MASK (1 << 22)
チャンネル 22.
チャネル_23_MASK
OT_CHANNEL_23_MASK (1 << 23)
チャンネル 23.
[OT_CHANNEL_24_MASK]
OT_CHANNEL_24_MASK (1 << 24)
チャンネル 24.
チャネル_25_マスク
OT_CHANNEL_25_MASK (1 << 25)
チャンネル 25.
チャネル_26_MASK
OT_CHANNEL_26_MASK (1 << 26)
チャンネル 26.
チャネル_2_マスク
OT_CHANNEL_2_MASK (1 << 2)
チャンネル 2.
チャネル_3_マスク
OT_CHANNEL_3_MASK (1 << 3)
チャンネル 3.
チャネル_4_マスク
OT_CHANNEL_4_MASK (1 << 4)
チャンネル 4.
チャネル_5_マスク
OT_CHANNEL_5_MASK (1 << 5)
チャンネル 5.
チャネル_6_マスク
OT_CHANNEL_6_MASK (1 << 6)
チャンネル 6.
チャネル_7_マスク
OT_CHANNEL_7_MASK (1 << 7)
チャンネル 7.
チャネル_8_マスク
OT_CHANNEL_8_MASK (1 << 8)
チャンネル 8:
チャネル_9_マスク
OT_CHANNEL_9_MASK (1 << 9)
チャンネル 9:
OT_EXT_PAN_ID_SIZE
OT_EXT_PAN_ID_SIZE 8
スレッドの PAN ID のサイズ(バイト)
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
Thread Network Name フィールドの最大サイズ(バイト)
OT_OPERATIONAL_DATASET_MAX_LENGTH
OT_OPERATIONAL_DATASET_MAX_LENGTH 254
オペレーショナル データセットの最大文字数(バイト単位)。
OT_PSKC_MAX_SIZE
OT_PSKC_MAX_SIZE 16
PSKc の最大サイズ(バイト)
リソース
OpenThread API リファレンスのトピックは、GitHub で入手可能なソースコードに基づいています。 詳細またはドキュメントへの投稿については、リソースをご覧ください。