Agen Batas

Modul ini mencakup fungsi untuk peran Agen Batas Thread.

Ringkasan

Enumerasi
otBorderAgentState{
  OT_BORDER_AGENT_STATE_STOPPED = 0,
  OT_BORDER_AGENT_STATE_STARTED = 1,
  OT_BORDER_AGENT_STATE_ACTIVE = 2
} 		enum
Menentukan status Border Agent.

Typedef
otBorderAgentId typedef
Mewakili ID Agen Border.
otBorderAgentState typedef
Menentukan status Border Agent.

Variabel
OT_TOOL_PACKED_END

Fungsi
otBorderAgentGetId(otInstance *aInstance, otBorderAgentId *aId)
Mendapatkan ID Agen Border yang dibuat secara acak.
otBorderAgentGetState(otInstance *aInstance)
Mendapatkan otBorderAgentState dari peran Thread Border Agent.
otBorderAgentGetUdpPort(otInstance *aInstance)
uint16_t
Mendapatkan port UDP dari layanan Border Agent.
otBorderAgentSetId(otInstance *aInstance, const otBorderAgentId *aId)
Menetapkan ID Agen Batas.

Struct
otBorderAgentId

Mewakili ID Agen Border.

Enumerasi

otBorderAgentState

 otBorderAgentState

Menentukan status Border Agent.

Properti
OT_BORDER_AGENT_STATE_ACTIVE

Agen perbatasan terhubung dengan komisaris eksternal.

OT_BORDER_AGENT_STATE_STARTED

Agen batas dimulai.

OT_BORDER_AGENT_STATE_STOPPED

Peran agen batas dinonaktifkan.

Typedef

otBorderAgentId

struct otBorderAgentId otBorderAgentId

Mewakili ID Agen Border.

otBorderAgentState

enum otBorderAgentState otBorderAgentState

Menentukan status Border Agent.

Variabel

OT_TOOL_PACKED_END [OT_TOOL_PACKED_END]

OT_TOOL_PACKED_BEGIN struct otBorderAgentId OT_TOOL_PACKED_END

Fungsi

otBorderAgentGetId

otError otBorderAgentGetId(
  otInstance *aInstance,
  otBorderAgentId *aId
)

Mendapatkan ID Agen Border yang dibuat secara acak.

ID disimpan di penyimpanan persisten dan bertahan dari mulai ulang. Kasus penggunaan umum ID adalah untuk dipublikasikan di layanan mDNS MeshCoP sebagai nilai TXT id bagi klien untuk mengidentifikasi perangkat Border Router/Agent ini.

Detail
Parameter
[in] aInstance
Pointer ke instance OpenThread.
[out] aId
Pointer yang akan melakukan buffering untuk menerima ID.
Nilai yang Ditampilkan
OT_ERROR_NONE
Jika berhasil mengambil ID Agen Pembatas.
...
Jika gagal mengambil ID Agen Border.
Lihat juga:
otBorderAgentSetId

otBorderAgentGetState

otBorderAgentState otBorderAgentGetState(
  otInstance *aInstance
)

Mendapatkan otBorderAgentState dari peran Thread Border Agent.

Detail
Parameter
[in] aInstance
Pointer ke instance OpenThread.
Pengembalian
otBorderAgentState Border Agent saat ini.

otBorderAgentGetUdpPort

uint16_t otBorderAgentGetUdpPort(
  otInstance *aInstance
)

Mendapatkan port UDP dari layanan Border Agent.

Detail
Parameter
[in] aInstance
Pointer ke instance OpenThread.
Pengembalian
Port UDP dari Border Agent.

otBorderAgentSetId

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

Menetapkan ID Agen Batas.

ID Agen Border akan disimpan di penyimpanan persisten dan bertahan dari mulai ulang. ID ini hanya perlu disetel sekali setelah reset ke setelan pabrik. Jika ID belum pernah ditetapkan dengan memanggil fungsi ini, ID acak akan dibuat dan ditampilkan saat otBorderAgentGetId dipanggil.

Detail
Parameter
[in] aInstance
Pointer ke instance OpenThread.
[out] aId
Pointer ke ID Agen Border.
Nilai yang Ditampilkan
OT_ERROR_NONE
Jika berhasil menetapkan ID Border Agent.
...
Jika gagal menetapkan ID Border Agent.
Lihat juga:
otBorderAgentGetId

Makro

OT_BORDER_AGENT_ID_LENGTH

 OT_BORDER_AGENT_ID_LENGTH (16)

Panjang Border Agent/Router ID dalam byte.

Referensi

Topik Referensi OpenThread API berasal dari kode sumber, yang tersedia di GitHub. Untuk informasi selengkapnya, atau untuk berkontribusi pada dokumentasi kami, lihat Referensi.