تنظیمات

این ماژول شامل انتزاع پلت فرم برای ذخیره سازی غیر فرار تنظیمات است.

خلاصه

شمارش ها

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_SLAAC_IID_SECRET_KEY = 0x0007,
OT_SETTINGS_KEY_DAD_INFO = 0x0008,
OT_SETTINGS_KEY_SRP_ECDSA_KEY = 0x000b,
OT_SETTINGS_KEY_SRP_CLIENT_INFO = 0x000c,
OT_SETTINGS_KEY_SRP_SERVER_INFO = 0x000d,
OT_SETTINGS_KEY_BR_ULA_PREFIX = 0x000f,
OT_SETTINGS_KEY_BR_ON_LINK_PREFIXES = 0x0010,
OT_SETTINGS_KEY_BORDER_AGENT_ID = 0x0011
}
enum
کلیدهای تنظیمات را تعریف می کند.

کارکرد

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, const uint16_t *aSensitiveKeys, uint16_t aSensitiveKeysLength)
void
در صورت لزوم هرگونه مقداردهی اولیه را برای زیرسیستم تنظیمات انجام می دهد.
otPlatSettingsSet ( otInstance *aInstance, uint16_t aKey, const uint8_t *aValue, uint16_t aValueLength)
مقدار یک تنظیم را تنظیم یا جایگزین می کند.
otPlatSettingsWipe ( otInstance *aInstance)
void
تمام تنظیمات را از فروشگاه تنظیمات حذف می کند.

شمارش ها

شماره ناشناس

 anonymous enum

کلیدهای تنظیمات را تعریف می کند.

توجه: هنگام افزودن یک کلید تنظیمات جدید، اگر تنظیمات مربوط به کلید حاوی اطلاعات حساس امنیتی باشد، توسعه‌دهنده باید کلید را به آرایه aSensitiveKeys اضافه کند که در otPlatSettingsInit() ارسال می‌شود.

خواص
OT_SETTINGS_KEY_ACTIVE_DATASET

مجموعه داده عملیاتی فعال

OT_SETTINGS_KEY_BORDER_AGENT_ID

شناسه منحصر به فرد مرزی / روتر.

OT_SETTINGS_KEY_BR_ON_LINK_PREFIXES

پیشوندهای روی پیوند محلی BR.

OT_SETTINGS_KEY_BR_ULA_PREFIX

پیشوند BR ULA.

OT_SETTINGS_KEY_CHILD_INFO

اطلاعات کودک

OT_SETTINGS_KEY_DAD_INFO

اطلاعات تشخیص آدرس تکراری (DAD).

OT_SETTINGS_KEY_NETWORK_INFO

اطلاعات شبکه تاپیک

OT_SETTINGS_KEY_PARENT_INFO

اطلاعات والدین

OT_SETTINGS_KEY_PENDING_DATASET

مجموعه داده عملیاتی در انتظار.

OT_SETTINGS_KEY_SLAAC_IID_SECRET_KEY

کلید SLAAC برای تولید ID غیرشفاف معنایی.

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 مشخص شده است، اضافه می کند.

توجه داشته باشید که اجرای اساسی برای حفظ ترتیب موارد مرتبط با یک کلید خاص لازم نیست. ارزش افزوده ممکن است به انتها، ابتدا یا حتی جایی در وسط اضافه شود. ترتیب هر مقدار از قبل موجود نیز ممکن است تغییر کند.

فراخوانی موفقیت آمیز این تابع ممکن است باعث شود تنظیمات نامرتبط با چندین مقدار مرتب شوند.

پشته OpenThread استفاده از متد otPlatSettingsAdd() را برای aKey که قبلاً توسط otPlatSettingsAdd() مدیریت می‌شد تضمین می‌کند (یعنی حاوی یک یا چند مورد) یا خالی و/یا کاملاً حذف شده است (بدون مقدار).

لایه پلتفرم می تواند برای بهینه سازی پیاده سازی خود به این واقعیت تکیه کرده و استفاده کند.

جزئیات
مولفه های
[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,
  const uint16_t *aSensitiveKeys,
  uint16_t aSensitiveKeysLength
)

در صورت لزوم هرگونه مقداردهی اولیه را برای زیرسیستم تنظیمات انجام می دهد.

همچنین کلیدهای حساسی را که باید در قسمت امن ذخیره شوند را تنظیم می کند.

توجه داشته باشید که حافظه ای که توسط aSensitiveKeys اشاره می شود نباید قبل از از بین رفتن aInstance آزاد شود.

جزئیات
مولفه های
[in] aInstance
ساختار نمونه OpenThread.
[in] aSensitiveKeys
اشاره گر به یک آرایه حاوی لیست کلیدهای حساس. فقط اگر aSensitiveKeysLength 0 باشد ممکن است NULL باشد، به این معنی که هیچ کلید حساسی وجود ندارد.
[in] aSensitiveKeysLength
تعداد ورودی ها در آرایه aSensitiveKeys .

otPlatSettingsSet

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

مقدار یک تنظیم را تنظیم یا جایگزین می کند.

مقدار یک تنظیم مشخص شده توسط aKey را تنظیم یا جایگزین می کند.

فراخوانی موفقیت آمیز این تابع ممکن است باعث شود تنظیمات نامرتبط با چندین مقدار مرتب شوند.

پشته OpenThread استفاده از متد otPlatSettingsSet() را برای aKey که قبلاً با استفاده از otPlatSettingsSet() تنظیم شده بود تضمین می کند (یعنی حاوی یک مقدار واحد است) یا خالی و/یا کاملاً حذف شده است (هیچ مقداری ندارد).

لایه پلتفرم می تواند برای بهینه سازی پیاده سازی خود به این واقعیت تکیه کرده و استفاده کند.

جزئیات
مولفه های
[in] aInstance
ساختار نمونه OpenThread.
[in] aKey
کلید مربوط به تنظیم برای تغییر است.
[in] aValue
یک اشاره گر به جایی که مقدار جدید تنظیم باید از کجا خوانده شود. اگر aValueLength غیر صفر است، نباید NULL باشد.
[in] aValueLength
طول داده های اشاره شده توسط aValue. ممکن است صفر باشد.
ارزش های بازگشتی
OT_ERROR_NONE
تنظیم داده شده تغییر یا صحنه سازی شد.
OT_ERROR_NOT_IMPLEMENTED
این تابع در این پلتفرم اجرا نمی شود.
OT_ERROR_NO_BUFS
فضایی برای ذخیره تنظیمات داده شده باقی نمانده است.

otPlatSettingsWipe

void otPlatSettingsWipe(
  otInstance *aInstance
)

تمام تنظیمات را از فروشگاه تنظیمات حذف می کند.

تمام تنظیمات را از فروشگاه تنظیمات حذف می کند و آن را به حالت اولیه کارخانه بازنشانی می کند.

جزئیات
مولفه های
[in] aInstance
ساختار نمونه OpenThread.

منابع

موضوعات مرجع OpenThread API از کد منبع موجود در GitHub سرچشمه می گیرند. برای اطلاعات بیشتر، یا مشارکت در اسناد ما، به منابع مراجعه کنید.

،

تنظیمات

این ماژول شامل انتزاع پلت فرم برای ذخیره سازی غیر فرار تنظیمات است.

خلاصه

شمارش ها

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_SLAAC_IID_SECRET_KEY = 0x0007,
OT_SETTINGS_KEY_DAD_INFO = 0x0008,
OT_SETTINGS_KEY_SRP_ECDSA_KEY = 0x000b,
OT_SETTINGS_KEY_SRP_CLIENT_INFO = 0x000c,
OT_SETTINGS_KEY_SRP_SERVER_INFO = 0x000d,
OT_SETTINGS_KEY_BR_ULA_PREFIX = 0x000f,
OT_SETTINGS_KEY_BR_ON_LINK_PREFIXES = 0x0010,
OT_SETTINGS_KEY_BORDER_AGENT_ID = 0x0011
}
enum
کلیدهای تنظیمات را تعریف می کند.

کارکرد

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, const uint16_t *aSensitiveKeys, uint16_t aSensitiveKeysLength)
void
در صورت لزوم هرگونه مقداردهی اولیه را برای زیرسیستم تنظیمات انجام می دهد.
otPlatSettingsSet ( otInstance *aInstance, uint16_t aKey, const uint8_t *aValue, uint16_t aValueLength)
مقدار یک تنظیم را تنظیم یا جایگزین می کند.
otPlatSettingsWipe ( otInstance *aInstance)
void
تمام تنظیمات را از فروشگاه تنظیمات حذف می کند.

شمارش ها

شماره ناشناس

 anonymous enum

کلیدهای تنظیمات را تعریف می کند.

توجه: هنگام افزودن یک کلید تنظیمات جدید، اگر تنظیمات مربوط به کلید حاوی اطلاعات حساس امنیتی باشد، توسعه‌دهنده باید کلید را به آرایه aSensitiveKeys اضافه کند که در otPlatSettingsInit() ارسال می‌شود.

خواص
OT_SETTINGS_KEY_ACTIVE_DATASET

مجموعه داده عملیاتی فعال

OT_SETTINGS_KEY_BORDER_AGENT_ID

شناسه منحصر به فرد مرزی / روتر.

OT_SETTINGS_KEY_BR_ON_LINK_PREFIXES

پیشوندهای روی پیوند محلی BR.

OT_SETTINGS_KEY_BR_ULA_PREFIX

پیشوند BR ULA.

OT_SETTINGS_KEY_CHILD_INFO

اطلاعات کودک

OT_SETTINGS_KEY_DAD_INFO

اطلاعات تشخیص آدرس تکراری (DAD).

OT_SETTINGS_KEY_NETWORK_INFO

اطلاعات شبکه تاپیک

OT_SETTINGS_KEY_PARENT_INFO

اطلاعات والدین

OT_SETTINGS_KEY_PENDING_DATASET

مجموعه داده عملیاتی در انتظار.

OT_SETTINGS_KEY_SLAAC_IID_SECRET_KEY

کلید SLAAC برای تولید ID غیرشفاف معنایی.

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 مشخص شده است، اضافه می کند.

توجه داشته باشید که اجرای اساسی برای حفظ ترتیب موارد مرتبط با یک کلید خاص لازم نیست. ارزش افزوده ممکن است به انتها، ابتدا یا حتی جایی در وسط اضافه شود. ترتیب هر مقدار از قبل موجود نیز ممکن است تغییر کند.

فراخوانی موفقیت آمیز این تابع ممکن است باعث شود تنظیمات نامرتبط با چندین مقدار مرتب شوند.

پشته OpenThread استفاده از متد otPlatSettingsAdd() را برای aKey که قبلاً توسط otPlatSettingsAdd() مدیریت می‌شد تضمین می‌کند (یعنی حاوی یک یا چند مورد) یا خالی و/یا کاملاً حذف شده است (بدون مقدار).

لایه پلتفرم می تواند برای بهینه سازی پیاده سازی خود به این واقعیت تکیه کرده و استفاده کند.

جزئیات
مولفه های
[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,
  const uint16_t *aSensitiveKeys,
  uint16_t aSensitiveKeysLength
)

در صورت لزوم هرگونه مقداردهی اولیه را برای زیرسیستم تنظیمات انجام می دهد.

همچنین کلیدهای حساسی را که باید در قسمت امن ذخیره شوند را تنظیم می کند.

توجه داشته باشید که حافظه ای که توسط aSensitiveKeys اشاره می شود نباید قبل از از بین رفتن aInstance آزاد شود.

جزئیات
مولفه های
[in] aInstance
ساختار نمونه OpenThread.
[in] aSensitiveKeys
اشاره گر به یک آرایه حاوی لیست کلیدهای حساس. فقط اگر aSensitiveKeysLength 0 باشد ممکن است NULL باشد، به این معنی که هیچ کلید حساسی وجود ندارد.
[in] aSensitiveKeysLength
تعداد ورودی ها در آرایه aSensitiveKeys .

otPlatSettingsSet

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

مقدار یک تنظیم را تنظیم یا جایگزین می کند.

مقدار یک تنظیم مشخص شده توسط aKey را تنظیم یا جایگزین می کند.

فراخوانی موفقیت آمیز این تابع ممکن است باعث شود تنظیمات نامرتبط با چندین مقدار مرتب شوند.

پشته OpenThread استفاده از متد otPlatSettingsSet() را برای aKey که قبلاً با استفاده از otPlatSettingsSet() تنظیم شده بود تضمین می کند (یعنی حاوی یک مقدار واحد است) یا خالی و/یا کاملاً حذف شده است (هیچ مقداری ندارد).

لایه پلتفرم می تواند برای بهینه سازی پیاده سازی خود به این واقعیت تکیه کرده و استفاده کند.

جزئیات
مولفه های
[in] aInstance
ساختار نمونه OpenThread.
[in] aKey
کلید مربوط به تنظیم برای تغییر است.
[in] aValue
یک اشاره گر به جایی که مقدار جدید تنظیم باید از کجا خوانده شود. اگر aValueLength غیر صفر است، نباید NULL باشد.
[in] aValueLength
طول داده های اشاره شده توسط aValue. ممکن است صفر باشد.
ارزش های بازگشتی
OT_ERROR_NONE
تنظیم داده شده تغییر یا صحنه سازی شد.
OT_ERROR_NOT_IMPLEMENTED
این تابع در این پلتفرم اجرا نمی شود.
OT_ERROR_NO_BUFS
فضایی برای ذخیره تنظیمات داده شده باقی نمانده است.

otPlatSettingsWipe

void otPlatSettingsWipe(
  otInstance *aInstance
)

تمام تنظیمات را از فروشگاه تنظیمات حذف می کند.

تمام تنظیمات را از فروشگاه تنظیمات حذف می کند و آن را به حالت اولیه کارخانه بازنشانی می کند.

جزئیات
مولفه های
[in] aInstance
ساختار نمونه OpenThread.

منابع

موضوعات مرجع OpenThread API از کد منبع موجود در GitHub سرچشمه می گیرند. برای اطلاعات بیشتر، یا مشارکت در اسناد ما، به منابع مراجعه کنید.