تنظیمات
این ماژول شامل انتزاع پلت فرم برای ذخیره سازی غیر فرار تنظیمات است.
خلاصه
شمارش ها | |
---|---|
anonymous enum { | 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()
ارسال میشود.
کارکرد
otPlatSettingsAdd
otError otPlatSettingsAdd( otInstance *aInstance, uint16_t aKey, const uint8_t *aValue, uint16_t aValueLength )
یک مقدار به یک تنظیم اضافه می کند.
بدون جایگزین کردن مقادیر موجود، مقدار را به تنظیماتی که توسط aKey
مشخص شده است، اضافه می کند.
توجه داشته باشید که اجرای اساسی برای حفظ ترتیب موارد مرتبط با یک کلید خاص لازم نیست. ارزش افزوده ممکن است به انتها، ابتدا یا حتی جایی در وسط اضافه شود. ترتیب هر مقدار از قبل موجود نیز ممکن است تغییر کند.
فراخوانی موفقیت آمیز این تابع ممکن است باعث شود تنظیمات نامرتبط با چندین مقدار مرتب شوند.
پشته OpenThread استفاده از متد otPlatSettingsAdd()
را برای aKey
که قبلاً توسط otPlatSettingsAdd()
مدیریت میشد تضمین میکند (یعنی حاوی یک یا چند مورد) یا خالی و/یا کاملاً حذف شده است (بدون مقدار).
لایه پلتفرم می تواند برای بهینه سازی پیاده سازی خود به این واقعیت تکیه کرده و استفاده کند.
جزئیات | |||||||||
---|---|---|---|---|---|---|---|---|---|
مولفه های |
| ||||||||
ارزش های بازگشتی |
|
otPlatSettingsDeinit
void otPlatSettingsDeinit( otInstance *aInstance )
در صورت لزوم، هرگونه مقداردهی اولیه را برای زیرسیستم تنظیمات انجام می دهد.
جزئیات | |||
---|---|---|---|
مولفه های |
|
otPlatSettingsDelete
otError otPlatSettingsDelete( otInstance *aInstance, uint16_t aKey, int aIndex )
یک تنظیم را از فروشگاه تنظیمات حذف می کند.
مقدار خاصی را از تنظیمات مشخص شده توسط aKey از ذخیره تنظیمات حذف می کند.
توجه داشته باشید که اجرای اساسی برای حفظ ترتیب موارد مرتبط با یک کلید خاص لازم نیست.
جزئیات | |||||||
---|---|---|---|---|---|---|---|
مولفه های |
| ||||||
ارزش های بازگشتی |
|
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، طول تنظیم را بدون واکشی آن بررسی کنید.
توجه داشته باشید که اجرای ذخیره سازی زیربنایی برای حفظ ترتیب تنظیمات با مقادیر متعدد مورد نیاز نیست. ترتیب چنین مقادیری ممکن است پس از هر گونه عملیات نوشتن در فروشگاه تغییر کند.
جزئیات | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
مولفه های |
| ||||||||||
ارزش های بازگشتی |
|
otPlatSettingsInit
void otPlatSettingsInit( otInstance *aInstance, const uint16_t *aSensitiveKeys, uint16_t aSensitiveKeysLength )
در صورت لزوم هرگونه مقداردهی اولیه را برای زیرسیستم تنظیمات انجام می دهد.
همچنین کلیدهای حساسی را که باید در قسمت امن ذخیره شوند را تنظیم می کند.
توجه داشته باشید که حافظه ای که توسط aSensitiveKeys
اشاره می شود نباید قبل از از بین رفتن aInstance
آزاد شود.
جزئیات | |||||||
---|---|---|---|---|---|---|---|
مولفه های |
|
otPlatSettingsSet
otError otPlatSettingsSet( otInstance *aInstance, uint16_t aKey, const uint8_t *aValue, uint16_t aValueLength )
مقدار یک تنظیم را تنظیم یا جایگزین می کند.
مقدار یک تنظیم مشخص شده توسط aKey
را تنظیم یا جایگزین می کند.
فراخوانی موفقیت آمیز این تابع ممکن است باعث شود تنظیمات نامرتبط با چندین مقدار مرتب شوند.
پشته OpenThread استفاده از متد otPlatSettingsSet()
را برای aKey
که قبلاً با استفاده از otPlatSettingsSet()
تنظیم شده بود تضمین می کند (یعنی حاوی یک مقدار واحد است) یا خالی و/یا کاملاً حذف شده است (هیچ مقداری ندارد).
لایه پلتفرم می تواند برای بهینه سازی پیاده سازی خود به این واقعیت تکیه کرده و استفاده کند.
جزئیات | |||||||||
---|---|---|---|---|---|---|---|---|---|
مولفه های |
| ||||||||
ارزش های بازگشتی |
|
otPlatSettingsWipe
void otPlatSettingsWipe( otInstance *aInstance )
تمام تنظیمات را از فروشگاه تنظیمات حذف می کند.
تمام تنظیمات را از فروشگاه تنظیمات حذف می کند و آن را به حالت اولیه کارخانه بازنشانی می کند.
جزئیات | |||
---|---|---|---|
مولفه های |
|
منابع
موضوعات مرجع OpenThread API از کد منبع موجود در GitHub سرچشمه می گیرند. برای اطلاعات بیشتر، یا مشارکت در اسناد ما، به منابع مراجعه کنید.
،تنظیمات
این ماژول شامل انتزاع پلت فرم برای ذخیره سازی غیر فرار تنظیمات است.
خلاصه
شمارش ها | |
---|---|
anonymous enum { | 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()
ارسال میشود.
کارکرد
otPlatSettingsAdd
otError otPlatSettingsAdd( otInstance *aInstance, uint16_t aKey, const uint8_t *aValue, uint16_t aValueLength )
یک مقدار به یک تنظیم اضافه می کند.
بدون جایگزین کردن مقادیر موجود، مقدار را به تنظیماتی که توسط aKey
مشخص شده است، اضافه می کند.
توجه داشته باشید که اجرای اساسی برای حفظ ترتیب موارد مرتبط با یک کلید خاص لازم نیست. ارزش افزوده ممکن است به انتها، ابتدا یا حتی جایی در وسط اضافه شود. ترتیب هر مقدار از قبل موجود نیز ممکن است تغییر کند.
فراخوانی موفقیت آمیز این تابع ممکن است باعث شود تنظیمات نامرتبط با چندین مقدار مرتب شوند.
پشته OpenThread استفاده از متد otPlatSettingsAdd()
را برای aKey
که قبلاً توسط otPlatSettingsAdd()
مدیریت میشد تضمین میکند (یعنی حاوی یک یا چند مورد) یا خالی و/یا کاملاً حذف شده است (بدون مقدار).
لایه پلتفرم می تواند برای بهینه سازی پیاده سازی خود به این واقعیت تکیه کرده و استفاده کند.
جزئیات | |||||||||
---|---|---|---|---|---|---|---|---|---|
مولفه های |
| ||||||||
ارزش های بازگشتی |
|
otPlatSettingsDeinit
void otPlatSettingsDeinit( otInstance *aInstance )
در صورت لزوم، هرگونه مقداردهی اولیه را برای زیرسیستم تنظیمات انجام می دهد.
جزئیات | |||
---|---|---|---|
مولفه های |
|
otPlatSettingsDelete
otError otPlatSettingsDelete( otInstance *aInstance, uint16_t aKey, int aIndex )
یک تنظیم را از فروشگاه تنظیمات حذف می کند.
مقدار خاصی را از تنظیمات مشخص شده توسط aKey از ذخیره تنظیمات حذف می کند.
توجه داشته باشید که اجرای اساسی برای حفظ ترتیب موارد مرتبط با یک کلید خاص لازم نیست.
جزئیات | |||||||
---|---|---|---|---|---|---|---|
مولفه های |
| ||||||
ارزش های بازگشتی |
|
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، طول تنظیم را بدون واکشی آن بررسی کنید.
توجه داشته باشید که اجرای ذخیره سازی زیربنایی برای حفظ ترتیب تنظیمات با مقادیر متعدد مورد نیاز نیست. ترتیب چنین مقادیری ممکن است پس از هر گونه عملیات نوشتن در فروشگاه تغییر کند.
جزئیات | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
مولفه های |
| ||||||||||
ارزش های بازگشتی |
|
otPlatSettingsInit
void otPlatSettingsInit( otInstance *aInstance, const uint16_t *aSensitiveKeys, uint16_t aSensitiveKeysLength )
در صورت لزوم هرگونه مقداردهی اولیه را برای زیرسیستم تنظیمات انجام می دهد.
همچنین کلیدهای حساسی را که باید در قسمت امن ذخیره شوند را تنظیم می کند.
توجه داشته باشید که حافظه ای که توسط aSensitiveKeys
اشاره می شود نباید قبل از از بین رفتن aInstance
آزاد شود.
جزئیات | |||||||
---|---|---|---|---|---|---|---|
مولفه های |
|
otPlatSettingsSet
otError otPlatSettingsSet( otInstance *aInstance, uint16_t aKey, const uint8_t *aValue, uint16_t aValueLength )
مقدار یک تنظیم را تنظیم یا جایگزین می کند.
مقدار یک تنظیم مشخص شده توسط aKey
را تنظیم یا جایگزین می کند.
فراخوانی موفقیت آمیز این تابع ممکن است باعث شود تنظیمات نامرتبط با چندین مقدار مرتب شوند.
پشته OpenThread استفاده از متد otPlatSettingsSet()
را برای aKey
که قبلاً با استفاده از otPlatSettingsSet()
تنظیم شده بود تضمین می کند (یعنی حاوی یک مقدار واحد است) یا خالی و/یا کاملاً حذف شده است (هیچ مقداری ندارد).
لایه پلتفرم می تواند برای بهینه سازی پیاده سازی خود به این واقعیت تکیه کرده و استفاده کند.
جزئیات | |||||||||
---|---|---|---|---|---|---|---|---|---|
مولفه های |
| ||||||||
ارزش های بازگشتی |
|
otPlatSettingsWipe
void otPlatSettingsWipe( otInstance *aInstance )
تمام تنظیمات را از فروشگاه تنظیمات حذف می کند.
تمام تنظیمات را از فروشگاه تنظیمات حذف می کند و آن را به حالت اولیه کارخانه بازنشانی می کند.
جزئیات | |||
---|---|---|---|
مولفه های |
|
منابع
موضوعات مرجع OpenThread API از کد منبع موجود در GitHub سرچشمه می گیرند. برای اطلاعات بیشتر، یا مشارکت در اسناد ما، به منابع مراجعه کنید.