مامور مرزی

این ماژول شامل توابعی برای نقش Thread Border Agent است.

خلاصه

شمارش ها

otBorderAgentState {
OT_BORDER_AGENT_STATE_STOPPED = 0,
OT_BORDER_AGENT_STATE_STARTED = 1,
OT_BORDER_AGENT_STATE_ACTIVE = 2
}		 enum
وضعیت عامل مرزی را تعریف می کند.

Typedefs

otBorderAgentId typedef
نشان دهنده شناسه عامل مرزی است.
otBorderAgentState typedef
وضعیت عامل مرزی را تعریف می کند.

متغیرها

OT_TOOL_PACKED_END

کارکرد

otBorderAgentGetId ( otInstance *aInstance, otBorderAgentId *aId)
شناسه عامل مرزی به‌طور تصادفی تولید شده را دریافت می‌کند.
otBorderAgentGetState ( otInstance *aInstance)
نقش otBorderAgentState از Thread Border Agent را دریافت می کند.
otBorderAgentGetUdpPort ( otInstance *aInstance)
uint16_t
پورت UDP سرویس Thread Border Agent را دریافت می کند.
otBorderAgentSetId ( otInstance *aInstance, const otBorderAgentId *aId)
شناسه عامل مرزی را تنظیم می کند.

سازه ها

otBorderAgentId

نشان دهنده شناسه عامل مرزی است.

شمارش ها

otBorderAgentState

 otBorderAgentState

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

خواص
OT_BORDER_AGENT_STATE_ACTIVE

عامل مرزی با کمیسر خارجی در ارتباط است.

OT_BORDER_AGENT_STATE_STARTED

مامور مرزی شروع شده است.

OT_BORDER_AGENT_STATE_STOPPED

نقش عامل مرزی غیرفعال است.

Typedefs

otBorderAgentId

struct otBorderAgentId otBorderAgentId

نشان دهنده شناسه عامل مرزی است.

otBorderAgentState

enum otBorderAgentState otBorderAgentState

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

متغیرها

OT_TOOL_PACKED_END

OT_TOOL_PACKED_BEGIN struct otBorderAgentId OT_TOOL_PACKED_END

کارکرد

otBorderAgentGetId

otError otBorderAgentGetId(
  otInstance *aInstance,
  otBorderAgentId *aId
)

شناسه عامل مرزی به‌طور تصادفی تولید شده را دریافت می‌کند.

شناسه در فضای ذخیره‌سازی دائمی ذخیره می‌شود و پس از راه‌اندازی مجدد زنده می‌ماند. مورد استفاده معمولی شناسه باید در سرویس MeshCoP mDNS به عنوان مقدار id TXT برای مشتری منتشر شود تا این دستگاه Border Router/Agent را شناسایی کند.

جزئیات
مولفه های
[in] aInstance
اشاره گر به یک نمونه OpenThread.
[out] aId
یک اشاره گر به بافر برای دریافت شناسه.
ارزش های بازگشتی
OT_ERROR_NONE
اگر شناسه عامل مرزی با موفقیت بازیابی شد.
...
اگر شناسه عامل مرزی بازیابی نشد.
همچنین ببینید:
otBorderAgentSetId

otBorderAgentGetState

otBorderAgentState otBorderAgentGetState(
  otInstance *aInstance
)

نقش otBorderAgentState از Thread Border Agent را دریافت می کند.

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

otBorderAgentGetUdpPort

uint16_t otBorderAgentGetUdpPort(
  otInstance *aInstance
)

پورت UDP سرویس Thread Border Agent را دریافت می کند.

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

otBorderAgentSetId

otError otBorderAgentSetId(
  otInstance *aInstance,
  const otBorderAgentId *aId
)

شناسه عامل مرزی را تنظیم می کند.

شناسه عامل مرزی در فضای ذخیره‌سازی دائمی ذخیره می‌شود و از راه‌اندازی مجدد زنده می‌ماند. پس از تنظیم مجدد کارخانه، فقط یک بار باید شناسه را تنظیم کنید. اگر شناسه هرگز با فراخوانی این تابع تنظیم نشده باشد، یک شناسه تصادفی تولید می شود و با فراخوانی otBorderAgentGetId برگردانده می شود.

جزئیات
مولفه های
[in] aInstance
اشاره گر به یک نمونه OpenThread.
[out] aId
یک اشاره گر به شناسه عامل مرزی.
ارزش های بازگشتی
OT_ERROR_NONE
اگر با موفقیت شناسه عامل مرزی را تنظیم کنید.
...
اگر نتوانستید شناسه عامل مرزی را تنظیم کنید.
همچنین ببینید:
otBorderAgentGetId

ماکروها

OT_BORDER_AGENT_ID_LENGTH

 OT_BORDER_AGENT_ID_LENGTH (16)

طول شناسه عامل مرزی/روتر بر حسب بایت.

منابع

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