TREL - スレッド スタック

このモジュールでは、Thread Over Infrastructure 用の Thread Radio Encapsulation Link（TREL）API を定義します。

概要

このモジュールの関数を使用するには、OPENTHREAD_CONFIG_RADIO_LINK_TREL_ENABLE を有効にする必要があります。

Typedef
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 ピアを表します。

Typedef

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」で継続的な DNS-SD ブラウジングを開始し、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 で入手できるソースコードに由来しています。 詳細について、またはドキュメントへの投稿については、リソースをご覧ください。