Đại lý biên giới

Học phần này bao gồm các hàm cho vai trò Thread Border Agent.

Tóm tắt

Bảng liệt kê
otBorderAgentState{
  OT_BORDER_AGENT_STATE_STOPPED = 0,
  OT_BORDER_AGENT_STATE_STARTED = 1,
  OT_BORDER_AGENT_STATE_ACTIVE = 2
} 		enum
Xác định trạng thái Tác nhân biên giới.

Typedef
otBorderAgentId typedef
Đại diện cho mã đại lý đường biên.
otBorderAgentState typedef
Xác định trạng thái Tác nhân biên giới.

Biến
OT_TOOL_PACKED_END

Hàm
otBorderAgentGetId(otInstance *aInstance, otBorderAgentId *aId)
Nhận Mã đại lý đường viền được tạo ngẫu nhiên.
otBorderAgentGetState(otInstance *aInstance)
Lấy otBorderAgentState của vai trò Agent Border Agent.
otBorderAgentGetUdpPort(otInstance *aInstance)
uint16_t
Lấy cổng UDP của dịch vụ Thread Border Agent.
otBorderAgentSetId(otInstance *aInstance, const otBorderAgentId *aId)
Đặt Mã nhận dạng tác nhân biên giới.

Cấu trúc
Mã đại lý otBorder

Đại diện cho mã đại lý đường biên.

Bảng liệt kê

Trạng thái đại lý otBorder

 otBorderAgentState

Xác định trạng thái Tác nhân biên giới.

Thuộc tính
OT_BORDER_AGENT_STATE_ACTIVE

Tác nhân biên giới đã kết nối với ủy viên bên ngoài.

OT_BORDER_AGENT_STATE_STARTED

Tác nhân biên giới đã bắt đầu.

OT_BORDER_AGENT_STATE_STOPPED

Vai trò nhân viên hỗ trợ tại biên giới đã bị vô hiệu hóa.

Typedef

Mã đại lý otBorder

struct otBorderAgentId otBorderAgentId

Đại diện cho mã đại lý đường biên.

Trạng thái đại lý otBorder

enum otBorderAgentState otBorderAgentState

Xác định trạng thái Tác nhân biên giới.

Biến

Hàm OT_TOOL_PACKED_END

OT_TOOL_PACKED_BEGIN struct otBorderAgentId OT_TOOL_PACKED_END

Hàm

otBorderAgentGetId

otError otBorderAgentGetId(
  otInstance *aInstance,
  otBorderAgentId *aId
)

Nhận Mã đại lý đường viền được tạo ngẫu nhiên.

ID được lưu trong bộ nhớ ổn định và vẫn có thể khởi động lại. Trường hợp sử dụng mã nhận dạng điển hình là phát hành trong dịch vụ mDNS của MeshCoP dưới dạng giá trị TXT của id để ứng dụng có thể xác định Thiết bị định tuyến/tác nhân biên giới này.

Thông tin chi tiết
Các tham số
[in] aInstance
Con trỏ trỏ đến một thực thể OpenThread.
[out] aId
Con trỏ trỏ vào vùng đệm để nhận được mã nhận dạng.
Giá trị trả về
OT_ERROR_NONE
Nếu đã truy xuất thành công mã đại lý biên giới.
...
Nếu không thể truy xuất mã tác nhân biên giới.
Xem thêm:
otBorderAgentSetId

otBorderAgentGetState

otBorderAgentState otBorderAgentGetState(
  otInstance *aInstance
)

Lấy otBorderAgentState của vai trò Agent Border Agent.

Thông tin chi tiết
Các tham số
[in] aInstance
Con trỏ trỏ đến một thực thể OpenThread.
Trả về
otBorderAgentState hiện tại của Border Agent.

Cổng otBorderAgentGetUdp

uint16_t otBorderAgentGetUdpPort(
  otInstance *aInstance
)

Lấy cổng UDP của dịch vụ Thread Border Agent.

Thông tin chi tiết
Các tham số
[in] aInstance
Con trỏ trỏ đến một thực thể OpenThread.
Trả về
Cổng UDP của Tác nhân Biên giới.

Mã nhóm đại biểu otBorder

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

Đặt Mã nhận dạng tác nhân biên giới.

Mã đại lý biên giới sẽ được lưu trong bộ nhớ liên tục và vẫn tồn tại sau khi khởi động lại. Bạn phải đặt mã nhận dạng chỉ một lần sau khi khôi phục cài đặt gốc. Nếu bạn chưa đặt mã bằng cách gọi hàm này, thì một mã nhận dạng ngẫu nhiên sẽ được tạo và trả về khi otBorderAgentGetId được gọi.

Thông tin chi tiết
Các tham số
[in] aInstance
Con trỏ trỏ đến một thực thể OpenThread.
[out] aId
Con trỏ trỏ đến mã tác nhân biên giới.
Giá trị trả về
OT_ERROR_NONE
Nếu đã đặt thành công Mã đại lý biên giới.
...
Nếu không thể đặt Mã tác nhân biên giới.
Xem thêm:
otBorderAgentGetId

Macro

OT_BORDER_AGENT_ID_LENGTH

 OT_BORDER_AGENT_ID_LENGTH (16)

Độ dài của mã tác nhân/bộ định tuyến đường viền tính bằng byte.

Tài nguyên

Các chủ đề Tham chiếu API OpenThread bắt nguồn từ mã nguồn, có sẵn trên GitHub. Để biết thêm thông tin hoặc đóng góp cho tài liệu của chúng tôi, hãy tham khảo phần Tài nguyên.