설정

이 모듈에는 설정의 비 휘발성 저장을위한 플랫폼 추상화가 포함되어 있습니다.

요약

열거 형
`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 }`	열거 형 이 열거 형은 설정 키를 정의합니다.

열거 형

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
 }

열거 형

이 열거 형은 설정 키를 정의합니다.

기능
`otPlatSettingsAdd ( otInstance aInstance, uint16_t aKey, const uint8_t aValue, uint16_t aValueLength)`	`otError` 설정에 값을 추가합니다.
`otPlatSettingsDeinit ( otInstance *aInstance)`	`void` 필요한 경우 설정 하위 시스템에 대한 초기화 해제를 수행합니다.
`otPlatSettingsDelete ( otInstance *aInstance, uint16_t aKey, int aIndex)`	`otError` 설정 저장소에서 설정을 제거합니다.
`otPlatSettingsGet ( otInstance aInstance, uint16_t aKey, int aIndex, uint8_t aValue, uint16_t *aValueLength)`	`otError` 설정 값을 가져옵니다.
`otPlatSettingsInit ( otInstance *aInstance)`	`void` 필요한 경우 설정 하위 시스템에 대한 초기화를 수행합니다.
`otPlatSettingsSet ( otInstance aInstance, uint16_t aKey, const uint8_t aValue, uint16_t aValueLength)`	`otError` 설정 값을 설정하거나 바꿉니다.
`otPlatSettingsSetCriticalKeys ( otInstance aInstance, const uint16_t aKeys, uint16_t aKeysLength)`	`void` 이 기능은 보안 영역에 저장해야하는 중요한 키를 설정합니다.
`otPlatSettingsWipe ( otInstance *aInstance)`	`void` 설정 저장소에서 모든 설정을 제거합니다.

열거 형

익명 열거 형

 anonymous enum

이 열거 형은 설정 키를 정의합니다.

참고 : 새 설정 키를 추가 할 때 키에 해당하는 설정에 보안에 민감한 정보가 포함 된 경우 개발자는 키를 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_ECDSA_KEY`	SRP 클라이언트 ECDSA 공개 / 개인 키 쌍.

기능

otPlatSettingsAdd

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

설정에 값을 추가합니다.

이 함수는 기존 값을 바꾸지 않고 aKey로 식별되는 설정에 값을 추가합니다.

특정 키와 관련된 항목의 순서를 유지하기 위해 기본 구현이 필요하지 않습니다. 부가가치는 끝, 시작 또는 중간 어딘가에 추가 될 수 있습니다. 기존 값의 순서도 변경 될 수 있습니다.

이 함수를 성공적으로 호출하면 여러 값이있는 관련없는 설정이 재정렬 될 수 있습니다.

세부

매개 변수

`[in] aInstance`	OpenThread 인스턴스 구조.
`[in] aKey`	변경할 설정과 관련된 키입니다.
`[in] aValue`	설정의 새 값을 읽어야하는 위치에 대한 포인터입니다. aValueLength가 0이 아닌 경우 NULL이 아니어야합니다.
`[in] aValueLength`	aValue가 가리키는 데이터의 길이. 0 일 수 있습니다.

반환 값

`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가 0이 아닌 경우 NULL이 아니어야합니다.
`[in] aValueLength`	aValue가 가리키는 데이터의 길이. 0 일 수 있습니다.

반환 값

`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 인스턴스 구조.