نمونه، مثال

این ماژول شامل توابعی است که OpenThread Instance را کنترل می کنند.

خلاصه

شمارش ها
anonymous enum { OT_CHANGED_IP6_ADDRESS_ADDED = 1 << 0, OT_CHANGED_IP6_ADDRESS_REMOVED = 1 << 1, OT_CHANGED_THREAD_ROLE = 1 << 2, OT_CHANGED_THREAD_LL_ADDR = 1 << 3, OT_CHANGED_THREAD_ML_ADDR = 1 << 4, OT_CHANGED_THREAD_RLOC_ADDED = 1 << 5, OT_CHANGED_THREAD_RLOC_REMOVED = 1 << 6, OT_CHANGED_THREAD_PARTITION_ID = 1 << 7, OT_CHANGED_THREAD_KEY_SEQUENCE_COUNTER = 1 << 8, OT_CHANGED_THREAD_NETDATA = 1 << 9, OT_CHANGED_THREAD_CHILD_ADDED = 1 << 10, OT_CHANGED_THREAD_CHILD_REMOVED = 1 << 11, OT_CHANGED_IP6_MULTICAST_SUBSCRIBED = 1 << 12, OT_CHANGED_IP6_MULTICAST_UNSUBSCRIBED = 1 << 13, OT_CHANGED_THREAD_CHANNEL = 1 << 14, OT_CHANGED_THREAD_PANID = 1 << 15, OT_CHANGED_THREAD_NETWORK_NAME = 1 << 16, OT_CHANGED_THREAD_EXT_PANID = 1 << 17, OT_CHANGED_MASTER_KEY = 1 << 18, OT_CHANGED_PSKC = 1 << 19, OT_CHANGED_SECURITY_POLICY = 1 << 20, OT_CHANGED_CHANNEL_MANAGER_NEW_CHANNEL = 1 << 21, OT_CHANGED_SUPPORTED_CHANNEL_MASK = 1 << 22, OT_CHANGED_COMMISSIONER_STATE = 1 << 23, OT_CHANGED_THREAD_NETIF_STATE = 1 << 24, OT_CHANGED_THREAD_BACKBONE_ROUTER_STATE = 1 << 25, OT_CHANGED_THREAD_BACKBONE_ROUTER_LOCAL = 1 << 26, OT_CHANGED_JOINER_STATE = 1 << 27, OT_CHANGED_ACTIVE_DATASET = 1 << 28, OT_CHANGED_PENDING_DATASET = 1 << 29 }	شمردن این شمارش پرچم هایی را که به عنوان بخشی از `otStateChangedCallback` منتقل می شوند ، تعریف می کند.

شمارش ها

anonymous enum {
 OT_CHANGED_IP6_ADDRESS_ADDED = 1 << 0,
 OT_CHANGED_IP6_ADDRESS_REMOVED = 1 << 1,
 OT_CHANGED_THREAD_ROLE = 1 << 2,
 OT_CHANGED_THREAD_LL_ADDR = 1 << 3,
 OT_CHANGED_THREAD_ML_ADDR = 1 << 4,
 OT_CHANGED_THREAD_RLOC_ADDED = 1 << 5,
 OT_CHANGED_THREAD_RLOC_REMOVED = 1 << 6,
 OT_CHANGED_THREAD_PARTITION_ID = 1 << 7,
 OT_CHANGED_THREAD_KEY_SEQUENCE_COUNTER = 1 << 8,
 OT_CHANGED_THREAD_NETDATA = 1 << 9,
 OT_CHANGED_THREAD_CHILD_ADDED = 1 << 10,
 OT_CHANGED_THREAD_CHILD_REMOVED = 1 << 11,
 OT_CHANGED_IP6_MULTICAST_SUBSCRIBED = 1 << 12,
 OT_CHANGED_IP6_MULTICAST_UNSUBSCRIBED = 1 << 13,
 OT_CHANGED_THREAD_CHANNEL = 1 << 14,
 OT_CHANGED_THREAD_PANID = 1 << 15,
 OT_CHANGED_THREAD_NETWORK_NAME = 1 << 16,
 OT_CHANGED_THREAD_EXT_PANID = 1 << 17,
 OT_CHANGED_MASTER_KEY = 1 << 18,
 OT_CHANGED_PSKC = 1 << 19,
 OT_CHANGED_SECURITY_POLICY = 1 << 20,
 OT_CHANGED_CHANNEL_MANAGER_NEW_CHANNEL = 1 << 21,
 OT_CHANGED_SUPPORTED_CHANNEL_MASK = 1 << 22,
 OT_CHANGED_COMMISSIONER_STATE = 1 << 23,
 OT_CHANGED_THREAD_NETIF_STATE = 1 << 24,
 OT_CHANGED_THREAD_BACKBONE_ROUTER_STATE = 1 << 25,
 OT_CHANGED_THREAD_BACKBONE_ROUTER_LOCAL = 1 << 26,
 OT_CHANGED_JOINER_STATE = 1 << 27,
 OT_CHANGED_ACTIVE_DATASET = 1 << 28,
 OT_CHANGED_PENDING_DATASET = 1 << 29
 }

شمردن

این شمارش پرچم هایی را که به عنوان بخشی از otStateChangedCallback منتقل می شوند ، تعریف می کند.

انواع تایپ
`otChangedFlags`	typedef `uint32_t` این نوع یک بیت-میدان را نشان می دهد که وضعیت / پیکربندی خاصی را تغییر داده است.
`otInstance`	typedef `struct otInstance` این ساختار نشان دهنده ساختار نمونه OpenThread است.
`otStateChangedCallback )(otChangedFlags aFlags, void *aContext)`	typedef `void(*` این نشانگر عملکرد فراخوانی می شود تا تغییرات خاص پیکربندی یا وضعیت را در OpenThread آگاه کند.

کارکرد
`otGetRadioVersionString ( otInstance *aInstance)`	`const char *` این عملکرد رشته نسخه رادیویی OpenThread را دریافت می کند.
`otGetVersionString (void)`	`const char *` این عملکرد رشته OpenThread را دریافت می کند.
`otInstanceErasePersistentInfo ( otInstance *aInstance)`	`otError` این عملکرد تمام اطلاعات پایدار OpenThread (تنظیمات شبکه) را که در حافظه غیر فرار ذخیره شده اند پاک می کند.
`otInstanceFactoryReset ( otInstance *aInstance)`	`void` این روش تمام تنظیمات ذخیره شده در حافظه غیر فرار را حذف کرده و سپس باعث بازنشانی سیستم عامل می شود.
`otInstanceFinalize ( otInstance *aInstance)`	`void` این عملکرد کتابخانه OpenThread را غیرفعال می کند.
`otInstanceInit (void aInstanceBuffer, size_t aInstanceBufferSize)`	`otInstance *` این عملکرد کتابخانه OpenThread را اولیه می کند.
`otInstanceInitSingle (void)`	`otInstance *` این تابع نمونه استاتیک تک کتابخانه OpenThread را شروع می کند.
`otInstanceIsInitialized ( otInstance *aInstance)`	`bool` این تابع معتبر یا اولیه بودن نمونه را نشان می دهد.
`otInstanceReset ( otInstance *aInstance)`	`void` این روش باعث بازنشانی سیستم عامل می شود.
`otRemoveStateChangeCallback ( otInstance aInstance, otStateChangedCallback aCallback, void aContext)`	`void` این عملکرد یک تماس برگشتی را برای نشان دادن تغییر تنظیمات یا وضعیت خاصی در OpenThread حذف می کند.
`otSetStateChangedCallback ( otInstance aInstance, otStateChangedCallback aCallback, void aContext)`	`otError` این عملکرد یک تماس برای ثبت زمان تغییر تنظیمات یا وضعیت خاصی در OpenThread ثبت می کند.

شمارش ها

انوم بی نام

 anonymous enum

این شمارش پرچم هایی را که به عنوان بخشی از otStateChangedCallback منتقل می شوند ، تعریف می کند.

خواص
`OT_CHANGED_ACTIVE_DATASET`	مجموعه داده فعال عملیاتی تغییر کرد.
`OT_CHANGED_CHANNEL_MANAGER_NEW_CHANNEL`	مدیر کانال کانال درحال تعلیق در حال تغییر است.
`OT_CHANGED_COMMISSIONER_STATE`	کشور کمیسر تغییر کرد.
`OT_CHANGED_IP6_ADDRESS_ADDED`	آدرس IPv6 اضافه شد.
`OT_CHANGED_IP6_ADDRESS_REMOVED`	آدرس IPv6 حذف شد.
`OT_CHANGED_IP6_MULTICAST_SUBSCRIBED`	در یک آدرس چندپخشی IPv6 مشترک شده اید.
`OT_CHANGED_IP6_MULTICAST_UNSUBSCRIBED`	اشتراک در یک آدرس چندپخشی IPv6 لغو نمی شود.
`OT_CHANGED_JOINER_STATE`	وضعیت وصال تغییر کرد.
`OT_CHANGED_MASTER_KEY`	کلید اصلی تغییر کرد.
`OT_CHANGED_PENDING_DATASET`	مجموعه داده معلق در انتظار تغییر یافت.
`OT_CHANGED_PSKC`	PSKc تغییر کرد.
`OT_CHANGED_SECURITY_POLICY`	سیاست امنیتی تغییر کرد.
`OT_CHANGED_SUPPORTED_CHANNEL_MASK`	ماسک کانال پشتیبانی شده تغییر کرد.
`OT_CHANGED_THREAD_BACKBONE_ROUTER_LOCAL`	پیکربندی Local Backbone Router تغییر کرد.
`OT_CHANGED_THREAD_BACKBONE_ROUTER_STATE`	وضعیت روتر ستون فقرات تغییر کرد.
`OT_CHANGED_THREAD_CHANNEL`	کانال شبکه موضوع تغییر کرد.
`OT_CHANGED_THREAD_CHILD_ADDED`	کودک اضافه شد
`OT_CHANGED_THREAD_CHILD_REMOVED`	کودک برداشته شد.
`OT_CHANGED_THREAD_EXT_PANID`	شناسه PAN شبکه گسترده رشته تغییر کرد.
`OT_CHANGED_THREAD_KEY_SEQUENCE_COUNTER`	دنباله کلید موضوع تغییر کرد.
`OT_CHANGED_THREAD_LL_ADDR`	آدرس محلی پیوند تغییر کرد.
`OT_CHANGED_THREAD_ML_ADDR`	آدرس محلی-مش تغییر کرد.
`OT_CHANGED_THREAD_NETDATA`	موضوع شبکه موضوع تغییر کرد.
`OT_CHANGED_THREAD_NETIF_STATE`	موضوع رابط شبکه موضوع تغییر کرد.
`OT_CHANGED_THREAD_NETWORK_NAME`	نام شبکه موضوع تغییر کرد.
`OT_CHANGED_THREAD_PANID`	شناسه PAN شبکه موضوع تغییر کرد.
`OT_CHANGED_THREAD_PARTITION_ID`	شناسه پارتیشن تغییر کرد.
`OT_CHANGED_THREAD_RLOC_ADDED`	RLOC اضافه شد.
`OT_CHANGED_THREAD_RLOC_REMOVED`	RLOC حذف شد.
`OT_CHANGED_THREAD_ROLE`	نقش (غیرفعال ، جدا ، کودک ، روتر ، رهبر) تغییر کرد.

انواع تایپ

otChangedFlags

uint32_t otChangedFlags

این نوع یک بیت-میدان را نشان می دهد که وضعیت / پیکربندی خاصی را تغییر داده است.

تعاریف OT_CHANGED_* ببینید.

خودکار

struct otInstance otInstance

این ساختار نشان دهنده ساختار نمونه OpenThread است.

otStateChangedCallback

void(* otStateChangedCallback)(otChangedFlags aFlags, void *aContext)

این نشانگر عملکرد فراخوانی می شود تا تنظیمات خاص یا تغییرات وضعیت را در OpenThread آگاه کند.

جزئیات

مولفه های

`[in] aFlags`	یک قسمت bit نشان دهنده حالت خاصی است که تغییر کرده است. تعاریف `OT_CHANGED_*` ببینید.
`[in] aContext`	یک نشانگر برای متن خاص برنامه.

کارکرد

رشته otGetRadioVersionString

const char * otGetRadioVersionString(
  otInstance *aInstance
)

این عملکرد رشته نسخه رادیویی OpenThread را دریافت می کند.

جزئیات

مولفه های

[in] aInstance

یک اشاره گر به یک نمونه OpenThread.

برمی گردد

اشاره گر به نسخه رادیویی OpenThread.

رشته otGetVersionString

const char * otGetVersionString(
  void
)

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

جزئیات
برمی گردد	یک نشانگر برای نسخه OpenThread.

otInstanceErasePersistentInfo

otError otInstanceErasePersistentInfo(
  otInstance *aInstance
)

این عملکرد تمام اطلاعات پایدار OpenThread (تنظیمات شبکه) را که در حافظه غیر فرار ذخیره شده اند پاک می کند.

پاک کردن فقط درصورتی موفقیت آمیز است که دستگاه در حالت / نقش disabled باشد.

جزئیات

مولفه های

[in] aInstance

یک اشاره گر به یک نمونه OpenThread.

مقادیر برگشتی

`OT_ERROR_NONE`	تمام اطلاعات / وضعیت پایدار با موفقیت پاک شد.
`OT_ERROR_INVALID_STATE`	دستگاه در حالت / نقش `disabled` نیست.

otInstanceFactoryReset

void otInstanceFactoryReset(
  otInstance *aInstance
)

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

جزئیات

مولفه های

[in] aInstance

یک اشاره گر به یک نمونه OpenThread.

otInstance نهایی کردن

void otInstanceFinalize(
  otInstance *aInstance
)

این عملکرد کتابخانه OpenThread را غیرفعال می کند.

وقتی OpenThread دیگر استفاده نمی شود با این عملکرد تماس بگیرید.

جزئیات

مولفه های

[in] aInstance

یک اشاره گر به یک نمونه OpenThread.

otInstanceInit

otInstance * otInstanceInit(
  void *aInstanceBuffer,
  size_t *aInstanceBufferSize
)

این عملکرد کتابخانه OpenThread را اولیه می کند.

این عملکرد OpenThread را مقدار اولیه می دهد و آن را برای تماس های بعدی OpenThread API آماده می کند. این عملکرد باید قبل از هر تماس دیگری با OpenThread فراخوانی شود.

این عملکرد در دسترس است و فقط هنگامی می توان از آن استفاده کرد که پشتیبانی از چندین نمونه OpenThread فعال باشد.

جزئیات

مولفه های

`[in] aInstanceBuffer`	بافر OpenThread که برای تخصیص ساختار otInstance استفاده می شود.
`[in,out] aInstanceBufferSize`	در ورودی ، اندازه aInstanceBuffer. در خروجی ، اگر فضای کافی برای otInstance نباشد ، تعداد بایت های مورد نیاز برای otInstance.

برمی گردد

اشاره گر به نمونه OpenThread جدید.

همچنین مشاهده کنید:
otInstance نهایی کردن

otInstanceInitSingle

otInstance * otInstanceInitSingle(
  void
)

این تابع نمونه مستقیمی از کتابخانه OpenThread را آغاز می کند.

این عملکرد در دسترس است و فقط در صورت غیرفعال بودن پشتیبانی از چندین نمونه OpenThread می توان از آن استفاده کرد.

جزئیات
برمی گردد	اشاره گر به نمونه OpenThread منفرد.

otInstanceIsInitialized

bool otInstanceIsInitialized(
  otInstance *aInstance
)

این تابع معتبر یا اولیه بودن نمونه را نشان می دهد.

نمونه در صورتی معتبر در نظر گرفته می شود که با استفاده از otInstanceInitSingle() (در یک مورد منفرد) یا otInstanceInit() (در حالت چند نمونه ای) بدست آمده و مقداردهی اولیه شود. فراخوانی بعدی به otInstanceFinalize() باعث می شود که نمونه به عنوان غیر اولیه otInstanceFinalize() شود.

جزئیات

مولفه های

[in] aInstance

یک اشاره گر به یک نمونه OpenThread.

برمی گردد

درست است اگر نمونه داده شده معتبر / اولیه باشد ، در غیر این صورت نادرست است.

otInstanceReset

void otInstanceReset(
  otInstance *aInstance
)

این روش باعث بازنشانی سیستم عامل می شود.

روند بازنشانی تضمین می کند که تمام وضعیت / اطلاعات OpenThread (ذخیره شده در حافظه فرار) پاک می شود. توجه داشته باشید که otPlatformReset هیچ حالت / اطلاعات پایدار ذخیره شده در حافظه غیر فرار را پاک نمی کند.

جزئیات

مولفه های

[in] aInstance

یک اشاره گر به یک نمونه OpenThread.

otRemoveStateChangeCallback

void otRemoveStateChangeCallback(
  otInstance *aInstance,
  otStateChangedCallback aCallback,
  void *aContext
)

این عملکرد یک تماس برگشتی را برای نشان دادن تغییر تنظیمات یا وضعیت خاصی در OpenThread حذف می کند.

جزئیات

مولفه های

`[in] aInstance`	یک اشاره گر به یک نمونه OpenThread.
`[in] aCallback`	یک نشانگر برای عملکردی که با تغییرات خاص در تنظیمات یا تنظیمات فراخوانی می شود.
`[in] aContext`	یک نشانگر برای متن خاص برنامه.

otSetStateChangedCallback

otError otSetStateChangedCallback(
  otInstance *aInstance,
  otStateChangedCallback aCallback,
  void *aContext
)

این عملکرد یک تماس برای ثبت زمان تغییر تنظیمات یا وضعیت خاصی در OpenThread ثبت می کند.

جزئیات

مولفه های

`[in] aInstance`	یک اشاره گر به یک نمونه OpenThread.
`[in] aCallback`	یک نشانگر برای عملکردی که با تغییرات خاص در تنظیمات یا تنظیمات فراخوانی می شود.
`[in] aContext`	یک نشانگر برای متن خاص برنامه.

مقادیر برگشتی

`OT_ERROR_NONE`	پاسخ را به لیست پاسخها اضافه کرد.
`OT_ERROR_ALREADY`	پاسخ تماس قبلاً ثبت شده بود.
`OT_ERROR_NO_BUFS`	به دلیل محدودیت منابع نمی توان پاسخ را اضافه کرد.