نمونه، مثال

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

خلاصه

شمارش
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 }	شمارشی این شمارش پرچم است که به عنوان بخشی از گذشت تعریف `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 
 }

شمارشی

این شمارش پرچم است که به عنوان بخشی از گذشت تعریف 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_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`	مشترک به یک آدرس Multicast IPv6 است.
`OT_CHANGED_IP6_MULTICAST_UNSUBSCRIBED`	لغو اشتراک از یک آدرس چندپخشی IPv6 است.
`OT_CHANGED_JOINER_STATE`	دولت وصال تغییر کرده است.
`OT_CHANGED_MASTER_KEY`	کلید کارشناسی ارشد تغییر کرده است.
`OT_CHANGED_PSKC`	PSKc تغییر کرده است.
`OT_CHANGED_SECURITY_POLICY`	سیاست امنیتی تغییر کرده است.
`OT_CHANGED_SUPPORTED_CHANNEL_MASK`	پشتیبانی ماسک کانال تغییر کرده است.
`OT_CHANGED_THREAD_BACKBONE_ROUTER_LOCAL`	ستون فقرات محلی پیکربندی روتر را تغییر داد.
`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 ID تغییر کرده است.
`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`	پارتیشن ID تغییر کرده است.
`OT_CHANGED_THREAD_RLOC_ADDED`	RLOC اضافه شده است.
`OT_CHANGED_THREAD_RLOC_REMOVED`	RLOC برداشته شد.
`OT_CHANGED_THREAD_ROLE`	نقش (غیر فعال، جدا، کودک، روتر، رهبر) تغییر داد.

تعریف نوعهای

otChangedFlags

uint32_t otChangedFlags

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

مشاهده OT_CHANGED_* تعاریف.

otInstance

struct otInstance otInstance

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

otStateChangedCallback

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

این اشاره گر تابع نامیده می شود را به اطلاع پیکربندی و یا دولت تغییرات خاصی در OpenThread.

جزئیات

مولفه های

`[in] aFlags`	یک دولت خاص کمی میدان نشان می دهد که تغییر کرده است؟ مشاهده `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.

otInstanceFinalize

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 جدید است.

همچنین ببینید:
otInstanceFinalize

otInstanceInitSingle

 otInstance * otInstanceInitSingle(
  void
)

این تابع مقدار دهی اولیه به عنوان مثال یک شخص از کتابخانه OpenThread.

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

جزئیات
بازگشت	یک اشاره گر به عنوان مثال OpenThread است.

otInstanceIsInitialized

bool otInstanceIsInitialized(
  otInstance *aInstance
)

این تابع مشخص میکند یا نه نمونه است / معتبر اولیه شده است.

به عنوان مثال در نظر گرفته شده معتبر آن است که اگر به دست آورد و مقدار دهی اولیه یا با استفاده از otInstanceInitSingle() (در مورد مثال تک) و یا otInstanceInit() (در مورد چند مثال). یک تماس پس از آن به 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`	می تواند پاسخ به تماس به دلیل محدودیت منابع اضافه کنید.