このページは 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 }`	enum この列挙体はで使用される定数を定義`otNeighborTableCallback`ネイバーテーブルの変更を示すために。

Typedef
`otCacheEntryInfo`	typedef `struct otCacheEntryInfo` この構造は、EIDキャッシュエントリを表します。
`otCacheEntryIterator`	typedef `struct otCacheEntryIterator` このタイプは、EIDキャッシュテーブルエントリを反復処理するために使用されるイテレータを表します。
`otCacheEntryState`	typedef `enum otCacheEntryState` この列挙は、EIDキャッシュエントリの状態を定義します。
`otChildIp6AddressIterator`	typedef `uint16_t` スレッド子エントリの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` ジョイナー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` スレッドPSKcを取得します。
`otThreadGetPskcRef ( otInstance *aInstance)`	`otPskcRef` 保存されているスレッドPSKcへのキー参照を取得します。
`otThreadGetRouterDowngradeThreshold ( otInstance *aInstance)`	`uint8_t` ルーターの役割で使用されるROUTER_DOWNGRADE_THRESHOLDパラメーターを取得します。
`otThreadGetRouterIdSequence ( otInstance *aInstance)`	`uint8_t` 現在のルーターIDシーケンスを取得します。
`otThreadGetRouterInfo ( otInstance aInstance, uint16_t aRouterId, otRouterInfo aRouterInfo)`	`otError` この関数は、特定のスレッドルーターの診断情報を保持します。
`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` ジョイナUDPポートを設定します。
`otThreadSetLocalLeaderWeight ( otInstance *aInstance, uint8_t aWeight)`	`void` リーダーロールで操作するときに使用するスレッドリーダーの重みを設定します。
`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` スレッドPSKcを設定します。
`otThreadSetPskcRef ( otInstance *aInstance, otPskcRef aKeyRef)`	`otError` スレッドPSKcを設定します。
`otThreadSetRouterDowngradeThreshold ( otInstance *aInstance, uint8_t aThreshold)`	`void` リーダーロールで使用されるROUTER_DOWNGRADE_THRESHOLDパラメーターを設定します。
`otThreadSetRouterEligible ( otInstance *aInstance, bool aEligible)`	`otError` この関数は、デバイスがルーター適格であるかどうかを設定します。
`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` ステアリングデータを帯域外に設定します。

構造体
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`	ルーターが削除されています。

Typedefs

otCacheEntryInfo

struct otCacheEntryInfo otCacheEntryInfo

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

otCacheEntryIterator

struct otCacheEntryIterator otCacheEntryIterator

このタイプは、EIDキャッシュテーブルエントリを反復処理するために使用されるイテレータを表します。

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

otCacheEntryState

enum otCacheEntryState otCacheEntryState

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

otChildIp6AddressIterator

uint16_t otChildIp6AddressIterator

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

otNeighborTableCallback

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

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

詳細

パラメーター

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

関数

otThreadBecomeLeader

otError otThreadBecomeLeader(
  otInstance *aInstance
)

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

詳細

パラメーター

[in] aInstance

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

戻り値

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

otThreadBecomeRouter

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`	`aChildInfo`成功した指定されたIDの情報を更新しました。
`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
)

ジョイナーUDPポートを取得します。

詳細

パラメーター

[in] aInstance

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

戻り値

ジョイナーUDPポート番号。

参照：
otThreadSetJoinerUdpPort

otThreadGetLocalLeaderWeight

uint8_t otThreadGetLocalLeaderWeight(
  otInstance *aInstance
)

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

詳細

パラメーター

[in] aInstance

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

戻り値

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

参照：
otThreadSetLeaderWeight

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

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`	首尾よく取り込ま`aEntryInfo`次のEIDキャッシュエントリのため。
`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
)

スレッドPSKcを取得します。

詳細

パラメーター

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

参照：
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_DOWNGRADE_THRESHOLDパラメーターを取得します。

詳細

パラメーター

[in] aInstance

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

戻り値

ROUTER_DOWNGRADE_THRESHOLD値。

参照：
otThreadSetRouterDowngradeThreshold

otThreadGetRouterIdSequence

uint8_t otThreadGetRouterIdSequence(
  otInstance *aInstance
)

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

詳細

パラメーター

[in] aInstance

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

戻り値

ルーターIDシーケンス。

otThreadGetRouterInfo

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

この関数は、特定のスレッドルーターの診断情報を保持します。

詳細

パラメーター

`[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

otThreadIsRouterEligible

bool otThreadIsRouterEligible(
  otInstance *aInstance
)

このメソッドは、デバイスがルーターに適格であるかどうかを示します。

詳細

パラメーター

[in] aInstance

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

戻り値

`TRUE`	デバイスがルーター適格である場合。
`FALSE`	デバイスがルーターに適格でない場合。

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

void otThreadSetCcmEnabled(
  otInstance *aInstance,
  bool aEnabled
)

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

注：このAPIは、必要とOPENTHREAD_CONFIG_REFERENCE_DEVICE_ENABLE 、そしてこのデバイスは、CCMを使用して委託されたかどうかを示すために、スレッドテストハーネスでのみ使用されます。

詳細

パラメーター

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

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
)

ジョイナUDPポートを設定します。

詳細

パラメーター

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

戻り値

OT_ERROR_NONE

ジョイナーUDPポートを正常に設定しました。

参照：
otThreadGetJoinerUdpPort

otThreadSetLocalLeaderWeight

void otThreadSetLocalLeaderWeight(
  otInstance *aInstance,
  uint8_t aWeight
)

リーダーロールで操作するときに使用するスレッドリーダーの重みを設定します。

詳細

パラメーター

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

参照：
otThreadGetLeaderWeight

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
)

スレッドPSKcを設定します。

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

詳細

パラメーター

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

戻り値

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

参照：
otThreadGetPskc

otThreadSetPskcRef

otError otThreadSetPskcRef(
  otInstance *aInstance,
  otPskcRef aKeyRef
)

スレッドPSKcを設定します。

この機能は、ビルド時の機能が必要ですOPENTHREAD_CONFIG_PLATFORM_KEY_REFERENCES_ENABLE有効にする必要が。

詳細

パラメーター

`[in] aInstance`	OpenThreadインスタンスへのポインタ。
`[in] aPskcRef`	新しいスレッド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

otThreadSetRouterEligible

otError otThreadSetRouterEligible(
  otInstance *aInstance,
  bool aEligible
)

この関数は、デバイスがルーター適格であるかどうかを設定します。

場合aEligible虚偽であり、デバイスは、現在ルータとして動作している、この呼び出しは、デバイスが切り離し、子として再接続しようとするものもあります。

詳細

パラメーター

`[in] aInstance`	OpenThreadインスタンスへのポインタ。
`[in] aEligible`	デバイスをルーター適格として構成する場合はTRUE、それ以外の場合はFALSE。

戻り値

`OT_ERROR_NONE`	ルーター適格構成を正常に設定しました。
`OT_ERROR_NOT_CAPABLE`	デバイスはルーターになることができません。

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は、現在のステアリングデータ/ブルームフィルターに追加されます。

マクロ

OT_CHILD_IP6_ADDRESS_ITERATOR_INIT

 OT_CHILD_IP6_ADDRESS_ITERATOR_INIT 0

otChildIP6AddressIteratorのイニシャライザー。