このページは Cloud Translation API によって翻訳されました。

ルーター/リーダー

このモジュールには、スレッドルーターとリーダーの関数が含まれています。

概要

列挙型
`otCacheEntryState`	列挙型この列挙型は、EID キャッシュエントリの状態を定義します。
`otNeighborTableEvent{ OT_NEIGHBOR_TABLE_EVENT_CHILD_ADDED, OT_NEIGHBOR_TABLE_EVENT_CHILD_REMOVED, OT_NEIGHBOR_TABLE_EVENT_CHILD_MODE_CHANGED, OT_NEIGHBOR_TABLE_EVENT_ROUTER_ADDED, OT_NEIGHBOR_TABLE_EVENT_ROUTER_REMOVED }`	列挙型この列挙型は、隣接テーブルの変更を示すために `otNeighborTableCallback` で使用される定数を定義します。

Typedef
`otCacheEntryInfo`	typedef `struct otCacheEntryInfo` この構造は EID キャッシュエントリを表します。
`otCacheEntryIterator`	typedef `struct otCacheEntryIterator` このタイプは、EID キャッシュテーブルエントリのイテレーションに使用するイテレータを表します。
`otCacheEntryState`	typedef `enum otCacheEntryState` この列挙型は、EID キャッシュエントリの状態を定義します。
`otChildIp6AddressIterator`	typedef `uint16_t` Thread Child エントリの IPv6 アドレスを反復処理するために使用されます。
`otNeighborTableCallback)(otNeighborTableEvent aEvent, const otNeighborTableEntryInfo *aEntryInfo)`	typedef `void(*` この関数ポインタは、ネイバーテーブルに変化があったことを通知するために呼び出されます。

関数
`otThreadBecomeLeader(otInstance *aInstance)`	`otError` リーダーになり、新しいパーティションを開始します。
`otThreadBecomeRouter(otInstance *aInstance)`	`otError` ルーターになってみます。
`otThreadGetChildInfoById(otInstance aInstance, uint16_t aChildId, otChildInfo aChildInfo)`	`otError` この関数では、子の診断情報を子 ID または RLOC16 で保持します。
`otThreadGetChildInfoByIndex(otInstance aInstance, uint16_t aChildIndex, otChildInfo aChildInfo)`	`otError` この関数は、内部テーブルのインデックスによって、接続された子の診断情報を保持します。
`otThreadGetChildNextIp6Address(otInstance aInstance, uint16_t aChildIndex, otChildIp6AddressIterator aIterator, otIp6Address *aAddress)`	`otError` この関数は、特定の子に対する次の IPv6 アドレス（イテレータを使用）を取得します。
`otThreadGetContextIdReuseDelay(otInstance *aInstance)`	`uint32_t` リーダーの役割に使用された CONTEXT_ID_REUSE_Delay パラメータを取得します。
`otThreadGetJoinerUdpPort(otInstance *aInstance)`	`uint16_t` Joiner UDP ポートを取得します。
`otThreadGetLocalLeaderWeight(otInstance *aInstance)`	`uint8_t` リーダーのロールを操作したときに使用するスレッドリーダーの重量を取得します。
`otThreadGetMaxAllowedChildren(otInstance *aInstance)`	`uint16_t` 現在許可されている子の最大数を取得します。
`otThreadGetMaxChildIpAddresses(otInstance *aInstance)`	`uint8_t` この関数は、各 MTD 子がこのデバイスに親として登録できる IP アドレスの最大数を取得します。
`otThreadGetMaxRouterId(otInstance *aInstance)`	`uint8_t` この関数は、許可されるルーター ID の最大数を返します。
`otThreadGetNetworkIdTimeout(otInstance *aInstance)`	`uint8_t` ルーターの役割で使用される NETWORK_ID_TIMEOUT パラメータを取得します。
`otThreadGetNextCacheEntry(otInstance aInstance, otCacheEntryInfo aEntryInfo, otCacheEntryIterator *aIterator)`	`otError` この関数は、次の EID キャッシュエントリを（イテレータを使用して）取得します。
`otThreadGetParentPriority(otInstance *aInstance)`	`int8_t` 割り当てられた親の優先度を取得します。
`otThreadGetPreferredLeaderPartitionId(otInstance *aInstance)`	`uint32_t` リーダーロールの操作時に使用したい、スレッドリーダーパーティション ID を取得します。
`otThreadGetPskc(otInstance aInstance, otPskc aPskc)`	`void` Thread の PSKc を取得します。
`otThreadGetPskcRef(otInstance *aInstance)`	`otPskcRef` 保存されたスレッド PSKc のキー参照を取得します。
`otThreadGetRouterDowngradeThreshold(otInstance *aInstance)`	`uint8_t` Router の役割で使用される ROUTER_DOWNGRADE_THRESHOLD パラメータを取得します。
`otThreadGetRouterIdRange(otInstance aInstance, uint8_t aMinRouterId, uint8_t *aMaxRouterId)`	`void` この関数は、スレッドネットワーク内のノードへの割り当てが許可されているルーター ID の範囲を取得します。
`otThreadGetRouterIdSequence(otInstance *aInstance)`	`uint8_t` 現在のルーター ID シーケンスを取得します。
`otThreadGetRouterInfo(otInstance aInstance, uint16_t aRouterId, otRouterInfo aRouterInfo)`	`otError` この関数は、指定された Thread Router の診断情報を保持します。
`otThreadGetRouterSelectionJitter(otInstance *aInstance)`	`uint8_t` REED/Router ロールで使用される ROUTER_SELECTION_JITTER パラメータを取得します。
`otThreadGetRouterUpgradeThreshold(otInstance *aInstance)`	`uint8_t` REED ロールで使用される ROUTER_UPGRADE_THRESHOLD パラメータを取得します。
`otThreadIsRouterEligible(otInstance *aInstance)`	`bool` このメソッドは、デバイスがルーターに対応しているかどうかを示します。
`otThreadRegisterNeighborTableCallback(otInstance *aInstance, otNeighborTableCallback aCallback)`	`void` この関数は、隣接テーブルコールバック関数を登録します。
`otThreadReleaseRouterId(otInstance *aInstance, uint8_t aRouterId)`	`otError` リーダーのロールを持つデバイスによって割り当てられたルーター ID を解放します。
`otThreadSetCcmEnabled(otInstance *aInstance, bool aEnabled)`	`void` この関数は、CCM を使用してデバイスが試されたかどうかを設定します。
`otThreadSetContextIdReuseDelay(otInstance *aInstance, uint32_t aDelay)`	`void` リーダーの役割に使用する CONTEXT_ID_REUSE_Delay パラメータを設定します。
`otThreadSetJoinerUdpPort(otInstance *aInstance, uint16_t aJoinerUdpPort)`	`otError` Joiner UDP ポートを設定します。
`otThreadSetLocalLeaderWeight(otInstance *aInstance, uint8_t aWeight)`	`void` リーダーの役割を操作するときに使用する Thread Leader の重みを設定します。
`otThreadSetMaxAllowedChildren(otInstance *aInstance, uint16_t aMaxChildren)`	`otError` 現在許可されている子の最大数を設定します。
`otThreadSetMaxChildIpAddresses(otInstance *aInstance, uint8_t aMaxIpAddresses)`	`otError` この関数は、各 MTD 子がこのデバイスに親として登録できる IP アドレスの最大数を設定または復元します。
`otThreadSetNetworkIdTimeout(otInstance *aInstance, uint8_t aTimeout)`	`void` リーダーの役割で使用する NETWORK_ID_TIMEOUT パラメータを設定します。
`otThreadSetParentPriority(otInstance *aInstance, int8_t aParentPriority)`	`otError` 親の優先度を設定します。
`otThreadSetPreferredLeaderPartitionId(otInstance *aInstance, uint32_t aPartitionId)`	`void` リーダーのロールを操作するときに使用する、スレッドのリーダーパーティション ID を設定してください。
`otThreadSetPreferredRouterId(otInstance *aInstance, uint8_t aRouterId)`	`otError` 優先するルーター ID を設定します。
`otThreadSetPskc(otInstance aInstance, const otPskc aPskc)`	`otError` Thread PSKc を設定します。
`otThreadSetPskcRef(otInstance *aInstance, otPskcRef aKeyRef)`	`otError` Thread PSKc を設定します。
`otThreadSetRouterDowngradeThreshold(otInstance *aInstance, uint8_t aThreshold)`	`void` リーダーの役割で使用する ROUTER_DOWNGRADE_THRESHOLD パラメータを設定します。
`otThreadSetRouterEligible(otInstance *aInstance, bool aEligible)`	`otError` この関数は、デバイスがルーターに対応しているかどうかを設定します。
`otThreadSetRouterIdRange(otInstance *aInstance, uint8_t aMinRouterId, uint8_t aMaxRouterId)`	`otError` この関数は、スレッドネットワーク内のノードへの割り当てを許可するルーター ID の範囲を設定します。
`otThreadSetRouterSelectionJitter(otInstance *aInstance, uint8_t aRouterJitter)`	`void` REED/Router ロールで使用される ROUTER_SELECTION_JITTER パラメータを設定します。
`otThreadSetRouterUpgradeThreshold(otInstance *aInstance, uint8_t aThreshold)`	`void` リーダーの役割で使用する ROUTER_UPGRADE_THRESHOLD パラメータを設定します。
`otThreadSetSteeringData(otInstance aInstance, const otExtAddress aExtAddress)`	`void` 帯域外データの設定。
`otThreadSetThreadVersionCheckEnabled(otInstance *aInstance, bool aEnabled)`	`void` この関数は、ルーティング用のセキュリティポリシー TLV のバージョンしきい値（VR フィールド）を有効にするかどうかを設定します。

構造体
otCacheEntryInfo	この構造は EID キャッシュエントリを表します。
otCacheEntryIterator	このタイプは、EID キャッシュテーブルエントリのイテレーションに使用するイテレータを表します。
otChildInfo	この構造体は、スレッドの子の診断情報を保持します。
otNeighborTableEntryInfo	このタイプは、隣接テーブルエントリの情報（子またはルーター）を表し、隣接テーブルコールバック `otNeighborTableCallback` のパラメータとして使用されます。

列挙型

otCacheEntryState

 otCacheEntryState

この列挙型は、EID キャッシュエントリの状態を定義します。

otNeighborTableEvent

 otNeighborTableEvent

この列挙型は、隣接テーブルの変更を示すために otNeighborTableCallback で使用される定数を定義します。

プロパティ
`OT_NEIGHBOR_TABLE_EVENT_CHILD_ADDED`	子どもを追加しようとしています。
`OT_NEIGHBOR_TABLE_EVENT_CHILD_MODE_CHANGED`	既存の子のモードが変更された
`OT_NEIGHBOR_TABLE_EVENT_CHILD_REMOVED`	子どもを削除しています。
`OT_NEIGHBOR_TABLE_EVENT_ROUTER_ADDED`	ルーターを追加しています。
`OT_NEIGHBOR_TABLE_EVENT_ROUTER_REMOVED`	ルーターを削除しています。

Typedef

otCacheEntryInfo

struct otCacheEntryInfo otCacheEntryInfo

この構造は EID キャッシュエントリを表します。

otCacheEntryIterator

struct otCacheEntryIterator otCacheEntryIterator

このタイプは、EID キャッシュテーブルエントリのイテレーションに使用するイテレータを表します。

イテレータを初期化し、キャッシュテーブルの最初のエントリから開始するには、構造内のすべてのフィールドをゼロに設定します（例: memset イテレータをゼロにする）。

otCacheEntryState

enum otCacheEntryState otCacheEntryState

この列挙型は、EID キャッシュエントリの状態を定義します。

otChildIp6AddressIterator

uint16_t otChildIp6AddressIterator

Thread Child エントリの IPv6 アドレスを反復処理するために使用されます。

otNeighborTableCallback

void(* otNeighborTableCallback)(otNeighborTableEvent aEvent, const otNeighborTableEntryInfo *aEntryInfo)

この関数ポインタは、ネイバーテーブルに変化があったことを通知するために呼び出されます。

詳細

パラメータ

`[in] aEvent`	イベントフラグ。
`[in] aEntryInfo`	テーブルエントリ情報を指すポインタ。

関数

OTThreadBeginLeader

otError otThreadBecomeLeader(
  otInstance *aInstance
)

リーダーになり、新しいパーティションを開始します。

詳細

パラメータ

[in] aInstance

OpenThread インスタンスへのポインタ。

戻り値

`OT_ERROR_NONE`	リーダーになり、新しいパーティションを開始しました。
`OT_ERROR_INVALID_STATE`	スレッドが無効になっている。

otThread ホスティングルーター

otError otThreadBecomeRouter(
  otInstance *aInstance
)

ルーターになってみます。

詳細

パラメータ

[in] aInstance

OpenThread インスタンスへのポインタ。

戻り値

`OT_ERROR_NONE`	ルーターへの正常接続の開始を試みます。
`OT_ERROR_INVALID_STATE`	スレッドが無効になっている。

otThreadGetChildInfoById

otError otThreadGetChildInfoById(
  otInstance *aInstance,
  uint16_t aChildId,
  otChildInfo *aChildInfo
)

この関数では、子の診断情報を子 ID または RLOC16 で保持します。

詳細

パラメータ

`[in] aInstance`	OpenThread インスタンスへのポインタ。
`[in] aChildId`	添付された子の子 ID または RLOC16。
`[out] aChildInfo`	子情報が配置されている場所へのポインタ。

戻り値

`OT_ERROR_NONE`	指定した ID の情報で `aChildInfo` を更新しました。
`OT_ERROR_NOT_FOUND`	この子 ID を持つ有効な子がありません。
`OT_ERROR_INVALID_ARGS`	`aChildInfo` が NULL の場合。

otThreadGetChildInfoByIndex

otError otThreadGetChildInfoByIndex(
  otInstance *aInstance,
  uint16_t aChildIndex,
  otChildInfo *aChildInfo
)

この関数は、内部テーブルのインデックスによって、接続された子の診断情報を保持します。

詳細

パラメータ

`[in] aInstance`	OpenThread インスタンスへのポインタ。
`[in] aChildIndex`	テーブルのインデックス。
`[out] aChildInfo`	子情報が配置されている場所へのポインタ。

戻り値

`OT_ERROR_NONE`	`aChildInfo` は指定したインデックスの情報で正常に更新されました。
`OT_ERROR_NOT_FOUND`	このインデックスに有効な子がありません。
`OT_ERROR_INVALID_ARGS`	`aChildInfo` が NULL であるか、`aChildIndex` は範囲外です（最大テーブルインデックスより高く）。

関連項目:
otGetMaxAllowedChildren

otThreadGetChildNextIp6Address

otError otThreadGetChildNextIp6Address(
  otInstance *aInstance,
  uint16_t aChildIndex,
  otChildIp6AddressIterator *aIterator,
  otIp6Address *aAddress
)

この関数は、特定の子に対する次の IPv6 アドレス（イテレータを使用）を取得します。

詳細

パラメータ

`[in] aInstance`	OpenThread インスタンスへのポインタ。
`[in] aChildIndex`	子インデックス。
`[in,out] aIterator`	イテレータへのポインタ。成功すると、イテレータがリスト内の次のエントリを指すように更新されます。最初の IPv6 アドレスを取得するには、イテレータを OT_CHILD_IP6_ADDRESS_ITERATOR_INIT に設定する必要があります。
`[out] aAddress`	子の次のアドレスが配置されている IPv6 アドレスへのポインタ（成功した場合）。

戻り値

`OT_ERROR_NONE`	次の IPv6 アドレスを検出しました（`aAddress` は正常に更新されました）。
`OT_ERROR_NOT_FOUND`	子には、後続の IPv6 アドレスエントリはありません。
`OT_ERROR_INVALID_ARGS`	`aIterator` または `aAddress` が NULL であるか、`aChildIndex` の子が無効です。

関連項目:
otThreadGetChildInfoByIndex

otThreadGetContextIdReuseDelay

uint32_t otThreadGetContextIdReuseDelay(
  otInstance *aInstance
)

リーダーの役割に使用された CONTEXT_ID_REUSE_Delay パラメータを取得します。

詳細

パラメータ

[in] aInstance

OpenThread インスタンスへのポインタ。

戻り値

CONTEXT_ID_REUSE_Delay 値。

関連項目:
otThreadSetContextIdReuseDelay

otThreadGetJoinerUdpPort

uint16_t otThreadGetJoinerUdpPort(
  otInstance *aInstance
)

Joiner UDP ポートを取得します。

詳細

パラメータ

[in] aInstance

OpenThread インスタンスへのポインタ。

戻り値

Joiner UDP ポート番号。

関連情報:
otThreadSetJoinerUdpPort

otThreadGetLocalLeaderWeight

uint8_t otThreadGetLocalLeaderWeight(
  otInstance *aInstance
)

リーダーのロールを操作したときに使用するスレッドリーダーの重量を取得します。

詳細

パラメータ

[in] aInstance

OpenThread インスタンスへのポインタ。

戻り値

スレッドリーダーの重みの値。

関連情報:
otThreadSetLeaderWeight

otThreadGetMaxAllowedChildren（OTThreadGetMaxAllowedChildren）

uint16_t otThreadGetMaxAllowedChildren(
  otInstance *aInstance
)

現在許可されている子の最大数を取得します。

詳細

パラメータ

[in] aInstance

OpenThread インスタンスへのポインタ。

戻り値

現在許可されている子の最大数。

関連情報:
otThreadSetMaxAllowedChildren

otThreadGetMaxChildIpAddresses

uint8_t otThreadGetMaxChildIpAddresses(
  otInstance *aInstance
)

この関数は、各 MTD 子がこのデバイスに親として登録できる IP アドレスの最大数を取得します。

詳細

パラメータ

[in] aInstance

OpenThread インスタンスへのポインタ。

戻り値

各 MTD 子がこのデバイスに親として登録できる IP アドレスの最大数です。

関連項目:
otThreadSetMaxChildIpAddresses

otThreadGetMaxRouterId

uint8_t otThreadGetMaxRouterId(
  otInstance *aInstance
)

この関数は、許可されるルーター ID の最大数を返します。

詳細

パラメータ

[in] aInstance

OpenThread インスタンスへのポインタ。

戻り値

許可されるルーター ID の最大値。

otThreadGetNetworkIdTimeout（OTThreadGetNetworkIdTimeout）

uint8_t otThreadGetNetworkIdTimeout(
  otInstance *aInstance
)

ルーターの役割で使用される NETWORK_ID_TIMEOUT パラメータを取得します。

詳細

パラメータ

[in] aInstance

OpenThread インスタンスへのポインタ。

戻り値

NETWORK_ID_TIMEOUT の値。

関連情報:
otThreadSetNetworkIdTimeout

otThreadGetNextCacheEntry

otError otThreadGetNextCacheEntry(
  otInstance *aInstance,
  otCacheEntryInfo *aEntryInfo,
  otCacheEntryIterator *aIterator
)

この関数は、次の EID キャッシュエントリを（イテレータを使用して）取得します。

詳細

パラメータ

`[in] aInstance`	OpenThread インスタンスへのポインタ。
`[out] aEntryInfo`	EID キャッシュエントリ情報が配置されている場所へのポインタ。
`[in,out] aIterator`	イテレータへのポインタ。成功した場合、次のエントリを参照するように更新されます。最初のエントリを取得するには、すべてのフィールドをゼロに設定して（たとえば、 `memset` イテレータ構造をゼロにします）。

戻り値

`OT_ERROR_NONE`	次の EID キャッシュエントリに `aEntryInfo` の値を設定しました。
`OT_ERROR_NOT_FOUND`	アドレスキャッシュテーブルにエントリがありません。

otThreadGetParentPriority

int8_t otThreadGetParentPriority(
  otInstance *aInstance
)

割り当てられた親の優先度を取得します。

詳細

パラメータ

[in] aInstance

OpenThread インスタンスへのポインタ。

戻り値

割り当てられた親の優先度の値 -2 は、割り当てられていないことを意味します。

関連情報:
otThreadSetParentPriority

otThreadGetPreferredLeaderPartitionId

uint32_t otThreadGetPreferredLeaderPartitionId(
  otInstance *aInstance
)

リーダーロールの操作時に使用したい、スレッドリーダーパーティション ID を取得します。

詳細

パラメータ

[in] aInstance

OpenThread インスタンスへのポインタ。

戻り値

スレッドリーダーのパーティション ID の値。

otThreadGetPskc

void otThreadGetPskc(
  otInstance *aInstance,
  otPskc *aPskc
)

Thread の PSKc を取得します。

詳細

パラメータ

`[in] aInstance`	OpenThread インスタンスへのポインタ。
`[out] aPskc`	取得した Thread PSKc を返す `otPskc` へのポインタ。

関連情報:
otThreadSetPskc

otThreadGetPskcRef

otPskcRef otThreadGetPskcRef(
  otInstance *aInstance
)

保存されたスレッド PSKc のキー参照を取得します。

この関数でビルド時の機能 OPENTHREAD_CONFIG_PLATFORM_KEY_REFERENCES_ENABLE を有効にする必要があります。

詳細

パラメータ

[in] aInstance

OpenThread インスタンスへのポインタ。

戻り値

PSKc の主なリファレンス

関連情報:
otThreadSetPskcRef

otThreadGetRouterDowngradeThreshold

uint8_t otThreadGetRouterDowngradeThreshold(
  otInstance *aInstance
)

Router の役割で使用される ROUTER_DOWNGRADE_THRESHOLD パラメータを取得します。

詳細

パラメータ

[in] aInstance

OpenThread インスタンスへのポインタ。

戻り値

ROUTER_DOWNGRADE_THRESHOLD の値。

関連情報:
otThreadSetRouterDowngradeThreshold

otThreadGetRouterIdRange

void otThreadGetRouterIdRange(
  otInstance *aInstance,
  uint8_t *aMinRouterId,
  uint8_t *aMaxRouterId
)

この関数は、スレッドネットワーク内のノードへの割り当てが許可されているルーター ID の範囲を取得します。

注: この API はテスト目的でのみ使用され、OPENTHREAD_CONFIG_REFERENCE_DEVICE_ENABLE が必要です。[aMinRouterId, aMaxRouterId] の範囲内のすべてのルーター ID が許可されます。

詳細

パラメータ

`[in] aInstance`	OpenThread インスタンスへのポインタ。
`[out] aMinRouterId`	ルーターの最小 ID。
`[out] aMaxRouterId`	最大ルーター ID

関連情報:
otThreadSetRouterIdRange

otThreadGetRouterIdSequence

uint8_t otThreadGetRouterIdSequence(
  otInstance *aInstance
)

現在のルーター ID シーケンスを取得します。

詳細

パラメータ

[in] aInstance

OpenThread インスタンスへのポインタ。

戻り値

ルーター ID のシーケンス。

otThreadGetRouterInfo

otError otThreadGetRouterInfo(
  otInstance *aInstance,
  uint16_t aRouterId,
  otRouterInfo *aRouterInfo
)

この関数は、指定された Thread Router の診断情報を保持します。

詳細

パラメータ

`[in] aInstance`	OpenThread インスタンスへのポインタ。
`[in] aRouterId`	特定のルーターのルーター ID または RLOC16。
`[out] aRouterInfo`	ルーター情報が配置されている場所へのポインタ。

戻り値

`OT_ERROR_NONE`	指定された ID のルーター情報を正常に取得しました。
`OT_ERROR_NOT_FOUND`	指定された ID のルーターエントリがありません。
`OT_ERROR_INVALID_ARGS`	`aRouterInfo` が NULL である。

otThreadGetRouterSelectionJitter

uint8_t otThreadGetRouterSelectionJitter(
  otInstance *aInstance
)

REED/Router ロールで使用される ROUTER_SELECTION_JITTER パラメータを取得します。

詳細

パラメータ

[in] aInstance

OpenThread インスタンスへのポインタ。

戻り値

ROUTER_SELECTION_JITTER 値。

関連情報:
otThreadSetRouterSelectionJitter

otThreadGetRouterUpgradeThreshold

uint8_t otThreadGetRouterUpgradeThreshold(
  otInstance *aInstance
)

REED ロールで使用される ROUTER_UPGRADE_THRESHOLD パラメータを取得します。

詳細

パラメータ

[in] aInstance

OpenThread インスタンスへのポインタ。

戻り値

ROUTER_UPGRADE_THRESHOLD 値です。

関連情報:
otThreadSetRouterUpgradeThreshold

otThreadIsRouter 機能の有効

bool otThreadIsRouterEligible(
  otInstance *aInstance
)

このメソッドは、デバイスがルーターに対応しているかどうかを示します。

詳細

パラメータ

[in] aInstance

OpenThread インスタンスへのポインタ。

戻り値

`TRUE`	デバイスがルーターに対応しているかどうか。
`FALSE`	デバイスがルーターの対象でない場合。

otThreadRegisterNeighborTableCallback（OTThreadRegisterNeighborTableCallback）

void otThreadRegisterNeighborTableCallback(
  otInstance *aInstance,
  otNeighborTableCallback aCallback
)

この関数は、隣接テーブルコールバック関数を登録します。

指定されたコールバック（非 NULL の場合）は、ネイバーテーブルが変更されたとき（子またはルーターのネイバーエントリが追加または削除されたとき、既存の子モードが変更されたとき）に呼び出されます。

このメソッドをその後呼び出すと、前のコールバックは上書きされます。隣接テーブル/子テーブルの更新中、および常に otStateChangedCallback の前に、このコールバックが呼び出されます。

詳細

パラメータ

`[in] aInstance`	OpenThread インスタンスへのポインタ。
`[in] aCallback`	コールバックハンドラ関数へのポインタ。

otThreadReleaseRouterId

otError otThreadReleaseRouterId(
  otInstance *aInstance,
  uint8_t aRouterId
)

リーダーのロールを持つデバイスによって割り当てられたルーター ID を解放します。

詳細

パラメータ

`[in] aInstance`	OpenThread インスタンスへのポインタ。
`[in] aRouterId`	解放するルーター ID。有効な範囲は [0, 62] です。

戻り値

`OT_ERROR_NONE`	ルーター ID を正常に解放しました。
`OT_ERROR_INVALID_ARGS`	`aRouterId` が [0, 62] の範囲内にありません。
`OT_ERROR_INVALID_STATE`	デバイスは現在、リーダーとして動作していません。
`OT_ERROR_NOT_FOUND`	現在、ルーター ID は割り当てられていません。

otThreadSetCcmEnabled（otThreadSetCcmEnabled）

void otThreadSetCcmEnabled(
  otInstance *aInstance,
  bool aEnabled
)

この関数は、CCM を使用してデバイスが試されたかどうかを設定します。

注: この API には OPENTHREAD_CONFIG_REFERENCE_DEVICE_ENABLE が必要であり、このデバイスが CCM を使用して試運転されたことを示すためにスレッドテストハーネスでのみ使用されます。

詳細

パラメータ

`[in] aInstance`	OpenThread インスタンスへのポインタ。
`[in] aEnabled`	デバイスが CCM を使用して試された場合は TRUE、それ以外の場合は FALSE です。

otThreadSetContextIdReuseDelay（OTThreadSetContextIdReuseDelay）

void otThreadSetContextIdReuseDelay(
  otInstance *aInstance,
  uint32_t aDelay
)

リーダーの役割に使用する CONTEXT_ID_REUSE_Delay パラメータを設定します。

詳細

パラメータ

`[in] aInstance`	OpenThread インスタンスへのポインタ。
`[in] aDelay`	CONTEXT_ID_REUSE_Delay 値。

関連項目:
otThreadGetContextIdReuseDelay

otThreadSetJoinerUdpPort

otError otThreadSetJoinerUdpPort(
  otInstance *aInstance,
  uint16_t aJoinerUdpPort
)

Joiner UDP ポートを設定します。

詳細

パラメータ

`[in] aInstance`	OpenThread インスタンスへのポインタ。
`[in] aJoinerUdpPort`	Joiner UDP ポート番号。

戻り値

OT_ERROR_NONE

Joiner UDP ポートを設定しました。

関連情報:
otThreadGetJoinerUdpPort

otThreadSetLocalLeader 重み

void otThreadSetLocalLeaderWeight(
  otInstance *aInstance,
  uint8_t aWeight
)

リーダーの役割を操作するときに使用する Thread Leader の重みを設定します。

詳細

パラメータ

`[in] aInstance`	OpenThread インスタンスへのポインタ。
`[in] aWeight`	スレッドリーダーの重みの値。

関連情報:
otThreadGetLeaderWeight

otThreadSetMaxAllowedChildren（OTThreadSetMaxAllowedChildren）

otError otThreadSetMaxAllowedChildren(
  otInstance *aInstance,
  uint16_t aMaxChildren
)

現在許可されている子の最大数を設定します。

このパラメータは、スレッドプロトコル操作が停止している場合にのみ設定できます。

詳細

パラメータ

`[in] aInstance`	OpenThread インスタンスへのポインタ。
`[in] aMaxChildren`	許可されている子の最大数。

戻り値

`OT_ERROR_NONE`	上限
`OT_ERROR_INVALID_ARGS`	`aMaxChildren` が [1, OPENTHREAD_CONFIG_MLE_MAX_CHILDREN] の範囲にない場合。
`OT_ERROR_INVALID_STATE`	スレッドが停止していない場合。

関連情報:
otThreadGetMaxAllowedChildren

otThreadSetMaxChildIpAddresses

otError otThreadSetMaxChildIpAddresses(
  otInstance *aInstance,
  uint8_t aMaxIpAddresses
)

この関数は、各 MTD 子がこのデバイスに親として登録できる IP アドレスの最大数を設定または復元します。

注: この API は OPENTHREAD_CONFIG_REFERENCE_DEVICE_ENABLE を必要とし、MTD DUT 反応をテストするために参照親のアドレス登録を制限するスレッドテストハーネスでのみ使用されます。

詳細

パラメータ

`[in] aInstance`	OpenThread インスタンスへのポインタ。
`[in] aMaxIpAddresses`	各 MTD 子がこのデバイスに親として登録できる IP アドレスの最大数です。設定をクリアしてデフォルトの値に戻すには 0。

戻り値

`OT_ERROR_NONE`	番号を設定またはクリアしました。
`OT_ERROR_INVALID_ARGS`	最大許容数を超えた場合。

関連情報:
otThreadGetMaxChildIpAddresses

otThreadSetNetworkIdTimeout（リセット）

void otThreadSetNetworkIdTimeout(
  otInstance *aInstance,
  uint8_t aTimeout
)

リーダーの役割で使用する NETWORK_ID_TIMEOUT パラメータを設定します。

詳細

パラメータ

`[in] aInstance`	OpenThread インスタンスへのポインタ。
`[in] aTimeout`	NETWORK_ID_TIMEOUT の値。

関連情報:
otThreadGetNetworkIdTimeout

otThreadSetParentPriority

otError otThreadSetParentPriority(
  otInstance *aInstance,
  int8_t aParentPriority
)

親の優先度を設定します。

詳細

パラメータ

`[in] aInstance`	OpenThread インスタンスへのポインタ。
`[in] aParentPriority`	親の優先度の値。

戻り値

`OT_ERROR_NONE`	親の優先度を設定しました。
`OT_ERROR_INVALID_ARGS`	親の優先度の値が 1、0、-1、-2 の範囲外の場合。

関連情報:
otThreadGetParentPriority

otThreadSetPreferredLeaderPartitionId

void otThreadSetPreferredLeaderPartitionId(
  otInstance *aInstance,
  uint32_t aPartitionId
)

リーダーのロールを操作するときに使用する、スレッドのリーダーパーティション ID を設定してください。

詳細

パラメータ

`[in] aInstance`	OpenThread インスタンスへのポインタ。
`[in] aPartitionId`	スレッドリーダーのパーティション ID の値。

otThreadSetPreferredRouterId

otError otThreadSetPreferredRouterId(
  otInstance *aInstance,
  uint8_t aRouterId
)

優先するルーター ID を設定します。

ルーターまたはリーダーになると、ノードはこのルーター ID を使用しようとします。優先されるルーター ID が設定されていない場合、または使用できない場合は、ランダムに生成されたルーター ID が選択されます。このプロパティを設定できるのは、デバイスロールが接続解除されているか無効になっている場合のみです。

詳細

パラメータ

`[in] aInstance`	OpenThread インスタンスへのポインタ。
`[in] aRouterId`	優先するルーター ID。

戻り値

`OT_ERROR_NONE`	優先するルーター ID を設定しました。
`OT_ERROR_INVALID_STATE`	設定できませんでした（ロールが接続解除または無効化されていません）

otThreadSetPskc

otError otThreadSetPskc(
  otInstance *aInstance,
  const otPskc *aPskc
)

Thread PSKc を設定します。

この関数は、スレッドプロトコルが無効になっている場合にのみ成功します。この関数の呼び出しが成功すると、不揮発性メモリ内のアクティブおよび保留中のオペレーショナルデータセットも無効になります。

詳細

パラメータ

`[in] aInstance`	OpenThread インスタンスへのポインタ。
`[in] aPskc`	新しい Thread PSKc へのポインタ。

戻り値

`OT_ERROR_NONE`	スレッド PSKc を設定しました。
`OT_ERROR_INVALID_STATE`	スレッドプロトコルは有効になっています。

関連情報:
otThreadGetPskc

otThreadSetPskcref

otError otThreadSetPskcRef(
  otInstance *aInstance,
  otPskcRef aKeyRef
)

Thread PSKc を設定します。

この関数でビルド時の機能 OPENTHREAD_CONFIG_PLATFORM_KEY_REFERENCES_ENABLE を有効にする必要があります。

詳細

パラメータ

`[in] aInstance`	OpenThread インスタンスへのポインタ。
`[in] aKeyRef`	新しい Thread PSKc のキーリファレンス。

戻り値

`OT_ERROR_NONE`	スレッド PSKc を設定しました。
`OT_ERROR_INVALID_STATE`	スレッドプロトコルは有効になっています。

関連情報:
otThreadGetPskcRef

otThreadSetRouterDowngradeThreshold（無視される）

void otThreadSetRouterDowngradeThreshold(
  otInstance *aInstance,
  uint8_t aThreshold
)

リーダーの役割で使用する ROUTER_DOWNGRADE_THRESHOLD パラメータを設定します。

詳細

パラメータ

`[in] aInstance`	OpenThread インスタンスへのポインタ。
`[in] aThreshold`	ROUTER_DOWNGRADE_THRESHOLD の値。

関連情報:
otThreadGetRouterDowngradeThreshold

otThreadSetRouter 機能の有効

otError otThreadSetRouterEligible(
  otInstance *aInstance,
  bool aEligible
)

この関数は、デバイスがルーターに対応しているかどうかを設定します。

aEligible が false で、デバイスが現在ルーターとして動作している場合、この呼び出しによってデバイスが切断され、子として再接続を試行します。

詳細

パラメータ

`[in] aInstance`	OpenThread インスタンスへのポインタ。
`[in] aEligible`	ルーター対応デバイスを設定する場合は TRUE、それ以外の場合は FALSE にします。

戻り値

`OT_ERROR_NONE`	ルーターが有効な構成を正常に設定しました。
`OT_ERROR_NOT_CAPABLE`	デバイスがルーターに対応していない。

otThreadSetRouterIdRange

otError otThreadSetRouterIdRange(
  otInstance *aInstance,
  uint8_t aMinRouterId,
  uint8_t aMaxRouterId
)

この関数は、スレッドネットワーク内のノードへの割り当てを許可するルーター ID の範囲を設定します。

詳細

パラメータ

`[in] aInstance`	OpenThread インスタンスへのポインタ。
`[in] aMinRouterId`	ルーターの最小 ID。
`[in] aMaxRouterId`	最大ルーター ID

戻り値

`OT_ERROR_NONE`	範囲が正常に設定されました。
`OT_ERROR_INVALID_ARGS`	aMinRouterId > aMaxRouterId、または範囲が [0, 62] に満たない。

関連情報:
otThreadGetRouterIdRange

otThreadSetRouterSelectionJitter

void otThreadSetRouterSelectionJitter(
  otInstance *aInstance,
  uint8_t aRouterJitter
)

REED/Router ロールで使用される ROUTER_SELECTION_JITTER パラメータを設定します。

詳細

パラメータ

`[in] aInstance`	OpenThread インスタンスへのポインタ。
`[in] aRouterJitter`	ROUTER_SELECTION_JITTER 値。

関連情報:
otThreadGetRouterSelectionJitter

otThreadSetRouterUpgradeThreshold

void otThreadSetRouterUpgradeThreshold(
  otInstance *aInstance,
  uint8_t aThreshold
)

リーダーの役割で使用する ROUTER_UPGRADE_THRESHOLD パラメータを設定します。

詳細

パラメータ

`[in] aInstance`	OpenThread インスタンスへのポインタ。
`[in] aThreshold`	ROUTER_UPGRADE_THRESHOLD 値です。

関連情報:
otThreadGetRouterUpgradeThreshold

otThreadSetSteeringData

void otThreadSetSteeringData(
  otInstance *aInstance,
  const otExtAddress *aExtAddress
)

帯域外データの設定。

帯域外ステアリングの設定を有効にするには、設定オプション OPENTHREAD_CONFIG_MLE_STEERING_DATA_SET_OOB_ENABLE を設定する必要があります。

詳細

パラメータ

[in] aInstance

OpenThread インスタンスへのポインタ。

[in] aExtAddress

ステアリングデータの更新に使用する住所。ステアリングデータをクリアするには、すべてゼロ（ステアリングデータなし）。すべての 0xFF は、ステアリングデータ/ブルームフィルタを設定して、すべてを承認/許可します。特定の EUI64 は、現在のステアリングデータ/ブルームフィルタに追加されます。

otThreadSetThreadVersionCheckEnabled（OTThreadSetThreadVersionCheckEnabled の有効化）

void otThreadSetThreadVersionCheckEnabled(
  otInstance *aInstance,
  bool aEnabled
)

この関数は、ルーティング用のセキュリティポリシー TLV のバージョンしきい値（VR フィールド）を有効にするかどうかを設定します。

注: この API には OPENTHREAD_CONFIG_REFERENCE_DEVICE_ENABLE が必要であり、スレッドプロトコルバージョンチェック VR をスキップする必要があることを示すためにスレッドテストハーネスによってのみ使用されます。

詳細

パラメータ

`[in] aInstance`	OpenThread インスタンスへのポインタ。
`[in] aEnabled`	ルーティングにセキュリティポリシー TLV のバージョンしきい値を有効にするには TRUE、それ以外の場合は FALSE。

マクロ

[OT_CHILD_IP6_ADDRESS_ITERATOR_INIT]

 OT_CHILD_IP6_ADDRESS_ITERATOR_INIT 0

otChildIP6AddressIterator の初期化子。

リソース

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

ルーター/リーダー

概要

列挙型

Typedef

関数

構造体

列挙型

otCacheEntryState

otNeighborTableEvent

Typedef

otCacheEntryInfo

otCacheEntryIterator

otCacheEntryState

otChildIp6AddressIterator

otNeighborTableCallback

関数

OTThreadBeginLeader

otThread ホスティング ルーター

otThreadGetChildInfoById

otThreadGetChildInfoByIndex

otThreadGetChildNextIp6Address

otThreadGetContextIdReuseDelay

otThreadGetJoinerUdpPort

otThreadGetLocalLeaderWeight

otThreadGetMaxAllowedChildren（OTThreadGetMaxAllowedChildren）

otThreadGetMaxChildIpAddresses

otThreadGetMaxRouterId

otThreadGetNetworkIdTimeout（OTThreadGetNetworkIdTimeout）

otThreadGetNextCacheEntry

otThreadGetParentPriority

otThreadGetPreferredLeaderPartitionId

otThreadGetPskc

otThreadGetPskcRef

otThreadGetRouterDowngradeThreshold

otThreadGetRouterIdRange

otThreadGetRouterIdSequence

otThreadGetRouterInfo

otThreadGetRouterSelectionJitter

otThreadGetRouterUpgradeThreshold

otThreadIsRouter 機能の有効

otThreadRegisterNeighborTableCallback（OTThreadRegisterNeighborTableCallback）

otThreadReleaseRouterId

otThreadSetCcmEnabled（otThreadSetCcmEnabled）

otThreadSetContextIdReuseDelay（OTThreadSetContextIdReuseDelay）

otThreadSetJoinerUdpPort

otThreadSetLocalLeader 重み

otThreadSetMaxAllowedChildren（OTThreadSetMaxAllowedChildren）

otThreadSetMaxChildIpAddresses

otThreadSetNetworkIdTimeout（リセット）

otThreadSetParentPriority

otThreadSetPreferredLeaderPartitionId

otThreadSetPreferredRouterId

otThreadSetPskc

otThreadSetPskcref

otThreadSetRouterDowngradeThreshold（無視される）

otThreadSetRouter 機能の有効

otThreadSetRouterIdRange

otThreadSetRouterSelectionJitter

otThreadSetRouterUpgradeThreshold

otThreadSetSteeringData

otThreadSetThreadVersionCheckEnabled（OTThreadSetThreadVersionCheckEnabled の有効化）

マクロ

[OT_CHILD_IP6_ADDRESS_ITERATOR_INIT]

リソース

otThread ホスティングルーター