ボーダー エージェント

このモジュールでは、Thread ボーダー エージェントのロールに関する関数について説明します。

まとめ

列挙型
otBorderAgentState{
  OT_BORDER_AGENT_STATE_STOPPED = 0,
  OT_BORDER_AGENT_STATE_STARTED = 1,
  OT_BORDER_AGENT_STATE_ACTIVE = 2
} 		enum
Border エージェントの状態を定義します。

Typedef
otBorderAgentId typedef
Border Agent ID を表します。
otBorderAgentState typedef
Border エージェントの状態を定義します。

変数
OT_TOOL_PACKED_END

関数
otBorderAgentGetId(otInstance *aInstance, otBorderAgentId *aId)
ランダムに生成された Border Agent ID を取得します。
otBorderAgentGetState(otInstance *aInstance)
Thread ボーダー エージェント ロールの otBorderAgentState を取得します。
otBorderAgentGetUdpPort(otInstance *aInstance)
uint16_t
Thread ボーダー エージェント サービスの UDP ポートを取得します。
otBorderAgentSetId(otInstance *aInstance, const otBorderAgentId *aId)
Border Agent ID を設定します。

構造体
otBorderAgentId

Border Agent ID を表します。

列挙型

otBorderAgentState

 otBorderAgentState

Border エージェントの状態を定義します。

プロパティ
OT_BORDER_AGENT_STATE_ACTIVE

国境エージェントは外部コミッショナーに接続されています。
OT_BORDER_AGENT_STATE_STARTED

ボーダー エージェントを開始しました。
OT_BORDER_AGENT_STATE_STOPPED

ボーダー エージェントのロールは無効です。

Typedef

otBorderAgentId

struct otBorderAgentId otBorderAgentId

Border Agent ID を表します。

otBorderAgentState

enum otBorderAgentState otBorderAgentState

Border エージェントの状態を定義します。

変数

OT_TOOL_PACKED_END

OT_TOOL_PACKED_BEGIN struct otBorderAgentId OT_TOOL_PACKED_END

関数

otBorderAgentGetId

otError otBorderAgentGetId(
  otInstance *aInstance,
  otBorderAgentId *aId
)

ランダムに生成された Border Agent ID を取得します。

ID は永続ストレージに保存され、再起動後も保持されます。ID の一般的なユースケースは、クライアントがこの Border Router/エージェント デバイスを識別するための id TXT 値として MeshCoP mDNS サービスで公開されることです。

詳細
パラメータ
[in] aInstance
OpenThread インスタンスへのポインタ。
[out] aId
ID を受け取るバッファへのポインタ。
戻り値
OT_ERROR_NONE
Border Agent ID が正常に取得された場合。
...
ボーダー エージェント ID を取得できませんでした。
関連項目:
otBorderAgentSetId

otBorderAgentGetState

otBorderAgentState otBorderAgentGetState(
  otInstance *aInstance
)

Thread ボーダー エージェント ロールの otBorderAgentState を取得します。

詳細
パラメータ
[in] aInstance
OpenThread インスタンスへのポインタ。
戻り値
Border Agent の現在の otBorderAgentState。

otBorderAgentGetUdpPort

uint16_t otBorderAgentGetUdpPort(
  otInstance *aInstance
)

Thread ボーダー エージェント サービスの UDP ポートを取得します。

詳細
パラメータ
[in] aInstance
OpenThread インスタンスへのポインタ。
戻り値
Border Agent の UDP ポート。

otBorderAgentSetId

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

Border Agent ID を設定します。

Border Agent ID は永続ストレージに保存され、再起動後も存続します。この ID は、出荷時の設定にリセットした後に一度だけ設定する必要があります。この関数を呼び出して ID を設定しなかった場合、otBorderAgentGetId が呼び出されるとランダムな ID が生成されて返されます。

詳細
パラメータ
[in] aInstance
OpenThread インスタンスへのポインタ。
[out] aId
Border Agent ID へのポインタ。
戻り値
OT_ERROR_NONE
成功した場合は、Border Agent ID を設定します。
...
ボーダー エージェント ID を設定できなかった場合。
関連項目:
otBorderAgentGetId

マクロ

OT_BORDER_AGENT_ID_LENGTH

 OT_BORDER_AGENT_ID_LENGTH (16)

Border Agent/Router ID の長さ（バイト単位）

関連情報

OpenThread API リファレンスのトピックは、GitHub で入手可能なソースコードに基づいています。詳細やドキュメントの作成方法については、リソースをご覧ください。