TREL - 執行緒堆疊

這個模組定義了適用於 Thread 的 Thread 無線電封裝連結 (TREL) API。

摘要

必須啟用 OPENTHREAD_CONFIG_RADIO_LINK_TREL_ENABLE,才能使用這個模組中的函式。

Typedefs

otTrelPeer typedef
struct otTrelPeer
代表 TREL 對等點。
otTrelPeerIterator typedef
uint16_t
代表用於疊代 TREL 對等互連資料表項目的疊代器。

函式

otTrelGetNextPeer(otInstance *aInstance, otTrelPeerIterator *aIterator)
const otTrelPeer *
對對等互連資料表項目進行疊代,並從資料表取得下一個項目。
otTrelInitPeerIterator(otInstance *aInstance, otTrelPeerIterator *aIterator)
void
初始化對等互連資料表疊代器。
otTrelIsEnabled(otInstance *aInstance)
bool
指出 TREL 作業是否已啟用。
otTrelIsFilterEnabled(otInstance *aInstance)
bool
指出篩選器模式是否啟用。
otTrelSetEnabled(otInstance *aInstance, bool aEnable)
void
啟用或停用 TREL 作業。
otTrelSetFilterEnabled(otInstance *aInstance, bool aEnable)
void
設定篩選器模式 (啟用/停用篩選功能)。

結構

otTrelPeer

代表 TREL 對等點。

Typedefs

otTrelPeer

struct otTrelPeer otTrelPeer

代表 TREL 對等點。

otTrelPeerIterator

uint16_t otTrelPeerIterator

代表用於疊代 TREL 對等互連資料表項目的疊代器。

函式

otTrelGetNextPeer

const otTrelPeer * otTrelGetNextPeer(
  otInstance *aInstance,
  otTrelPeerIterator *aIterator
)

對對等互連資料表項目進行疊代,並從資料表取得下一個項目。

詳細說明
參數
[in] aInstance
OpenThread 執行個體。
[in] aIterator
疊代器。必須初始化。
傳回
指向下一個 otTrelPeer 項目或 NULL 如果資料表中沒有其他項目的指標。

otTrelInitPeerIterator

void otTrelInitPeerIterator(
  otInstance *aInstance,
  otTrelPeerIterator *aIterator
)

初始化對等互連資料表疊代器。

詳細說明
參數
[in] aInstance
OpenThread 執行個體。
[in] aIterator
要初始化的疊代器。

otTrelIsEnabled

bool otTrelIsEnabled(
  otInstance *aInstance
)

指出 TREL 作業是否已啟用。

詳細說明
參數
[in] aInstance
OpenThread 執行個體。
傳回值
TRUE
(如果 TREL 作業已啟用)。
FALSE
表示 TREL 運算已停用。

otTrelIsFilterEnabled

bool otTrelIsFilterEnabled(
  otInstance *aInstance
)

指出篩選器模式是否啟用。

詳細說明
參數
[in] aInstance
OpenThread 執行個體。
傳回值
TRUE
前提是使用者啟用 TREL 篩選器模式。
FALSE
則會停用 TREL 篩選器模式。

otTrelSetEnabled

void otTrelSetEnabled(
  otInstance *aInstance,
  bool aEnable
)

啟用或停用 TREL 作業。

如果 aEnable 為 true,這個函式會進行本機瀏覽網域中的「_trel._udp」服務名稱「_trel._udp」持續瀏覽,以找出其他支援 TREL 的裝置。裝置也會註冊要透過 DNS-SD 進行宣傳的新服務 (服務名稱為「_trel._udp」),表示支援 TREL。然後,裝置即可接收來自同類應用程式的 TREL 訊息。

aEnable 為 false 時,這個函式會停止服務名稱「_trel._udp」的 DNS-SD 瀏覽功能、停止通告 TREL DNS-SD 服務,以及清除 TREL 對等資料表。

詳細說明
參數
[in] aInstance
指向 OpenThread 執行個體的指標。
[in] aEnable
用於啟用/停用 TREL 作業的布林值。

otTrelSetFilterEnabled

void otTrelSetFilterEnabled(
  otInstance *aInstance,
  bool aEnable
)

設定篩選器模式 (啟用/停用篩選功能)。

啟用篩選器模式後,所有透過 TREL 介面進行的 rx 和 Tx 流量都會遭到捨棄,而且不會顯示相關通知。這主要用於測試期間。

與完全啟動/停止 TREL 作業的 otTrel{Enable/Disable}() 不同,當啟用篩選器模式時,TREL 介面仍會持續啟用。

詳細說明
參數
[in] aInstance
OpenThread 執行個體。
[in] aFiltered
TRUE 可啟用篩選器模式,設為 FALSE 可停用篩選器模式。

資源

OpenThread API 參考資料主題源自原始碼,請前往 GitHub 取得。如要瞭解詳情或對說明文件做出貢獻,請參閱資源