ルーター/リーダー
このモジュールには、スレッド ルーターとリーダーの関数が含まれています。
概要
列挙型 |
|
---|---|
otCacheEntryState
|
列挙型 この列挙型は、EID キャッシュ エントリの状態を定義します。 |
otNeighborTableEvent{
|
列挙型 この列挙型は、隣接テーブルの変更を示すために otNeighborTableCallback で使用される定数を定義します。 |
Typedef |
|
---|---|
otCacheEntryInfo
|
typedefstruct otCacheEntryInfo
この構造は EID キャッシュ エントリを表します。 |
otCacheEntryIterator
|
typedefstruct otCacheEntryIterator
このタイプは、EID キャッシュ テーブル エントリのイテレーションに使用するイテレータを表します。 |
otCacheEntryState
|
typedefenum otCacheEntryState
この列挙型は、EID キャッシュ エントリの状態を定義します。 |
otChildIp6AddressIterator
|
typedefuint16_t
Thread Child エントリの IPv6 アドレスを反復処理するために使用されます。 |
otNeighborTableCallback)(otNeighborTableEvent aEvent, const otNeighborTableEntryInfo *aEntryInfo)
|
typedefvoid(*
この関数ポインタは、ネイバーテーブルに変化があったことを通知するために呼び出されます。 |
関数 |
|
---|---|
otThreadBecomeLeader(otInstance *aInstance)
|
リーダーになり、新しいパーティションを開始します。
|
otThreadBecomeRouter(otInstance *aInstance)
|
ルーターになってみます。
|
otThreadGetChildInfoById(otInstance *aInstance, uint16_t aChildId, otChildInfo *aChildInfo)
|
この関数では、子の診断情報を子 ID または RLOC16 で保持します。
|
otThreadGetChildInfoByIndex(otInstance *aInstance, uint16_t aChildIndex, otChildInfo *aChildInfo)
|
この関数は、内部テーブルのインデックスによって、接続された子の診断情報を保持します。
|
otThreadGetChildNextIp6Address(otInstance *aInstance, uint16_t aChildIndex, otChildIp6AddressIterator *aIterator, otIp6Address *aAddress)
|
この関数は、特定の子に対する次の 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)
|
この関数は、次の EID キャッシュ エントリを(イテレータを使用して)取得します。
|
otThreadGetParentPriority(otInstance *aInstance)
|
int8_t
割り当てられた親の優先度を取得します。
|
otThreadGetPreferredLeaderPartitionId(otInstance *aInstance)
|
uint32_t
リーダーロールの操作時に使用したい、スレッド リーダー パーティション ID を取得します。
|
otThreadGetPskc(otInstance *aInstance, otPskc *aPskc)
|
void
Thread の PSKc を取得します。
|
otThreadGetPskcRef(otInstance *aInstance)
|
保存されたスレッド 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)
|
この関数は、指定された 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)
|
リーダーのロールを持つデバイスによって割り当てられたルーター 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)
|
Joiner UDP ポートを設定します。
|
otThreadSetLocalLeaderWeight(otInstance *aInstance, uint8_t aWeight)
|
void
リーダーの役割を操作するときに使用する Thread Leader の重みを設定します。
|
otThreadSetMaxAllowedChildren(otInstance *aInstance, uint16_t aMaxChildren)
|
現在許可されている子の最大数を設定します。
|
otThreadSetMaxChildIpAddresses(otInstance *aInstance, uint8_t aMaxIpAddresses)
|
この関数は、各 MTD 子がこのデバイスに親として登録できる IP アドレスの最大数を設定または復元します。
|
otThreadSetNetworkIdTimeout(otInstance *aInstance, uint8_t aTimeout)
|
void
リーダーの役割で使用する NETWORK_ID_TIMEOUT パラメータを設定します。
|
otThreadSetParentPriority(otInstance *aInstance, int8_t aParentPriority)
|
親の優先度を設定します。
|
otThreadSetPreferredLeaderPartitionId(otInstance *aInstance, uint32_t aPartitionId)
|
void
リーダーのロールを操作するときに使用する、スレッドのリーダー パーティション ID を設定してください。
|
otThreadSetPreferredRouterId(otInstance *aInstance, uint8_t aRouterId)
|
優先するルーター ID を設定します。
|
otThreadSetPskc(otInstance *aInstance, const otPskc *aPskc)
|
Thread PSKc を設定します。
|
otThreadSetPskcRef(otInstance *aInstance, otPskcRef aKeyRef)
|
Thread PSKc を設定します。
|
otThreadSetRouterDowngradeThreshold(otInstance *aInstance, uint8_t aThreshold)
|
void
リーダーの役割で使用する ROUTER_DOWNGRADE_THRESHOLD パラメータを設定します。
|
otThreadSetRouterEligible(otInstance *aInstance, bool aEligible)
|
この関数は、デバイスがルーターに対応しているかどうかを設定します。
|
otThreadSetRouterIdRange(otInstance *aInstance, uint8_t aMinRouterId, uint8_t aMaxRouterId)
|
この関数は、スレッド ネットワーク内のノードへの割り当てを許可するルーター 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 |
このタイプは、隣接テーブル エントリの情報(子またはルーター)を表し、隣接テーブル コールバック |
列挙型
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
otCacheEntryIterator
struct otCacheEntryIterator otCacheEntryIterator
このタイプは、EID キャッシュ テーブル エントリのイテレーションに使用するイテレータを表します。
イテレータを初期化し、キャッシュ テーブルの最初のエントリから開始するには、構造内のすべてのフィールドをゼロに設定します(例: memset
イテレータをゼロにする)。
otChildIp6AddressIterator
uint16_t otChildIp6AddressIterator
Thread Child エントリの IPv6 アドレスを反復処理するために使用されます。
otNeighborTableCallback
void(* otNeighborTableCallback)(otNeighborTableEvent aEvent, const otNeighborTableEntryInfo *aEntryInfo)
この関数ポインタは、ネイバーテーブルに変化があったことを通知するために呼び出されます。
詳細 | |||||
---|---|---|---|---|---|
パラメータ |
|
関数
OTThreadBeginLeader
otError otThreadBecomeLeader( otInstance *aInstance )
リーダーになり、新しいパーティションを開始します。
詳細 | |||||
---|---|---|---|---|---|
パラメータ |
|
||||
戻り値 |
|
otThread ホスティング ルーター
otError otThreadBecomeRouter( otInstance *aInstance )
ルーターになってみます。
詳細 | |||||
---|---|---|---|---|---|
パラメータ |
|
||||
戻り値 |
|
otThreadGetChildInfoById
otError otThreadGetChildInfoById( otInstance *aInstance, uint16_t aChildId, otChildInfo *aChildInfo )
この関数では、子の診断情報を子 ID または RLOC16 で保持します。
詳細 | |||||||
---|---|---|---|---|---|---|---|
パラメータ |
|
||||||
戻り値 |
|
otThreadGetChildInfoByIndex
otError otThreadGetChildInfoByIndex( otInstance *aInstance, uint16_t aChildIndex, otChildInfo *aChildInfo )
この関数は、内部テーブルのインデックスによって、接続された子の診断情報を保持します。
詳細 | |||||||
---|---|---|---|---|---|---|---|
パラメータ |
|
||||||
戻り値 |
|
otGetMaxAllowedChildren
otThreadGetChildNextIp6Address
otError otThreadGetChildNextIp6Address( otInstance *aInstance, uint16_t aChildIndex, otChildIp6AddressIterator *aIterator, otIp6Address *aAddress )
この関数は、特定の子に対する次の IPv6 アドレス(イテレータを使用)を取得します。
詳細 | |||||||||
---|---|---|---|---|---|---|---|---|---|
パラメータ |
|
||||||||
戻り値 |
|
otThreadGetChildInfoByIndex
otThreadGetContextIdReuseDelay
uint32_t otThreadGetContextIdReuseDelay( otInstance *aInstance )
リーダーの役割に使用された CONTEXT_ID_REUSE_Delay パラメータを取得します。
詳細 | |||
---|---|---|---|
パラメータ |
|
||
戻り値 |
CONTEXT_ID_REUSE_Delay 値。
|
otThreadSetContextIdReuseDelay
otThreadGetJoinerUdpPort
uint16_t otThreadGetJoinerUdpPort( otInstance *aInstance )
Joiner UDP ポートを取得します。
詳細 | |||
---|---|---|---|
パラメータ |
|
||
戻り値 |
Joiner UDP ポート番号。
|
otThreadSetJoinerUdpPort
otThreadGetLocalLeaderWeight
uint8_t otThreadGetLocalLeaderWeight( otInstance *aInstance )
リーダーのロールを操作したときに使用するスレッド リーダーの重量を取得します。
詳細 | |||
---|---|---|---|
パラメータ |
|
||
戻り値 |
スレッド リーダーの重みの値。
|
otThreadSetLeaderWeight
otThreadGetMaxAllowedChildren(OTThreadGetMaxAllowedChildren)
uint16_t otThreadGetMaxAllowedChildren( otInstance *aInstance )
現在許可されている子の最大数を取得します。
詳細 | |||
---|---|---|---|
パラメータ |
|
||
戻り値 |
現在許可されている子の最大数。
|
otThreadSetMaxAllowedChildren
otThreadGetMaxChildIpAddresses
uint8_t otThreadGetMaxChildIpAddresses( otInstance *aInstance )
この関数は、各 MTD 子がこのデバイスに親として登録できる IP アドレスの最大数を取得します。
詳細 | |||
---|---|---|---|
パラメータ |
|
||
戻り値 |
各 MTD 子がこのデバイスに親として登録できる IP アドレスの最大数です。
|
otThreadSetMaxChildIpAddresses
otThreadGetMaxRouterId
uint8_t otThreadGetMaxRouterId( otInstance *aInstance )
この関数は、許可されるルーター ID の最大数を返します。
詳細 | |||
---|---|---|---|
パラメータ |
|
||
戻り値 |
許可されるルーター ID の最大値。
|
otThreadGetNetworkIdTimeout(OTThreadGetNetworkIdTimeout)
uint8_t otThreadGetNetworkIdTimeout( otInstance *aInstance )
ルーターの役割で使用される NETWORK_ID_TIMEOUT パラメータを取得します。
詳細 | |||
---|---|---|---|
パラメータ |
|
||
戻り値 |
NETWORK_ID_TIMEOUT の値。
|
otThreadSetNetworkIdTimeout
otThreadGetNextCacheEntry
otError otThreadGetNextCacheEntry( otInstance *aInstance, otCacheEntryInfo *aEntryInfo, otCacheEntryIterator *aIterator )
この関数は、次の EID キャッシュ エントリを(イテレータを使用して)取得します。
詳細 | |||||||
---|---|---|---|---|---|---|---|
パラメータ |
|
||||||
戻り値 |
|
otThreadGetParentPriority
int8_t otThreadGetParentPriority( otInstance *aInstance )
割り当てられた親の優先度を取得します。
詳細 | |||
---|---|---|---|
パラメータ |
|
||
戻り値 |
割り当てられた親の優先度の値 -2 は、割り当てられていないことを意味します。
|
otThreadSetParentPriority
otThreadGetPreferredLeaderPartitionId
uint32_t otThreadGetPreferredLeaderPartitionId( otInstance *aInstance )
リーダーロールの操作時に使用したい、スレッド リーダー パーティション ID を取得します。
詳細 | |||
---|---|---|---|
パラメータ |
|
||
戻り値 |
スレッド リーダーのパーティション ID の値。
|
otThreadGetPskc
void otThreadGetPskc( otInstance *aInstance, otPskc *aPskc )
Thread の PSKc を取得します。
詳細 | |||||
---|---|---|---|---|---|
パラメータ |
|
otThreadSetPskc
otThreadGetPskcRef
otPskcRef otThreadGetPskcRef( otInstance *aInstance )
保存されたスレッド PSKc のキー参照を取得します。
この関数でビルド時の機能 OPENTHREAD_CONFIG_PLATFORM_KEY_REFERENCES_ENABLE
を有効にする必要があります。
詳細 | |||
---|---|---|---|
パラメータ |
|
||
戻り値 |
PSKc の主なリファレンス
|
otThreadSetPskcRef
otThreadGetRouterDowngradeThreshold
uint8_t otThreadGetRouterDowngradeThreshold( otInstance *aInstance )
Router の役割で使用される ROUTER_DOWNGRADE_THRESHOLD パラメータを取得します。
詳細 | |||
---|---|---|---|
パラメータ |
|
||
戻り値 |
ROUTER_DOWNGRADE_THRESHOLD の値。
|
otThreadSetRouterDowngradeThreshold
otThreadGetRouterIdRange
void otThreadGetRouterIdRange( otInstance *aInstance, uint8_t *aMinRouterId, uint8_t *aMaxRouterId )
この関数は、スレッド ネットワーク内のノードへの割り当てが許可されているルーター ID の範囲を取得します。
詳細 | |||||||
---|---|---|---|---|---|---|---|
パラメータ |
|
otThreadSetRouterIdRange
otThreadGetRouterIdSequence
uint8_t otThreadGetRouterIdSequence( otInstance *aInstance )
現在のルーター ID シーケンスを取得します。
詳細 | |||
---|---|---|---|
パラメータ |
|
||
戻り値 |
ルーター ID のシーケンス。
|
otThreadGetRouterInfo
otError otThreadGetRouterInfo( otInstance *aInstance, uint16_t aRouterId, otRouterInfo *aRouterInfo )
この関数は、指定された Thread Router の診断情報を保持します。
詳細 | |||||||
---|---|---|---|---|---|---|---|
パラメータ |
|
||||||
戻り値 |
|
otThreadGetRouterSelectionJitter
uint8_t otThreadGetRouterSelectionJitter( otInstance *aInstance )
REED/Router ロールで使用される ROUTER_SELECTION_JITTER パラメータを取得します。
詳細 | |||
---|---|---|---|
パラメータ |
|
||
戻り値 |
ROUTER_SELECTION_JITTER 値。
|
otThreadSetRouterSelectionJitter
otThreadGetRouterUpgradeThreshold
uint8_t otThreadGetRouterUpgradeThreshold( otInstance *aInstance )
REED ロールで使用される ROUTER_UPGRADE_THRESHOLD パラメータを取得します。
詳細 | |||
---|---|---|---|
パラメータ |
|
||
戻り値 |
ROUTER_UPGRADE_THRESHOLD 値です。
|
otThreadSetRouterUpgradeThreshold
otThreadIsRouter 機能の有効
bool otThreadIsRouterEligible( otInstance *aInstance )
このメソッドは、デバイスがルーターに対応しているかどうかを示します。
詳細 | |||||
---|---|---|---|---|---|
パラメータ |
|
||||
戻り値 |
|
otThreadRegisterNeighborTableCallback(OTThreadRegisterNeighborTableCallback)
void otThreadRegisterNeighborTableCallback( otInstance *aInstance, otNeighborTableCallback aCallback )
この関数は、隣接テーブル コールバック関数を登録します。
指定されたコールバック(非 NULL の場合)は、ネイバーテーブルが変更されたとき(子またはルーターのネイバー エントリが追加または削除されたとき、既存の子モードが変更されたとき)に呼び出されます。
このメソッドをその後呼び出すと、前のコールバックは上書きされます。隣接テーブル/子テーブルの更新中、および常に otStateChangedCallback
の前に、このコールバックが呼び出されます。
詳細 | |||||
---|---|---|---|---|---|
パラメータ |
|
otThreadReleaseRouterId
otError otThreadReleaseRouterId( otInstance *aInstance, uint8_t aRouterId )
リーダーのロールを持つデバイスによって割り当てられたルーター ID を解放します。
詳細 | |||||||||
---|---|---|---|---|---|---|---|---|---|
パラメータ |
|
||||||||
戻り値 |
|
otThreadSetCcmEnabled(otThreadSetCcmEnabled)
void otThreadSetCcmEnabled( otInstance *aInstance, bool aEnabled )
この関数は、CCM を使用してデバイスが試されたかどうかを設定します。
詳細 | |||||
---|---|---|---|---|---|
パラメータ |
|
otThreadSetContextIdReuseDelay(OTThreadSetContextIdReuseDelay)
void otThreadSetContextIdReuseDelay( otInstance *aInstance, uint32_t aDelay )
リーダーの役割に使用する CONTEXT_ID_REUSE_Delay パラメータを設定します。
詳細 | |||||
---|---|---|---|---|---|
パラメータ |
|
otThreadGetContextIdReuseDelay
otThreadSetJoinerUdpPort
otError otThreadSetJoinerUdpPort( otInstance *aInstance, uint16_t aJoinerUdpPort )
Joiner UDP ポートを設定します。
詳細 | |||||
---|---|---|---|---|---|
パラメータ |
|
||||
戻り値 |
|
otThreadGetJoinerUdpPort
otThreadSetLocalLeader 重み
void otThreadSetLocalLeaderWeight( otInstance *aInstance, uint8_t aWeight )
リーダーの役割を操作するときに使用する Thread Leader の重みを設定します。
詳細 | |||||
---|---|---|---|---|---|
パラメータ |
|
otThreadGetLeaderWeight
otThreadSetMaxAllowedChildren(OTThreadSetMaxAllowedChildren)
otError otThreadSetMaxAllowedChildren( otInstance *aInstance, uint16_t aMaxChildren )
現在許可されている子の最大数を設定します。
このパラメータは、スレッド プロトコル操作が停止している場合にのみ設定できます。
詳細 | |||||||
---|---|---|---|---|---|---|---|
パラメータ |
|
||||||
戻り値 |
|
otThreadGetMaxAllowedChildren
otThreadSetMaxChildIpAddresses
otError otThreadSetMaxChildIpAddresses( otInstance *aInstance, uint8_t aMaxIpAddresses )
この関数は、各 MTD 子がこのデバイスに親として登録できる IP アドレスの最大数を設定または復元します。
詳細 | |||||
---|---|---|---|---|---|
パラメータ |
|
||||
戻り値 |
|
otThreadGetMaxChildIpAddresses
otThreadSetNetworkIdTimeout(リセット)
void otThreadSetNetworkIdTimeout( otInstance *aInstance, uint8_t aTimeout )
リーダーの役割で使用する NETWORK_ID_TIMEOUT パラメータを設定します。
詳細 | |||||
---|---|---|---|---|---|
パラメータ |
|
otThreadGetNetworkIdTimeout
otThreadSetParentPriority
otError otThreadSetParentPriority( otInstance *aInstance, int8_t aParentPriority )
親の優先度を設定します。
詳細 | |||||
---|---|---|---|---|---|
パラメータ |
|
||||
戻り値 |
|
otThreadGetParentPriority
otThreadSetPreferredLeaderPartitionId
void otThreadSetPreferredLeaderPartitionId( otInstance *aInstance, uint32_t aPartitionId )
リーダーのロールを操作するときに使用する、スレッドのリーダー パーティション ID を設定してください。
詳細 | |||||
---|---|---|---|---|---|
パラメータ |
|
otThreadSetPreferredRouterId
otError otThreadSetPreferredRouterId( otInstance *aInstance, uint8_t aRouterId )
優先するルーター ID を設定します。
ルーターまたはリーダーになると、ノードはこのルーター ID を使用しようとします。優先されるルーター ID が設定されていない場合、または使用できない場合は、ランダムに生成されたルーター ID が選択されます。このプロパティを設定できるのは、デバイスロールが接続解除されているか無効になっている場合のみです。
詳細 | |||||
---|---|---|---|---|---|
パラメータ |
|
||||
戻り値 |
|
otThreadSetPskc
otError otThreadSetPskc( otInstance *aInstance, const otPskc *aPskc )
Thread PSKc を設定します。
この関数は、スレッド プロトコルが無効になっている場合にのみ成功します。この関数の呼び出しが成功すると、不揮発性メモリ内のアクティブおよび保留中のオペレーショナル データセットも無効になります。
詳細 | |||||
---|---|---|---|---|---|
パラメータ |
|
||||
戻り値 |
|
otThreadGetPskc
otThreadSetPskcref
otError otThreadSetPskcRef( otInstance *aInstance, otPskcRef aKeyRef )
Thread PSKc を設定します。
この関数でビルド時の機能 OPENTHREAD_CONFIG_PLATFORM_KEY_REFERENCES_ENABLE
を有効にする必要があります。
この関数は、スレッド プロトコルが無効になっている場合にのみ成功します。この関数の呼び出しが成功すると、不揮発性メモリ内のアクティブおよび保留中のオペレーショナル データセットも無効になります。
詳細 | |||||
---|---|---|---|---|---|
パラメータ |
|
||||
戻り値 |
|
otThreadGetPskcRef
otThreadSetRouterDowngradeThreshold(無視される)
void otThreadSetRouterDowngradeThreshold( otInstance *aInstance, uint8_t aThreshold )
リーダーの役割で使用する ROUTER_DOWNGRADE_THRESHOLD パラメータを設定します。
詳細 | |||||
---|---|---|---|---|---|
パラメータ |
|
otThreadGetRouterDowngradeThreshold
otThreadSetRouter 機能の有効
otError otThreadSetRouterEligible( otInstance *aInstance, bool aEligible )
この関数は、デバイスがルーターに対応しているかどうかを設定します。
aEligible
が false で、デバイスが現在ルーターとして動作している場合、この呼び出しによってデバイスが切断され、子として再接続を試行します。
詳細 | |||||
---|---|---|---|---|---|
パラメータ |
|
||||
戻り値 |
|
otThreadSetRouterIdRange
otError otThreadSetRouterIdRange( otInstance *aInstance, uint8_t aMinRouterId, uint8_t aMaxRouterId )
この関数は、スレッド ネットワーク内のノードへの割り当てを許可するルーター ID の範囲を設定します。
詳細 | |||||||
---|---|---|---|---|---|---|---|
パラメータ |
|
||||||
戻り値 |
|
otThreadGetRouterIdRange
otThreadSetRouterSelectionJitter
void otThreadSetRouterSelectionJitter( otInstance *aInstance, uint8_t aRouterJitter )
REED/Router ロールで使用される ROUTER_SELECTION_JITTER パラメータを設定します。
詳細 | |||||
---|---|---|---|---|---|
パラメータ |
|
otThreadGetRouterSelectionJitter
otThreadSetRouterUpgradeThreshold
void otThreadSetRouterUpgradeThreshold( otInstance *aInstance, uint8_t aThreshold )
リーダーの役割で使用する ROUTER_UPGRADE_THRESHOLD パラメータを設定します。
詳細 | |||||
---|---|---|---|---|---|
パラメータ |
|
otThreadGetRouterUpgradeThreshold
otThreadSetSteeringData
void otThreadSetSteeringData( otInstance *aInstance, const otExtAddress *aExtAddress )
帯域外データの設定。
帯域外ステアリングの設定を有効にするには、設定オプション OPENTHREAD_CONFIG_MLE_STEERING_DATA_SET_OOB_ENABLE
を設定する必要があります。
詳細 | |||||
---|---|---|---|---|---|
パラメータ |
|
otThreadSetThreadVersionCheckEnabled(OTThreadSetThreadVersionCheckEnabled の有効化)
void otThreadSetThreadVersionCheckEnabled( otInstance *aInstance, bool aEnabled )
この関数は、ルーティング用のセキュリティ ポリシー TLV のバージョンしきい値(VR フィールド)を有効にするかどうかを設定します。
詳細 | |||||
---|---|---|---|---|---|
パラメータ |
|
マクロ
[OT_CHILD_IP6_ADDRESS_ITERATOR_INIT]
OT_CHILD_IP6_ADDRESS_ITERATOR_INIT 0
otChildIP6AddressIterator の初期化子。
リソース
OpenThread API リファレンスのトピックは、GitHub で入手可能なソースコードに基づいています。 詳細またはドキュメントへの投稿については、リソースをご覧ください。