ตัวแทนชายแดน

โมดูลนี้ประกอบด้วยฟังก์ชันสําหรับ Agent ของ Thread Border Agent

สรุป

แจกแจง
otBorderAgentState{
  OT_BORDER_AGENT_STATE_STOPPED = 0,
  OT_BORDER_AGENT_STATE_STARTED = 1,
  OT_BORDER_AGENT_STATE_ACTIVE = 2
} 		enum
ระบุสถานะ Border Agent

ประเภทคําสั่ง
otBorderAgentId Typedef
แสดงรหัสตัวแทนชายแดน
otBorderAgentState Typedef
ระบุสถานะ Border Agent

ตัวแปร
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

ระบุสถานะ Border Agent

พร็อพเพอร์ตี้
OT_BORDER_AGENT_STATE_ACTIVE

ตัวแทนชายแดนติดต่อกับเจ้าหน้าที่ภายนอก

OT_BORDER_AGENT_STATE_STARTED

เริ่มต้นเส้นขอบแล้ว

OT_BORDER_AGENT_STATE_STOPPED

ปิดใช้บทบาทตัวแทนชายแดนแล้ว

ประเภทคําสั่ง

รหัส Agent ของ OOT

struct otBorderAgentId otBorderAgentId

แสดงรหัสตัวแทนชายแดน

สถานะการค้นหาของตัวแทน

enum otBorderAgentState otBorderAgentState

ระบุสถานะ Border Agent

ตัวแปร

OT_TOOL_PACKED_END

OT_TOOL_PACKED_BEGIN struct otBorderAgentId OT_TOOL_PACKED_END

ฟังก์ชัน

รหัส Agent ของ OtBorder

otError otBorderAgentGetId(
  otInstance *aInstance,
  otBorderAgentId *aId
)

รับรหัสเอเจนต์เส้นขอบที่สร้างขึ้นแบบสุ่ม

ระบบจะบันทึกรหัสไว้ในพื้นที่เก็บข้อมูลถาวรและคงสถานะรีบูต กรณีการใช้งานทั่วไปของรหัสคือเผยแพร่ในบริการ MeshCoP mDNS เป็นค่า TXT ของ id สําหรับให้ไคลเอ็นต์ระบุ Border Router/Agent นี้

รายละเอียด
พารามิเตอร์
[in] aInstance
ตัวชี้ไปยังอินสแตนซ์ OpenThread
[out] aId
ตัวชี้ไปยังบัฟเฟอร์เพื่อรับรหัส
แสดงผลค่า
OT_ERROR_NONE
ถ้ามีการเรียกรหัสของชายแดนสําเร็จแล้ว
...
หากเรียกดูรหัสตัวแทนชายแดนไม่สําเร็จ
ดูเพิ่มเติม:
otBorderAgentSetId

สถานะการค้นหาของตัวแทน

otBorderAgentState otBorderAgentGetState(
  otInstance *aInstance
)

รับ otBorderAgentState ของบทบาท Thread Border Agent

รายละเอียด
พารามิเตอร์
[in] aInstance
ตัวชี้ไปยังอินสแตนซ์ OpenThread
การส่งคืน
otBorderAgentState ปัจจุบันของ Border Agent

OTBorderAgentGetUdpPort

uint16_t otBorderAgentGetUdpPort(
  otInstance *aInstance
)

รับพอร์ต UDP ของบริการ Thread Border Agent

รายละเอียด
พารามิเตอร์
[in] aInstance
ตัวชี้ไปยังอินสแตนซ์ OpenThread
การส่งคืน
พอร์ต UDP ของตัวแทนชายแดน

รหัสชุด Agent

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

ตั้งค่ารหัสตัวแทนชายแดน

ระบบจะบันทึกรหัส Border Agent ไว้ในพื้นที่เก็บข้อมูลถาวรและเพื่อรีบูต คุณจะต้องตั้งค่ารหัสดังกล่าวเพียงครั้งเดียวหลังจากรีเซ็ตเป็นค่าเริ่มต้น หากไม่เคยกําหนดรหัสโดยการเรียกใช้ฟังก์ชันนี้ ระบบจะสร้างรหัสแบบสุ่มและส่งกลับเมื่อมีการเรียกใช้ otBorderAgentGetId

รายละเอียด
พารามิเตอร์
[in] aInstance
ตัวชี้ไปยังอินสแตนซ์ OpenThread
[out] aId
ตัวชี้ไปยังรหัสเส้นขอบชายแดน
แสดงผลค่า
OT_ERROR_NONE
หากตั้งค่ารหัสตัวแทนชายแดนเรียบร้อยแล้ว
...
หากตั้งค่ารหัสตัวแทนชายแดนไม่สําเร็จ
ดูเพิ่มเติม:
otBorderAgentGetId

มาโคร

OT_BORDER_AGENT_ID_LENGTH

 OT_BORDER_AGENT_ID_LENGTH (16)

ความยาวของรหัสเส้นขอบ/รหัสเส้นทางในไบต์

แหล่งข้อมูล

หัวข้ออ้างอิง OpenThread API มาจากซอร์สโค้ด ซึ่งพร้อมใช้งานใน GitHub ดูข้อมูลเพิ่มเติมหรือมีส่วนร่วมในเอกสารประกอบได้ที่แหล่งข้อมูล