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

設定

このモジュールには、設定を不揮発性に保存するためのプラットフォームの抽象化が含まれています。

概要

列挙

anonymous enum {
OT_SETTINGS_KEY_ACTIVE_DATASET = 0x0001,
OT_SETTINGS_KEY_PENDING_DATASET = 0x0002,
OT_SETTINGS_KEY_NETWORK_INFO = 0x0003,
OT_SETTINGS_KEY_PARENT_INFO = 0x0004,
OT_SETTINGS_KEY_CHILD_INFO = 0x0005,
OT_SETTINGS_KEY_RESERVED = 0x0006,
OT_SETTINGS_KEY_SLAAC_IID_SECRET_KEY = 0x0007,
OT_SETTINGS_KEY_DAD_INFO = 0x0008,
OT_SETTINGS_KEY_OMR_PREFIX = 0x0009,
OT_SETTINGS_KEY_ON_LINK_PREFIX = 0x000a,
OT_SETTINGS_KEY_SRP_ECDSA_KEY = 0x000b,
OT_SETTINGS_KEY_SRP_CLIENT_INFO = 0x000c,
OT_SETTINGS_KEY_SRP_SERVER_INFO = 0x000d
}
列挙型
この列挙は、設定のキーを定義します。

関数

otPlatSettingsAdd ( otInstance *aInstance, uint16_t aKey, const uint8_t *aValue, uint16_t aValueLength)
設定に値を追加します。
otPlatSettingsDeinit ( otInstance *aInstance)
void
必要に応じて、設定サブシステムの初期化解除を実行します。
otPlatSettingsDelete ( otInstance *aInstance, uint16_t aKey, int aIndex)
設定ストアから設定を削除します。
otPlatSettingsGet ( otInstance *aInstance, uint16_t aKey, int aIndex, uint8_t *aValue, uint16_t *aValueLength)
設定の値を取得します。
otPlatSettingsInit ( otInstance *aInstance)
void
必要に応じて、設定サブシステムの初期化を実行します。
otPlatSettingsSet ( otInstance *aInstance, uint16_t aKey, const uint8_t *aValue, uint16_t aValueLength)
設定の値を設定または置換します。
otPlatSettingsSetCriticalKeys ( otInstance *aInstance, const uint16_t *aKeys, uint16_t aKeysLength)
void
この機能は、安全な場所に保管する必要のある重要なキーを設定します。
otPlatSettingsWipe ( otInstance *aInstance)
void
設定ストアからすべての設定を削除します。

列挙

匿名列挙型

 anonymous enum

この列挙は、設定のキーを定義します。

注意:キーに対応する設定は、セキュリティ機密情報が含まれている場合は、新しいsetingsキーを追加する場合、開発者は配列にキーを追加する必要がありkCriticalKeys

プロパティ
OT_SETTINGS_KEY_ACTIVE_DATASET

アクティブな運用データセット。

OT_SETTINGS_KEY_CHILD_INFO

子供の情報。

OT_SETTINGS_KEY_DAD_INFO

重複アドレス検出(DAD)情報。

OT_SETTINGS_KEY_NETWORK_INFO

スレッドネットワーク情報。

OT_SETTINGS_KEY_OMR_PREFIX

オフメッシュルーティング可能(OMR)プレフィックス。

OT_SETTINGS_KEY_ON_LINK_PREFIX

インフラストラクチャリンクのオンリンクプレフィックス。

OT_SETTINGS_KEY_PARENT_INFO

親情報。

OT_SETTINGS_KEY_PENDING_DATASET

保留中の運用データセット。

OT_SETTINGS_KEY_RESERVED

予約済み(以前は自動起動)。

OT_SETTINGS_KEY_SLAAC_IID_SECRET_KEY

意味的に不透明なIIDを生成するためのSLAACキー。

OT_SETTINGS_KEY_SRP_CLIENT_INFO

SRPクライアント情報(選択されたSRPサーバーアドレス)。

OT_SETTINGS_KEY_SRP_ECDSA_KEY

SRPクライアントECDSA公開鍵/秘密鍵のペア。

OT_SETTINGS_KEY_SRP_SERVER_INFO

SRPサーバー情報(UDPポート)。

関数

otPlatSettingsAdd

otError otPlatSettingsAdd(
  otInstance *aInstance,
  uint16_t aKey,
  const uint8_t *aValue,
  uint16_t aValueLength
)

設定に値を追加します。

この関数は、既存の値を置き換えることなく、aKeyで識別される設定に値を追加します。

特定のキーに関連付けられたアイテムの順序を維持するために、基礎となる実装は必要ないことに注意してください。付加価値は、最後、最初、または途中のどこかに追加される場合があります。既存の値の順序も変更される可能性があります。

この関数を正常に呼び出すと、複数の値を持つ無関係な設定が並べ替えられる可能性があります。

詳細
パラメーター
[in] aInstance
OpenThreadインスタンス構造。
[in] aKey
変更する設定に関連付けられているキー。
[in] aValue
設定の新しい値を読み取る場所へのポインタ。 aValueLengthがゼロ以外の場合、NULLであってはなりません。
[in] aValueLength
aValueが指すデータの長さ。ゼロの可能性があります。
戻り値
OT_ERROR_NONE
指定された設定が追加されたか、追加されるようにステージングされました。
OT_ERROR_NOT_IMPLEMENTED
この機能は、このプラットフォームには実装されていません。
OT_ERROR_NO_BUFS
指定された設定を保存するためのスペースが残っていません。

otPlatSettingsDeinit

void otPlatSettingsDeinit(
  otInstance *aInstance
)

必要に応じて、設定サブシステムの初期化解除を実行します。

詳細
パラメーター
[in] aInstance
OpenThreadインスタンス構造。

otPlatSettingsDelete

otError otPlatSettingsDelete(
  otInstance *aInstance,
  uint16_t aKey,
  int aIndex
)

設定ストアから設定を削除します。

この関数は、設定ストアのaKeyで識別される設定から特定の値を削除します。

特定のキーに関連付けられたアイテムの順序を維持するために、基礎となる実装は必要ないことに注意してください。

詳細
パラメーター
[in] aInstance
OpenThreadインスタンス構造。
[in] aKey
要求された設定に関連付けられたキー。
[in] aIndex
削除する値のインデックス。 -1に設定すると、このaKeyのすべての値が削除されます。
戻り値
OT_ERROR_NONE
指定されたキーとインデックスが見つかり、正常に削除されました。
OT_ERROR_NOT_FOUND
指定されたキーまたはインデックスが設定ストアに見つかりませんでした。
OT_ERROR_NOT_IMPLEMENTED
この機能は、このプラットフォームには実装されていません。

otPlatSettingsGet

otError otPlatSettingsGet(
  otInstance *aInstance,
  uint16_t aKey,
  int aIndex,
  uint8_t *aValue,
  uint16_t *aValueLength
)

設定の値を取得します。

この関数は、aKeyで識別される設定の値をフェッチし、aValueが指すメモリに書き込みます。次に、aValueLengthが指す整数に長さを書き込みます。 aValueLengthの初期値は、aValueに書き込まれる最大バイト数です。

この関数を使用すると、aValueとaValueLengthをNULLに設定することで、値をフェッチせずにキーの存在を確認できます。 aValueのみをNULLに設定することで、設定をフェッチせずに長さを確認することもできます。

複数の値を持つ設定の順序を維持するために、基盤となるストレージの実装は必要ないことに注意してください。このような値の順序は、ストアへの書き込み操作の後に変更される場合があります。

詳細
パラメーター
[in] aInstance
OpenThreadインスタンス構造。
[in] aKey
要求された設定に関連付けられたキー。
[in] aIndex
取得する特定のアイテムのインデックス。
[out] aValue
設定値を書き込む場所へのポインタ。設定の存在または長さをテストするだけの場合は、NULLに設定できます。
[in,out] aValueLength
値の長さへのポインター。呼び出されるとき、このポインターは、aValueに書き込むことができる最大値サイズを含む整数を指している必要があります。戻り時に、設定の実際の長さが書き込まれます。プレゼンスチェックを実行する場合、これはNULLに設定される場合があります。
戻り値
OT_ERROR_NONE
指定された設定が見つかり、正常にフェッチされました。
OT_ERROR_NOT_FOUND
指定された設定が設定ストアに見つかりませんでした。
OT_ERROR_NOT_IMPLEMENTED
この機能は、このプラットフォームには実装されていません。

otPlatSettingsInit

void otPlatSettingsInit(
  otInstance *aInstance
)

必要に応じて、設定サブシステムの初期化を実行します。

詳細
パラメーター
[in] aInstance
OpenThreadインスタンス構造。

otPlatSettingsSet

otError otPlatSettingsSet(
  otInstance *aInstance,
  uint16_t aKey,
  const uint8_t *aValue,
  uint16_t aValueLength
)

設定の値を設定または置換します。

この関数は、aKeyで識別される設定の値を設定または置換します。以前にaKeyに関連付けられた値が複数あった場合、それらはすべて削除され、この単一のエントリに置き換えられます。

この関数を正常に呼び出すと、複数の値を持つ無関係な設定が並べ替えられる可能性があります。

詳細
パラメーター
[in] aInstance
OpenThreadインスタンス構造。
[in] aKey
変更する設定に関連付けられているキー。
[in] aValue
設定の新しい値を読み取る場所へのポインタ。 aValueLengthがゼロ以外の場合、NULLであってはなりません。
[in] aValueLength
aValueが指すデータの長さ。ゼロの可能性があります。
戻り値
OT_ERROR_NONE
指定された設定が変更またはステージングされました。
OT_ERROR_NOT_IMPLEMENTED
この機能は、このプラットフォームには実装されていません。
OT_ERROR_NO_BUFS
指定された設定を保存するためのスペースが残っていません。

otPlatSettingsSetCriticalKeys

void otPlatSettingsSetCriticalKeys(
  otInstance *aInstance,
  const uint16_t *aKeys,
  uint16_t aKeysLength
)

この機能は、安全な場所に保管する必要のある重要なキーを設定します。

メモリはが指すことに注意してくださいaKeys前にリリースされてはいけませんaInstance破壊されます。

詳細
パラメーター
[in] aInstance
OpenThreadインスタンス構造。
[in] aKeys
重要なキーのリストを含む配列へのポインタ。
[in] aKeysLength
内のエントリの数aKeysアレイ。

otPlatSettingsWipe

void otPlatSettingsWipe(
  otInstance *aInstance
)

設定ストアからすべての設定を削除します。

この関数は、設定ストアからすべての設定を削除し、工場出荷時の初期状態にリセットします。

詳細
パラメーター
[in] aInstance
OpenThreadインスタンス構造。