روتر/لیدر

این ماژول شامل توابعی برای Thread Routers و Leaders می باشد.

خلاصه

شمارش ها

otCacheEntryState شمارش
این شمارش وضعیت ورودی کش EID را مشخص می کند.
otNeighborTableEvent {
OT_NEIGHBOR_TABLE_EVENT_CHILD_ADDED ,
OT_NEIGHBOR_TABLE_EVENT_CHILD_REMOVED ,
OT_NEIGHBOR_TABLE_EVENT_CHILD_MODE_CHANGED ,
OT_NEIGHBOR_TABLE_EVENT_ROUTER_ADDED ,
OT_NEIGHBOR_TABLE_EVENT_ROUTER_REMOVED
}
شمارش
این شمارش ثابت های مورد استفاده در otNeighborTableCallback را برای نشان دادن تغییرات در جدول همسایه تعریف می کند.

Typedefs

otCacheEntryInfo typedef
این ساختار یک ورودی کش EID را نشان می دهد.
otCacheEntryIterator typedef
این نوع یک تکرار کننده را نشان می دهد که برای تکرار از طریق ورودی های جدول کش EID استفاده می شود.
otCacheEntryState typedef
این شمارش وضعیت ورودی کش EID را مشخص می کند.
otChildIp6AddressIterator typedef
uint16_t
برای تکرار از طریق آدرس های IPv6 ورودی Thread Child استفاده می شود.
otNeighborTableCallback )(otNeighborTableEvent aEvent, const otNeighborTableEntryInfo *aEntryInfo) typedef
void(*
این نشانگر تابع برای اطلاع از تغییر در جدول همسایه فراخوانی می شود.

کارکرد

otThreadBecomeLeader ( otInstance *aInstance)
رهبر شوید و یک پارتیشن جدید راه اندازی کنید.
otThreadBecomeRouter ( otInstance *aInstance)
برای تبدیل شدن به روتر تلاش کنید.
otThreadGetChildInfoById ( otInstance *aInstance, uint16_t aChildId, otChildInfo *aChildInfo)
این عملکرد اطلاعات تشخیصی را برای یک Child پیوست شده توسط Child ID یا RLOC16 حفظ می کند.
otThreadGetChildInfoByIndex ( otInstance *aInstance, uint16_t aChildIndex, otChildInfo *aChildInfo)
این تابع اطلاعات تشخیصی را برای یک Child پیوست شده توسط نمایه جدول داخلی حفظ می کند.
otThreadGetChildNextIp6Address ( otInstance *aInstance, uint16_t aChildIndex, otChildIp6AddressIterator *aIterator, otIp6Address *aAddress)
این تابع آدرس IPv6 بعدی (با استفاده از تکرارکننده) را برای یک فرزند معین دریافت می کند.
otThreadGetContextIdReuseDelay ( otInstance *aInstance)
uint32_t
پارامتر CONTEXT_ID_REUSE_DELAY مورد استفاده در نقش رهبر را دریافت کنید.
otThreadGetJoinerUdpPort ( otInstance *aInstance)
uint16_t
پورت Joiner UDP را دریافت کنید.
otThreadGetLocalLeaderWeight ( otInstance *aInstance)
uint8_t
هنگامی که در نقش رهبر کار می کنید، از وزن رهبر موضوع استفاده کنید.
otThreadGetMaxAllowedChildren ( otInstance *aInstance)
uint16_t
حداکثر تعداد فرزندان مجاز در حال حاضر را دریافت کنید.
otThreadGetMaxChildIpAddresses ( otInstance *aInstance)
uint8_t
این تابع حداکثر تعداد آدرس‌های IP را که هر فرزند MTD ممکن است در این دستگاه به‌عنوان والدین ثبت کند، دریافت می‌کند.
otThreadGetMaxRouterId ( otInstance *aInstance)
uint8_t
این تابع حداکثر شناسه مجاز روتر را برمی گرداند.
otThreadGetNetworkIdTimeout ( otInstance *aInstance)
uint8_t
پارامتر NETWORK_ID_TIMEOUT مورد استفاده در نقش روتر را دریافت کنید.
otThreadGetNextCacheEntry ( otInstance *aInstance, otCacheEntryInfo *aEntryInfo, otCacheEntryIterator *aIterator)
این تابع ورودی کش EID بعدی را دریافت می کند (با استفاده از یک تکرار کننده).
otThreadGetParentPriority ( otInstance *aInstance)
int8_t
اولویت والدین تعیین شده را دریافت کنید.
otThreadGetPreferredLeaderPartitionId ( otInstance *aInstance)
uint32_t
شناسه پارتیشن Thread Leader ترجیحی را که هنگام کار در نقش رهبر استفاده می شود، دریافت کنید.
otThreadGetPskc ( otInstance *aInstance, otPskc *aPskc)
void
موضوع PSKc را دریافت کنید.
otThreadGetPskcRef ( otInstance *aInstance)
دریافت مرجع کلید به موضوع PSKc ذخیره شده.
otThreadGetRouterDowngradeThreshold ( otInstance *aInstance)
uint8_t
پارامتر ROUTER_DOWNGRADE_THRESHOLD مورد استفاده در نقش روتر را دریافت کنید.
otThreadGetRouterIdRange ( otInstance *aInstance, uint8_t *aMinRouterId, uint8_t *aMaxRouterId)
void
این تابع محدوده شناسه های روتر را دریافت می کند که مجاز به تخصیص به گره های داخل شبکه رشته هستند.
otThreadGetRouterIdSequence ( otInstance *aInstance)
uint8_t
دنباله شناسه روتر فعلی را دریافت کنید.
otThreadGetRouterInfo ( otInstance *aInstance, uint16_t aRouterId, otRouterInfo *aRouterInfo)
این تابع اطلاعات تشخیصی را برای یک روتر Thread معین حفظ می کند.
otThreadGetRouterSelectionJitter ( otInstance *aInstance)
uint8_t
پارامتر ROUTER_SELECTION_JITTER مورد استفاده در نقش REED/Router را دریافت کنید.
otThreadGetRouterUpgradeThreshold ( otInstance *aInstance)
uint8_t
پارامتر ROUTER_UPGRADE_THRESHOLD مورد استفاده در نقش REED را دریافت کنید.
otThreadIsRouterEligible ( otInstance *aInstance)
bool
این روش نشان می دهد که آیا دستگاه واجد شرایط روتر است یا خیر.
otThreadRegisterNeighborTableCallback ( otInstance *aInstance, otNeighborTableCallback aCallback)
void
این تابع یک تابع فراخوانی جدول همسایه را ثبت می کند.
otThreadReleaseRouterId ( otInstance *aInstance, uint8_t aRouterId)
شناسه روتر را که توسط دستگاه در نقش رهبر تخصیص داده شده است، آزاد کنید.
otThreadSetCcmEnabled ( otInstance *aInstance, bool aEnabled)
void
این عملکرد تعیین می کند که آیا دستگاه با استفاده از CCM راه اندازی شده است یا خیر.
otThreadSetContextIdReuseDelay ( otInstance *aInstance, uint32_t aDelay)
void
پارامتر CONTEXT_ID_REUSE_DELAY مورد استفاده در نقش رهبر را تنظیم کنید.
otThreadSetJoinerUdpPort ( otInstance *aInstance, uint16_t aJoinerUdpPort)
پورت Joiner UDP را تنظیم کنید.
otThreadSetLocalLeaderWeight ( otInstance *aInstance, uint8_t aWeight)
void
وزن رهبر نخ مورد استفاده در نقش رهبر را تنظیم کنید.
otThreadSetMaxAllowedChildren ( otInstance *aInstance, uint16_t aMaxChildren)
حداکثر تعداد فرزندان مجاز در حال حاضر را تنظیم کنید.
otThreadSetMaxChildIpAddresses ( otInstance *aInstance, uint8_t aMaxIpAddresses)
این عملکرد حداکثر تعداد آدرس‌های IP را که هر فرزند MTD ممکن است در این دستگاه به‌عنوان والدین ثبت کند، تنظیم/بازیابی می‌کند.
otThreadSetNetworkIdTimeout ( otInstance *aInstance, uint8_t aTimeout)
void
پارامتر NETWORK_ID_TIMEOUT مورد استفاده در نقش رهبر را تنظیم کنید.
otThreadSetParentPriority ( otInstance *aInstance, int8_t aParentPriority)
اولویت والد را تنظیم کنید.
otThreadSetPreferredLeaderPartitionId ( otInstance *aInstance, uint32_t aPartitionId)
void
شناسه پارتیشن Thread Leader ترجیحی را که هنگام کار در نقش رهبر استفاده می شود، تنظیم کنید.
otThreadSetPreferredRouterId ( otInstance *aInstance, uint8_t aRouterId)
شناسه روتر ترجیحی را تنظیم کنید.
otThreadSetPskc ( otInstance *aInstance, const otPskc *aPskc)
Thread PSKc را تنظیم کنید.
otThreadSetPskcRef ( otInstance *aInstance, otPskcRef aKeyRef)
Thread PSKc را تنظیم کنید.
otThreadSetRouterDowngradeThreshold ( otInstance *aInstance, uint8_t aThreshold)
void
پارامتر ROUTER_DOWNGRADE_THRESHOLD مورد استفاده در نقش رهبر را تنظیم کنید.
otThreadSetRouterEligible ( otInstance *aInstance, bool aEligible)
این تابع تعیین می کند که آیا دستگاه واجد شرایط روتر است یا خیر.
otThreadSetRouterIdRange ( otInstance *aInstance, uint8_t aMinRouterId, uint8_t aMaxRouterId)
این تابع محدوده شناسه های روتر را که مجاز به تخصیص به گره های درون شبکه رشته هستند، تنظیم می کند.
otThreadSetRouterSelectionJitter ( otInstance *aInstance, uint8_t aRouterJitter)
void
پارامتر ROUTER_SELECTION_JITTER مورد استفاده در نقش REED/Router را تنظیم کنید.
otThreadSetRouterUpgradeThreshold ( otInstance *aInstance, uint8_t aThreshold)
void
پارامتر ROUTER_UPGRADE_THRESHOLD مورد استفاده در نقش رهبر را تنظیم کنید.
otThreadSetSteeringData ( otInstance *aInstance, const otExtAddress *aExtAddress)
void
داده های فرمان را خارج از باند تنظیم کنید.
otThreadSetThreadVersionCheckEnabled ( otInstance *aInstance, bool aEnabled)
void
این تابع تعیین می‌کند که آیا خط‌مشی امنیتی نسخه آستانه TLV برای مسیریابی (فیلد VR) فعال باشد یا خیر.

سازه ها

otCacheEntryInfo

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

otCacheEntryIterator

این نوع یک تکرار کننده را نشان می دهد که برای تکرار از طریق ورودی های جدول کش EID استفاده می شود.

otChildInfo

این ساختار اطلاعات تشخیصی را برای Thread Child نگه می دارد.

otNeighborTableEntryInfo

این نوع اطلاعات ورودی جدول همسایه (فرزند یا روتر) را نشان می‌دهد و به عنوان پارامتر در جدول همسایه برگشت به تماس otNeighborTableCallback استفاده می‌شود.

شمارش ها

otCacheEntryState

 otCacheEntryState

این شمارش وضعیت ورودی کش EID را مشخص می کند.

otNeighborTableEvent

 otNeighborTableEvent

این شمارش ثابت های مورد استفاده در otNeighborTableCallback را برای نشان دادن تغییرات در جدول همسایه تعریف می کند.

خواص
OT_NEIGHBOR_TABLE_EVENT_CHILD_ADDED

یک کودک اضافه می شود.

OT_NEIGHBOR_TABLE_EVENT_CHILD_MODE_CHANGED

حالت کودک موجود تغییر کرده است.

OT_NEIGHBOR_TABLE_EVENT_CHILD_REMOVED

یک کودک در حال حذف شدن است.

OT_NEIGHBOR_TABLE_EVENT_ROUTER_ADDED

یک روتر در حال اضافه شدن است.

OT_NEIGHBOR_TABLE_EVENT_ROUTER_REMOVED

یک روتر در حال حذف شدن است.

Typedefs

otCacheEntryInfo

struct otCacheEntryInfo otCacheEntryInfo

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

otCacheEntryIterator

struct otCacheEntryIterator otCacheEntryIterator

این نوع یک تکرار کننده را نشان می دهد که برای تکرار از طریق ورودی های جدول کش EID استفاده می شود.

برای مقداردهی اولیه تکرارکننده و شروع از اولین ورودی در جدول کش، تمام فیلدهای آن در ساختار را صفر کنید (مثلاً memset را صفر کنید).

otCacheEntryState

enum otCacheEntryState otCacheEntryState

این شمارش وضعیت ورودی کش EID را مشخص می کند.

otChildIp6AddressIterator

uint16_t otChildIp6AddressIterator

برای تکرار از طریق آدرس های IPv6 ورودی Thread Child استفاده می شود.

otNeighborTableCallback

void(* otNeighborTableCallback)(otNeighborTableEvent aEvent, const otNeighborTableEntryInfo *aEntryInfo)

این نشانگر تابع برای اطلاع از تغییر در جدول همسایه فراخوانی می شود.

جزئیات
مولفه های
[in] aEvent
یک پرچم رویداد
[in] aEntryInfo
اشاره گر به اطلاعات ورودی جدول.

کارکرد

otThreadBecomeLeader

otError otThreadBecomeLeader(
  otInstance *aInstance
)

رهبر شوید و یک پارتیشن جدید راه اندازی کنید.

جزئیات
مولفه های
[in] aInstance
اشاره گر به یک نمونه OpenThread.
ارزش های بازگشتی
OT_ERROR_NONE
با موفقیت به یک رهبر تبدیل شد و یک پارتیشن جدید را راه اندازی کرد.
OT_ERROR_INVALID_STATE
تاپیک غیرفعال است

otThreadBecomeRouter

otError otThreadBecomeRouter(
  otInstance *aInstance
)

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

جزئیات
مولفه های
[in] aInstance
اشاره گر به یک نمونه OpenThread.
ارزش های بازگشتی
OT_ERROR_NONE
تلاش برای تبدیل شدن به یک روتر با موفقیت آغاز شد.
OT_ERROR_INVALID_STATE
تاپیک غیرفعال است

otThreadGetChildInfoById

otError otThreadGetChildInfoById(
  otInstance *aInstance,
  uint16_t aChildId,
  otChildInfo *aChildInfo
)

این عملکرد اطلاعات تشخیصی را برای یک Child پیوست شده توسط Child ID یا RLOC16 حفظ می کند.

جزئیات
مولفه های
[in] aInstance
اشاره گر به یک نمونه OpenThread.
[in] aChildId
شناسه کودک یا RLOC16 برای کودک پیوست.
[out] aChildInfo
یک اشاره گر به جایی که اطلاعات فرزند در آن قرار می گیرد.
ارزش های بازگشتی
OT_ERROR_NONE
aChildInfo با موفقیت با اطلاعات شناسه داده شده به روز شد.
OT_ERROR_NOT_FOUND
هیچ فرزند معتبری با این شناسه کودک وجود ندارد.
OT_ERROR_INVALID_ARGS
اگر aChildInfo NULL باشد.

otThreadGetChildInfoByIndex

otError otThreadGetChildInfoByIndex(
  otInstance *aInstance,
  uint16_t aChildIndex,
  otChildInfo *aChildInfo
)

این تابع اطلاعات تشخیصی را برای یک Child پیوست شده توسط نمایه جدول داخلی حفظ می کند.

جزئیات
مولفه های
[in] aInstance
اشاره گر به یک نمونه OpenThread.
[in] aChildIndex
شاخص جدول.
[out] aChildInfo
یک اشاره گر به جایی که اطلاعات فرزند در آن قرار می گیرد.
ارزش های بازگشتی
OT_ERROR_NONE
aChildInfo با موفقیت با اطلاعات مربوط به فهرست داده شده به روز شد.
OT_ERROR_NOT_FOUND
هیچ فرزند معتبری در این شاخص وجود ندارد.
OT_ERROR_INVALID_ARGS
یا aChildInfo NULL است یا aChildIndex خارج از محدوده است (بالاتر از حداکثر شاخص جدول).
همچنین ببینید:
otGetMaxAllowedChildren

otThreadGetChildNextIp6Address

otError otThreadGetChildNextIp6Address(
  otInstance *aInstance,
  uint16_t aChildIndex,
  otChildIp6AddressIterator *aIterator,
  otIp6Address *aAddress
)

این تابع آدرس IPv6 بعدی (با استفاده از تکرارکننده) را برای یک فرزند معین دریافت می کند.

جزئیات
مولفه های
[in] aInstance
اشاره گر به یک نمونه OpenThread.
[in] aChildIndex
شاخص کودک
[in,out] aIterator
اشاره گر به تکرار کننده. در صورت موفقیت، تکرار کننده به روز می شود تا به ورودی بعدی در لیست اشاره کند. برای دریافت اولین آدرس IPv6، تکرارکننده باید روی OT_CHILD_IP6_ADDRESS_ITERATOR_INIT تنظیم شود.
[out] aAddress
اشاره گر به آدرس IPv6 که آدرس بعدی کودک در آن قرار می گیرد (در صورت موفقیت).
ارزش های بازگشتی
OT_ERROR_NONE
آدرس aAddress بعدی با موفقیت یافت شد (آدرس با موفقیت به روز شد).
OT_ERROR_NOT_FOUND
کودک هیچ آدرس IPv6 بعدی ندارد.
OT_ERROR_INVALID_ARGS
aIterator یا aAddress NULL هستند، یا فرزند در aChildIndex معتبر نیست.
همچنین ببینید:
otThreadGetChildInfoByIndex

otThreadGetContextIdReuseDelay

uint32_t otThreadGetContextIdReuseDelay(
  otInstance *aInstance
)

پارامتر CONTEXT_ID_REUSE_DELAY مورد استفاده در نقش رهبر را دریافت کنید.

جزئیات
مولفه های
[in] aInstance
اشاره گر به یک نمونه OpenThread.
برمی گرداند
مقدار CONTEXT_ID_REUSE_DELAY.
همچنین ببینید:
otThreadSetContextIdReuseDelay

otThreadGetJoinerUdpPort

uint16_t otThreadGetJoinerUdpPort(
  otInstance *aInstance
)

پورت Joiner UDP را دریافت کنید.

جزئیات
مولفه های
[in] aInstance
اشاره گر به یک نمونه OpenThread.
برمی گرداند
شماره پورت Joiner UDP.
همچنین ببینید:
otThreadSetJoinerUdpPort

otThreadGetLocalLeaderWeight

uint8_t otThreadGetLocalLeaderWeight(
  otInstance *aInstance
)

هنگامی که در نقش رهبر کار می کنید، از وزن رهبر موضوع استفاده کنید.

جزئیات
مولفه های
[in] aInstance
اشاره گر به یک نمونه OpenThread.
برمی گرداند
مقدار وزن رهبر نخ.
همچنین ببینید:
otThreadSetLeaderWeight

otThreadGetMaxAllowedChildren

uint16_t otThreadGetMaxAllowedChildren(
  otInstance *aInstance
)

حداکثر تعداد فرزندان مجاز در حال حاضر را دریافت کنید.

جزئیات
مولفه های
[in] aInstance
اشاره گر به یک نمونه OpenThread.
برمی گرداند
حداکثر تعداد کودکان مجاز در حال حاضر.
همچنین ببینید:
otThreadSetMaxAllowedChildren

otThreadGetMaxChildIpAddresses

uint8_t otThreadGetMaxChildIpAddresses(
  otInstance *aInstance
)

این تابع حداکثر تعداد آدرس‌های IP را که هر فرزند MTD ممکن است در این دستگاه به‌عنوان والدین ثبت کند، دریافت می‌کند.

جزئیات
مولفه های
[in] aInstance
اشاره گر به یک نمونه OpenThread.
برمی گرداند
حداکثر تعداد آدرس‌های IP که هر فرزند MTD ممکن است با این دستگاه به‌عنوان والدین ثبت کند.
همچنین ببینید:
otThreadSetMaxChildIpAddresses

otThreadGetMaxRouterId

uint8_t otThreadGetMaxRouterId(
  otInstance *aInstance
)

این تابع حداکثر شناسه مجاز روتر را برمی گرداند.

جزئیات
مولفه های
[in] aInstance
اشاره گر به یک نمونه OpenThread.
برمی گرداند
حداکثر شناسه مجاز روتر.

otThreadGetNetworkIdTimeout

uint8_t otThreadGetNetworkIdTimeout(
  otInstance *aInstance
)

پارامتر NETWORK_ID_TIMEOUT مورد استفاده در نقش روتر را دریافت کنید.

جزئیات
مولفه های
[in] aInstance
اشاره گر به یک نمونه OpenThread.
برمی گرداند
مقدار NETWORK_ID_TIMEOUT.
همچنین ببینید:
otThreadSetNetworkIdTimeout

otThreadGetNextCacheEntry

otError otThreadGetNextCacheEntry(
  otInstance *aInstance,
  otCacheEntryInfo *aEntryInfo,
  otCacheEntryIterator *aIterator
)

این تابع ورودی کش EID بعدی را دریافت می کند (با استفاده از یک تکرار کننده).

جزئیات
مولفه های
[in] aInstance
اشاره گر به یک نمونه OpenThread.
[out] aEntryInfo
یک اشاره گر به جایی که اطلاعات ورودی کش EID در آن قرار می گیرد.
[in,out] aIterator
اشاره گر به تکرار کننده. به روز می شود تا به ورودی بعدی در مورد موفقیت اشاره کند. برای دریافت اولین ورودی، تکرار کننده را با صفر کردن تمام فیلدهای آن مقداردهی کنید (مثلاً ساختار memset را صفر کنید).
ارزش های بازگشتی
OT_ERROR_NONE
aEntryInfo برای ورودی حافظه پنهان EID بعدی با موفقیت پر شد.
OT_ERROR_NOT_FOUND
هیچ ورودی دیگری در جدول کش آدرس وجود ندارد.

otThreadGetParentPriority

int8_t otThreadGetParentPriority(
  otInstance *aInstance
)

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

جزئیات
مولفه های
[in] aInstance
اشاره گر به یک نمونه OpenThread.
برمی گرداند
مقدار اولویت والد اختصاص داده شده، -2 به معنای اختصاص داده نشده است.
همچنین ببینید:
otThreadSetParentPriority

otThreadGetPreferredLeaderPartitionId

uint32_t otThreadGetPreferredLeaderPartitionId(
  otInstance *aInstance
)

شناسه پارتیشن Thread Leader ترجیحی را که هنگام کار در نقش رهبر استفاده می شود، دریافت کنید.

جزئیات
مولفه های
[in] aInstance
اشاره گر به یک نمونه OpenThread.
برمی گرداند
مقدار شناسه پارتیشن Thread Leader.

otThreadGetPskc

void otThreadGetPskc(
  otInstance *aInstance,
  otPskc *aPskc
)

موضوع PSKc را دریافت کنید.

جزئیات
مولفه های
[in] aInstance
اشاره گر به یک نمونه OpenThread.
[out] aPskc
یک اشاره گر به یک otPskc برای برگرداندن Thread PSKc بازیابی شده.
همچنین ببینید:
otThreadSetPskc

otThreadGetPskcRef

otPskcRef otThreadGetPskcRef(
  otInstance *aInstance
)

دریافت مرجع کلید به موضوع PSKc ذخیره شده.

این تابع نیاز به فعال کردن ویژگی زمان ساخت OPENTHREAD_CONFIG_PLATFORM_KEY_REFERENCES_ENABLE دارد.

جزئیات
مولفه های
[in] aInstance
اشاره گر به یک نمونه OpenThread.
برمی گرداند
ارجاع کلیدی به PSKc
همچنین ببینید:
otThreadSetPskcRef

otThreadGetRouterDowngradeThreshold

uint8_t otThreadGetRouterDowngradeThreshold(
  otInstance *aInstance
)

پارامتر ROUTER_DOWNGRADE_THRESHOLD مورد استفاده در نقش روتر را دریافت کنید.

جزئیات
مولفه های
[in] aInstance
اشاره گر به یک نمونه OpenThread.
برمی گرداند
مقدار ROUTER_DOWNGRADE_THRESHOLD.
همچنین ببینید:
otThreadSetRouterDowngradeThreshold

otThreadGetRouterIdRange

void otThreadGetRouterIdRange(
  otInstance *aInstance,
  uint8_t *aMinRouterId,
  uint8_t *aMaxRouterId
)

این تابع محدوده شناسه های روتر را دریافت می کند که مجاز به تخصیص به گره های داخل شبکه رشته هستند.

جزئیات
مولفه های
[in] aInstance
اشاره گر به یک نمونه OpenThread.
[out] aMinRouterId
حداقل شناسه روتر
[out] aMaxRouterId
حداکثر شناسه روتر
همچنین ببینید:
otThreadSetRouterIdRange

otThreadGetRouterIdSequence

uint8_t otThreadGetRouterIdSequence(
  otInstance *aInstance
)

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

جزئیات
مولفه های
[in] aInstance
اشاره گر به یک نمونه OpenThread.
برمی گرداند
دنباله شناسه روتر

otThreadGetRouterInfo

otError otThreadGetRouterInfo(
  otInstance *aInstance,
  uint16_t aRouterId,
  otRouterInfo *aRouterInfo
)

این تابع اطلاعات تشخیصی را برای یک روتر Thread معین حفظ می کند.

جزئیات
مولفه های
[in] aInstance
اشاره گر به یک نمونه OpenThread.
[in] aRouterId
شناسه روتر یا RLOC16 برای یک روتر معین.
[out] aRouterInfo
اشاره گر به جایی که اطلاعات روتر در آن قرار می گیرد.
ارزش های بازگشتی
OT_ERROR_NONE
اطلاعات روتر برای شناسه داده شده با موفقیت بازیابی شد.
OT_ERROR_NOT_FOUND
هیچ ورودی روتر با شناسه داده شده وجود ندارد.
OT_ERROR_INVALID_ARGS
aRouterInfo NULL است.

otThreadGetRouterSelectionJitter

uint8_t otThreadGetRouterSelectionJitter(
  otInstance *aInstance
)

پارامتر ROUTER_SELECTION_JITTER مورد استفاده در نقش REED/Router را دریافت کنید.

جزئیات
مولفه های
[in] aInstance
اشاره گر به یک نمونه OpenThread.
برمی گرداند
مقدار ROUTER_SELECTION_JITTER.
همچنین ببینید:
otThreadSetRouterSelectionJitter

otThreadGetRouterUpgradeThreshold

uint8_t otThreadGetRouterUpgradeThreshold(
  otInstance *aInstance
)

پارامتر ROUTER_UPGRADE_THRESHOLD مورد استفاده در نقش REED را دریافت کنید.

جزئیات
مولفه های
[in] aInstance
اشاره گر به یک نمونه OpenThread.
برمی گرداند
مقدار ROUTER_UPGRADE_THRESHOLD.
همچنین ببینید:
otThreadSetRouterUpgradeThreshold

otThreadIsRouterEligible

bool otThreadIsRouterEligible(
  otInstance *aInstance
)

این روش نشان می دهد که آیا دستگاه واجد شرایط روتر است یا خیر.

جزئیات
مولفه های
[in] aInstance
اشاره گر به یک نمونه OpenThread.
ارزش های بازگشتی
TRUE
اگر دستگاه واجد شرایط روتر است.
FALSE
اگر دستگاه واجد شرایط روتر نیست.

otThreadRegisterNeighborTableCallback

void otThreadRegisterNeighborTableCallback(
  otInstance *aInstance,
  otNeighborTableCallback aCallback
)

این تابع یک تابع فراخوانی جدول همسایه را ثبت می کند.

زمانی که تغییری در جدول همسایه ایجاد شود (به عنوان مثال، یک ورودی همسایه فرزند یا مسیریاب در حال افزودن/حذف شدن یا تغییر حالت فرزند موجود) است، فراخوان ارائه شده (اگر غیر NULL باشد) فراخوانی می شود.

تماس های بعدی به این روش، تماس قبلی را بازنویسی می کند. توجه داشته باشید که این تماس زمانی که جدول همسایه/فرزند در حال به‌روزرسانی است و همیشه قبل از otStateChangedCallback .

جزئیات
مولفه های
[in] aInstance
اشاره گر به یک نمونه OpenThread.
[in] aCallback
یک اشاره گر به عملکرد کنترل کننده پاسخ تماس.

otThreadReleaseRouterId

otError otThreadReleaseRouterId(
  otInstance *aInstance,
  uint8_t aRouterId
)

شناسه روتر را که توسط دستگاه در نقش رهبر تخصیص داده شده است، آزاد کنید.

جزئیات
مولفه های
[in] aInstance
اشاره گر به یک نمونه OpenThread.
[in] aRouterId
شناسه روتر برای انتشار. محدوده معتبر [0، 62] است.
ارزش های بازگشتی
OT_ERROR_NONE
شناسه روتر با موفقیت منتشر شد.
OT_ERROR_INVALID_ARGS
aRouterId در محدوده [0، 62] نیست.
OT_ERROR_INVALID_STATE
دستگاه در حال حاضر به عنوان پیشرو عمل نمی کند.
OT_ERROR_NOT_FOUND
شناسه روتر در حال حاضر اختصاص داده نشده است.

otThreadSetCcmEnabled

void otThreadSetCcmEnabled(
  otInstance *aInstance,
  bool aEnabled
)

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

جزئیات
مولفه های
[in] aInstance
اشاره گر به یک نمونه OpenThread.
[in] aEnabled
اگر دستگاه با استفاده از CCM راه اندازی شده باشد، درست است، در غیر این صورت نادرست است.

otThreadSetContextIdReuseDelay

void otThreadSetContextIdReuseDelay(
  otInstance *aInstance,
  uint32_t aDelay
)

پارامتر CONTEXT_ID_REUSE_DELAY مورد استفاده در نقش رهبر را تنظیم کنید.

جزئیات
مولفه های
[in] aInstance
اشاره گر به یک نمونه OpenThread.
[in] aDelay
مقدار CONTEXT_ID_REUSE_DELAY.
همچنین ببینید:
otThreadGetContextIdReuseDelay

otThreadSetJoinerUdpPort

otError otThreadSetJoinerUdpPort(
  otInstance *aInstance,
  uint16_t aJoinerUdpPort
)

پورت Joiner UDP را تنظیم کنید.

جزئیات
مولفه های
[in] aInstance
اشاره گر به یک نمونه OpenThread.
[in] aJoinerUdpPort
شماره پورت Joiner UDP.
ارزش های بازگشتی
OT_ERROR_NONE
پورت Joiner UDP با موفقیت تنظیم شد.
همچنین ببینید:
otThreadGetJoinerUdpPort

otThreadSetLocalLeaderWeight

void otThreadSetLocalLeaderWeight(
  otInstance *aInstance,
  uint8_t aWeight
)

وزن رهبر نخ مورد استفاده در نقش رهبر را تنظیم کنید.

جزئیات
مولفه های
[in] aInstance
اشاره گر به یک نمونه OpenThread.
[in] aWeight
مقدار وزن رهبر نخ.
همچنین ببینید:
otThreadGetLeaderWeight

otThreadSetMaxAllowedChildren

otError otThreadSetMaxAllowedChildren(
  otInstance *aInstance,
  uint16_t aMaxChildren
)

حداکثر تعداد فرزندان مجاز در حال حاضر را تنظیم کنید.

این پارامتر فقط زمانی قابل تنظیم است که عملیات پروتکل Thread متوقف شده باشد.

جزئیات
مولفه های
[in] aInstance
اشاره گر به یک نمونه OpenThread.
[in] aMaxChildren
حداکثر مجاز کودکان
ارزش های بازگشتی
OT_ERROR_NONE
حداکثر را با موفقیت تنظیم کرد.
OT_ERROR_INVALID_ARGS
اگر aMaxChildren در محدوده [1، OPENTHREAD_CONFIG_MLE_MAX_CHILDREN] نباشد.
OT_ERROR_INVALID_STATE
اگر Thread متوقف نشود.
همچنین ببینید:
otThreadGetMaxAllowedChildren

otThreadSetMaxChildIpAddresses

otError otThreadSetMaxChildIpAddresses(
  otInstance *aInstance,
  uint8_t aMaxIpAddresses
)

این عملکرد حداکثر تعداد آدرس‌های IP را که هر فرزند MTD ممکن است در این دستگاه به‌عنوان والدین ثبت کند، تنظیم/بازیابی می‌کند.

جزئیات
مولفه های
[in] aInstance
اشاره گر به یک نمونه OpenThread.
[in] aMaxIpAddresses
حداکثر تعداد آدرس‌های IP که هر فرزند MTD ممکن است با این دستگاه به‌عنوان والدین ثبت کند. 0 برای پاک کردن تنظیمات و بازیابی تنظیمات پیش فرض.
ارزش های بازگشتی
OT_ERROR_NONE
شماره با موفقیت تنظیم/پاک شد.
OT_ERROR_INVALID_ARGS
اگر از حداکثر تعداد مجاز بیشتر شود.
همچنین ببینید:
otThreadGetMaxChildIpAddresses

otThreadSetNetworkIdTimeout

void otThreadSetNetworkIdTimeout(
  otInstance *aInstance,
  uint8_t aTimeout
)

پارامتر NETWORK_ID_TIMEOUT مورد استفاده در نقش رهبر را تنظیم کنید.

جزئیات
مولفه های
[in] aInstance
اشاره گر به یک نمونه OpenThread.
[in] aTimeout
مقدار NETWORK_ID_TIMEOUT.
همچنین ببینید:
otThreadGetNetworkIdTimeout

otThreadSetParentPriority

otError otThreadSetParentPriority(
  otInstance *aInstance,
  int8_t aParentPriority
)

اولویت والد را تنظیم کنید.

جزئیات
مولفه های
[in] aInstance
اشاره گر به یک نمونه OpenThread.
[in] aParentPriority
مقدار اولویت والد.
ارزش های بازگشتی
OT_ERROR_NONE
اولویت والدین با موفقیت تنظیم شد.
OT_ERROR_INVALID_ARGS
اگر مقدار اولویت والد بین 1، 0، -1 و -2 نباشد.
همچنین ببینید:
otThreadGetParentPriority

otThreadSetPreferredLeaderPartitionId

void otThreadSetPreferredLeaderPartitionId(
  otInstance *aInstance,
  uint32_t aPartitionId
)

شناسه پارتیشن Thread Leader ترجیحی را که هنگام کار در نقش رهبر استفاده می شود، تنظیم کنید.

جزئیات
مولفه های
[in] aInstance
اشاره گر به یک نمونه OpenThread.
[in] aPartitionId
مقدار شناسه پارتیشن Thread Leader.

otThreadSetPreferredRouterId

otError otThreadSetPreferredRouterId(
  otInstance *aInstance,
  uint8_t aRouterId
)

شناسه روتر ترجیحی را تنظیم کنید.

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

جزئیات
مولفه های
[in] aInstance
اشاره گر به یک نمونه OpenThread.
[in] aRouterId
شناسه روتر ترجیحی
ارزش های بازگشتی
OT_ERROR_NONE
شناسه روتر ترجیحی با موفقیت تنظیم شد.
OT_ERROR_INVALID_STATE
تنظیم نشد (نقش جدا یا غیرفعال نیست)

otThreadSetPskc

otError otThreadSetPskc(
  otInstance *aInstance,
  const otPskc *aPskc
)

Thread PSKc را تنظیم کنید.

این تابع فقط زمانی موفق می شود که پروتکل های Thread غیرفعال شوند. فراخوانی موفقیت آمیز این تابع مجموعه داده های عملیاتی فعال و معلق را در حافظه غیر فرار نیز بی اعتبار می کند.

جزئیات
مولفه های
[in] aInstance
اشاره گر به یک نمونه OpenThread.
[in] aPskc
اشاره گر به موضوع جدید PSKc.
ارزش های بازگشتی
OT_ERROR_NONE
Thread PSKc با موفقیت تنظیم شد.
OT_ERROR_INVALID_STATE
پروتکل های رشته فعال هستند.
همچنین ببینید:
otThreadGetPskc

otThreadSetPskcRef

otError otThreadSetPskcRef(
  otInstance *aInstance,
  otPskcRef aKeyRef
)

Thread PSKc را تنظیم کنید.

این تابع نیاز به فعال کردن ویژگی زمان ساخت OPENTHREAD_CONFIG_PLATFORM_KEY_REFERENCES_ENABLE دارد.

این تابع فقط زمانی موفق می شود که پروتکل های Thread غیرفعال شوند. فراخوانی موفقیت آمیز این تابع مجموعه داده های عملیاتی فعال و معلق را در حافظه غیر فرار نیز بی اعتبار می کند.

جزئیات
مولفه های
[in] aInstance
اشاره گر به یک نمونه OpenThread.
[in] aKeyRef
ارجاع کلیدی به موضوع جدید PSKc.
ارزش های بازگشتی
OT_ERROR_NONE
Thread PSKc با موفقیت تنظیم شد.
OT_ERROR_INVALID_STATE
پروتکل های رشته فعال هستند.
همچنین ببینید:
otThreadGetPskcRef

otThreadSetRouterDowngradeThreshold

void otThreadSetRouterDowngradeThreshold(
  otInstance *aInstance,
  uint8_t aThreshold
)

پارامتر ROUTER_DOWNGRADE_THRESHOLD مورد استفاده در نقش رهبر را تنظیم کنید.

جزئیات
مولفه های
[in] aInstance
اشاره گر به یک نمونه OpenThread.
[in] aThreshold
مقدار ROUTER_DOWNGRADE_THRESHOLD.
همچنین ببینید:
otThreadGetRouterDowngradeThreshold

otThreadSetRouterEligible

otError otThreadSetRouterEligible(
  otInstance *aInstance,
  bool aEligible
)

این تابع تعیین می کند که آیا دستگاه واجد شرایط روتر است یا خیر.

اگر aEligible نادرست باشد و دستگاه در حال حاضر به‌عنوان روتر کار می‌کند، این تماس باعث می‌شود دستگاه جدا شود و در کودکی تلاش کند دوباره وصل شود.

جزئیات
مولفه های
[in] aInstance
اشاره گر به یک نمونه OpenThread.
[in] aEligible
برای پیکربندی دستگاه به عنوان واجد شرایط روتر، درست است، در غیر این صورت نادرست است.
ارزش های بازگشتی
OT_ERROR_NONE
پیکربندی واجد شرایط روتر با موفقیت تنظیم شد.
OT_ERROR_NOT_CAPABLE
دستگاه قادر به تبدیل شدن به روتر نیست.

otThreadSetRouterIdRange

otError otThreadSetRouterIdRange(
  otInstance *aInstance,
  uint8_t aMinRouterId,
  uint8_t aMaxRouterId
)

این تابع محدوده شناسه های روتر را که مجاز به تخصیص به گره های درون شبکه رشته هستند، تنظیم می کند.

جزئیات
مولفه های
[in] aInstance
اشاره گر به یک نمونه OpenThread.
[in] aMinRouterId
حداقل شناسه روتر
[in] aMaxRouterId
حداکثر شناسه روتر
ارزش های بازگشتی
OT_ERROR_NONE
محدوده را با موفقیت تنظیم کرد.
OT_ERROR_INVALID_ARGS
aMinRouterId > aMaxRouterId، یا محدوده تحت پوشش [0، 62] نیست.
همچنین ببینید:
otThreadGetRouterIdRange

otThreadSetRouterSelectionJitter

void otThreadSetRouterSelectionJitter(
  otInstance *aInstance,
  uint8_t aRouterJitter
)

پارامتر ROUTER_SELECTION_JITTER مورد استفاده در نقش REED/Router را تنظیم کنید.

جزئیات
مولفه های
[in] aInstance
اشاره گر به یک نمونه OpenThread.
[in] aRouterJitter
مقدار ROUTER_SELECTION_JITTER.
همچنین ببینید:
otThreadGetRouterSelectionJitter

otThreadSetRouterUpgradeThreshold

void otThreadSetRouterUpgradeThreshold(
  otInstance *aInstance,
  uint8_t aThreshold
)

پارامتر ROUTER_UPGRADE_THRESHOLD مورد استفاده در نقش رهبر را تنظیم کنید.

جزئیات
مولفه های
[in] aInstance
اشاره گر به یک نمونه OpenThread.
[in] aThreshold
مقدار ROUTER_UPGRADE_THRESHOLD.
همچنین ببینید:
otThreadGetRouterUpgradeThreshold

otThreadSetSteeringData

void otThreadSetSteeringData(
  otInstance *aInstance,
  const otExtAddress *aExtAddress
)

داده های فرمان را خارج از باند تنظیم کنید.

گزینه پیکربندی OPENTHREAD_CONFIG_MLE_STEERING_DATA_SET_OOB_ENABLE باید طوری تنظیم شود که تنظیم داده های فرمان خارج از باند را فعال کند.

جزئیات
مولفه های
[in] aInstance
اشاره گر به یک نمونه OpenThread.
[in] aExtAddress
آدرسی که برای به روز رسانی اطلاعات فرمان استفاده می شود. همه صفرها برای پاک کردن اطلاعات فرمان (بدون اطلاعات فرمان). همه 0xFF ها برای تنظیم داده های فرمان/فیلتر بلوم برای پذیرش/مجاز کردن همه. یک EUI64 خاص که سپس به فیلتر داده/شکوفه فرمان فعلی اضافه می شود.

otThreadSetThreadVersionCheckEnabled

void otThreadSetThreadVersionCheckEnabled(
  otInstance *aInstance,
  bool aEnabled
)

این تابع تعیین می‌کند که آیا خط‌مشی امنیتی نسخه آستانه TLV برای مسیریابی (فیلد VR) فعال باشد یا خیر.

جزئیات
مولفه های
[in] aInstance
اشاره گر به یک نمونه OpenThread.
[in] aEnabled
برای فعال کردن خط‌مشی امنیتی نسخه آستانه TLV برای مسیریابی درست است، در غیر این صورت FALSE.

ماکروها

OT_CHILD_IP6_ADDRESS_ITERATOR_INIT

 OT_CHILD_IP6_ADDRESS_ITERATOR_INIT 0

Initializer برای otChildIP6AddressIterator.

منابع

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