Google は、黒人コミュニティのための人種的公平の促進に取り組んでいます。詳細をご覧ください。

全般的

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

概要

ネットワークデータパブリッシャは、ネットワークデータを監視し、エントリを追加または削除するかどうか、またはいつ削除するかを管理することにより、スレッドネットワークデータ内の同様のサービスおよび/またはプレフィックス(メッシュ上のプレフィックスまたは外部ルート)エントリの数を制限するメカニズムを提供します。

このモジュールのすべての機能が必要とOPENTHREAD_CONFIG_NETDATA_PUBLISHER_ENABLE有効にします。

列挙

anonymous enum {
OT_NETWORK_DIAGNOSTIC_TLV_EXT_ADDRESS = 0,
OT_NETWORK_DIAGNOSTIC_TLV_SHORT_ADDRESS = 1,
OT_NETWORK_DIAGNOSTIC_TLV_MODE = 2,
OT_NETWORK_DIAGNOSTIC_TLV_TIMEOUT = 3,
OT_NETWORK_DIAGNOSTIC_TLV_CONNECTIVITY = 4,
OT_NETWORK_DIAGNOSTIC_TLV_ROUTE = 5,
OT_NETWORK_DIAGNOSTIC_TLV_LEADER_DATA = 6,
OT_NETWORK_DIAGNOSTIC_TLV_NETWORK_DATA = 7,
OT_NETWORK_DIAGNOSTIC_TLV_IP6_ADDR_LIST = 8,
OT_NETWORK_DIAGNOSTIC_TLV_MAC_COUNTERS = 9,
OT_NETWORK_DIAGNOSTIC_TLV_BATTERY_LEVEL = 14,
OT_NETWORK_DIAGNOSTIC_TLV_SUPPLY_VOLTAGE = 15,
OT_NETWORK_DIAGNOSTIC_TLV_CHILD_TABLE = 16,
OT_NETWORK_DIAGNOSTIC_TLV_CHANNEL_PAGES = 17,
OT_NETWORK_DIAGNOSTIC_TLV_TYPE_LIST = 18,
OT_NETWORK_DIAGNOSTIC_TLV_MAX_CHILD_TIMEOUT = 19
}
列挙型
otDeviceRole {
OT_DEVICE_ROLE_DISABLED = 0,
OT_DEVICE_ROLE_DETACHED = 1,
OT_DEVICE_ROLE_CHILD = 2,
OT_DEVICE_ROLE_ROUTER = 3,
OT_DEVICE_ROLE_LEADER = 4
}
列挙型
スレッドデバイスの役割を表します。
otNetDataPublisherEvent {
OT_NETDATA_PUBLISHER_EVENT_ENTRY_ADDED = 0,
OT_NETDATA_PUBLISHER_EVENT_ENTRY_REMOVED = 1
}
列挙型
この列挙は、パブリッシャーコールバックから報告されたイベントを表します。
otRoutePreference {
OT_ROUTE_PREFERENCE_LOW = -1,
OT_ROUTE_PREFERENCE_MED = 0,
OT_ROUTE_PREFERENCE_HIGH = 1
}
列挙型
有効な値を定義しmPreferenceotExternalRouteConfigotBorderRouterConfig

Typedef

otBorderRouterConfig typedef
この構造は、ボーダールーター構成を表します。
otExternalRouteConfig typedef
この構造は、外部ルート構成を表します。
otIpCounters typedef
struct otIpCounters
この構造は、IPレベルのカウンターを表します。
otLeaderData typedef
struct otLeaderData
この構造は、スレッドリーダーデータを表します。
otLinkModeConfig typedef
この構造は、MLEリンクモード構成を表します。
otMleCounters typedef
この構造体は、スレッドMLEカウンターを表します。
otNeighborInfoIterator typedef
int16_t
ネイバーテーブルを反復処理するために使用されます。
otNetDataDnsSrpServicePublisherCallback )(otNetDataPublisherEvent aEvent, void *aContext) typedef
void(*
この関数ポインタタイプは、「DNS / SRPサービス」エントリがスレッドネットワークデータに追加またはスレッドネットワークデータから削除されたときに通知するために使用されるコールバックを定義します。
otNetDataPrefixPublisherCallback )(otNetDataPublisherEvent aEvent, const otIp6Prefix *aPrefix, void *aContext) typedef
void(*
この関数ポインタ型は、プレフィックス(オンメッシュまたは外部ルート)エントリがスレッドネットワークデータに追加またはスレッドネットワークデータから削除されたときに通知するために使用されるコールバックを定義します。
otNetDataPublisherEvent typedef
この列挙は、パブリッシャーコールバックから報告されたイベントを表します。
otNetworkDataIterator typedef
uint32_t
ネットワークデータ情報を反復処理するために使用されます。
otNetworkDiagChildEntry typedef
この構造は、ネットワーク診断の子テーブルエントリを表します。
otNetworkDiagConnectivity typedef
この構造は、ネットワーク診断接続の値を表します。
otNetworkDiagIterator typedef
uint16_t
ネットワーク診断TLVを反復処理するために使用されます。
otNetworkDiagMacCounters typedef
この構造は、ネットワーク診断Macカウンターの値を表します。
otNetworkDiagRoute typedef
この構造は、ネットワーク診断ルートのTLV値を表します。
otNetworkDiagRouteData typedef
この構造は、ネットワーク診断ルートデータを表します。
otNetworkDiagTlv typedef
この構造は、ネットワーク診断TLVを表します。
otReceiveDiagnosticGetCallback )(otError aError, otMessage *aMessage, const otMessageInfo *aMessageInfo, void *aContext) typedef
void(*
この関数ポインタは、Network DiagnosticGet応答を受信したときに呼び出されます。
otRoutePreference typedef
有効な値を定義しmPreferenceotExternalRouteConfigotBorderRouterConfig
otServerConfig typedef
この構造は、サーバー構成を表します。
otServiceConfig typedef
この構造は、サービス構成を表します。
otThreadAnycastLocatorCallback )(void *aContext, otError aError, const otIp6Address *aMeshLocalAddress, uint16_t aRloc16) typedef
void(*
この関数ポインタタイプの結果を通知するためのコールバック定義otThreadLocateAnycastDestination()リクエストを。
otThreadDiscoveryRequestCallback )(const otThreadDiscoveryRequestInfo *aInfo, void *aContext) typedef
void(*
この関数ポインターは、MLEディスカバリー要求メッセージが受信されるたびに呼び出されます。
otThreadDiscoveryRequestInfo typedef
この構造は、スレッド検出要求データを表します。
otThreadParentResponseCallback )(otThreadParentResponseInfo *aInfo, void *aContext) typedef
void(*
この関数ポインタは、MLE親応答メッセージを受信するたびに呼び出されます。
otThreadParentResponseInfo typedef
この構造は、MLE親応答データを表します。

関数

otNetDataGet ( otInstance *aInstance, bool aStable, uint8_t *aData, uint8_t *aDataLength)
このメソッドは、パーティションのスレッドネットワークデータの完全または安定したコピーを提供します。
otNetDataGetNextOnMeshPrefix ( otInstance *aInstance, otNetworkDataIterator *aIterator, otBorderRouterConfig *aConfig)
この関数は、パーティションのネットワークデータで次のオンメッシュプレフィックスを取得します。
otNetDataGetNextRoute ( otInstance *aInstance, otNetworkDataIterator *aIterator, otExternalRouteConfig *aConfig)
この関数は、パーティションのネットワークデータ内の次の外部ルートを取得します。
otNetDataGetNextService ( otInstance *aInstance, otNetworkDataIterator *aIterator, otServiceConfig *aConfig)
この関数は、パーティションのネットワークデータで次のサービスを取得します。
otNetDataGetStableVersion ( otInstance *aInstance)
uint8_t
安定したネットワークデータバージョンを取得します。
otNetDataGetVersion ( otInstance *aInstance)
uint8_t
ネットワークデータバージョンを取得します。
otNetDataIsDnsSrpServiceAdded ( otInstance *aInstance)
bool
この関数は、現在「DNS / SRPサービス」エントリがスレッドネットワークデータに追加されているかどうかを示します。
otNetDataIsPrefixAdded ( otInstance *aInstance, const otIp6Prefix *aPrefix)
bool
この関数は、現在公開されているプレフィックスエントリ(オンメッシュまたは外部ルート)がスレッドネットワークデータに追加されているかどうかを示します。
otNetDataPublishDnsSrpServiceAnycast ( otInstance *aInstance, uint8_t aSequenceNUmber)
void
この関数は、「DNS / SRPサービスエニーキャストアドレス」をスレッドネットワークデータに公開するように要求します。
otNetDataPublishDnsSrpServiceUnicast ( otInstance *aInstance, const otIp6Address *aAddress, uint16_t aPort)
void
この関数は、「DNS / SRPサービスユニキャストアドレス」をスレッドネットワークデータに公開するように要求します。
otNetDataPublishDnsSrpServiceUnicastMeshLocalEid ( otInstance *aInstance, uint16_t aPort)
void
この関数は、「DNS / SRPサービスユニキャストアドレス」をスレッドネットワークデータに公開するように要求します。
otNetDataPublishExternalRoute ( otInstance *aInstance, const otExternalRouteConfig *aConfig)
この関数は、外部ルートプレフィックスをスレッドネットワークデータに公開するように要求します。
otNetDataPublishOnMeshPrefix ( otInstance *aInstance, const otBorderRouterConfig *aConfig)
この関数は、メッシュ上のプレフィックスをスレッドネットワークデータで公開するように要求します。
otNetDataSetDnsSrpServicePublisherCallback ( otInstance *aInstance, otNetDataDnsSrpServicePublisherCallback aCallback, void *aContext)
void
この関数は、公開された「DNS / SRPサービス」が実際にスレッドネットワークデータに追加またはスレッドネットワークデータから削除されたときに通知するためのコールバックを設定します。
otNetDataSetPrefixPublisherCallback ( otInstance *aInstance, otNetDataPrefixPublisherCallback aCallback, void *aContext)
void
この関数は、公開されたプレフィックスエントリが実際にスレッドネットワークデータに追加またはスレッドネットワークデータから削除されたことを通知するためのコールバックを設定します。
otNetDataSteeringDataCheckJoiner ( otInstance *aInstance, const otExtAddress *aEui64)
ステアリングデータにジョイナが含まれているかどうかを確認します。
otNetDataSteeringDataCheckJoinerWithDiscerner ( otInstance *aInstance, const struct otJoinerDiscerner *aDiscerner)
ステアリングデータに、特定の識別値を持つジョイナが含まれているかどうかを確認します。
otNetDataUnpublishDnsSrpService ( otInstance *aInstance)
void
この関数は、以前に追加された「DNS / SRP(AnycastまたはUnicast)サービス」エントリをスレッドネットワークデータから非公開にします。
otNetDataUnpublishPrefix ( otInstance *aInstance, const otIp6Prefix *aPrefix)
この関数は、以前に公開されたプレフィックス(メッシュ上または外部ルート)を公開解除します。
otThreadBecomeChild ( otInstance *aInstance)
子供の頃に再アタッチしてみてください。
otThreadBecomeDetached ( otInstance *aInstance)
スレッドネットワークから切り離します。
otThreadDeviceRoleToString ( otDeviceRole aRole)
const char *
デバイスの役割を人間が読める文字列に変換します。
otThreadDiscover ( otInstance *aInstance, uint32_t aScanChannels, uint16_t aPanId, bool aJoiner, bool aEnableEui64Filtering, otHandleActiveScanResult aCallback, void *aCallbackContext)
この関数は、スレッド検出スキャンを開始します。
otThreadGetChildTimeout ( otInstance *aInstance)
uint32_t
子ロールで操作するときに使用されるスレッド子タイムアウトを取得します。
otThreadGetDeviceRole ( otInstance *aInstance)
デバイスの役割を取得します。
otThreadGetDomainName ( otInstance *aInstance)
const char *
スレッドドメイン名を取得します。
otThreadGetExtendedPanId ( otInstance *aInstance)
IEEE802.15.4拡張PANIDを取得します。
otThreadGetFixedDuaInterfaceIdentifier ( otInstance *aInstance)
スレッドドメインユニキャストアドレスに手動で指定されたインターフェイス識別子を取得します。
otThreadGetIp6Counters ( otInstance *aInstance)
const otIpCounters *
IPv6カウンターを取得します。
otThreadGetKeySequenceCounter ( otInstance *aInstance)
uint32_t
thrKeySequenceCounterを取得します。
otThreadGetKeySwitchGuardTime ( otInstance *aInstance)
uint32_t
thrKeySwitchGuardTimeを取得します。
otThreadGetLeaderData ( otInstance *aInstance, otLeaderData *aLeaderData)
この関数は、スレッドリーダーデータを取得します。
otThreadGetLeaderRloc ( otInstance *aInstance, otIp6Address *aLeaderRloc)
この関数は、リーダーのRLOCへのポインターを返します。
otThreadGetLeaderRouterId ( otInstance *aInstance)
uint8_t
リーダーのルーターIDを取得します。
otThreadGetLeaderWeight ( otInstance *aInstance)
uint8_t
リーダーの体重を取得します。
otThreadGetLinkLocalAllThreadNodesMulticastAddress ( otInstance *aInstance)
const otIp6Address *
この関数は、スレッドリンクローカルのすべてのスレッドノードのマルチキャストアドレスを返します。
otThreadGetLinkLocalIp6Address ( otInstance *aInstance)
const otIp6Address *
この関数は、スレッドリンクローカルIPv6アドレスを返します。
otThreadGetLinkMode ( otInstance *aInstance)
MLEリンクモード構成を取得します。
otThreadGetMeshLocalEid ( otInstance *aInstance)
const otIp6Address *
この関数は、メッシュローカルEIDアドレスへのポインタを返します。
otThreadGetMeshLocalPrefix ( otInstance *aInstance)
この関数は、メッシュローカルプレフィックスへのポインタを返します。
otThreadGetMleCounters ( otInstance *aInstance)
const otMleCounters *
スレッドMLEカウンターを取得します。
otThreadGetNetworkKey ( otInstance *aInstance, otNetworkKey *aNetworkKey)
void
スレッドネットワークキーを取得します。
otThreadGetNetworkKeyRef ( otInstance *aInstance)
取得otNetworkKeyRefスレッドネットワークキーのために。
otThreadGetNetworkName ( otInstance *aInstance)
const char *
スレッドネットワーク名を取得します。
otThreadGetNextDiagnosticTlv (const otMessage *aMessage, otNetworkDiagIterator *aIterator, otNetworkDiagTlv *aNetworkDiagTlv)
この関数は、メッセージ内の次のネットワーク診断TLVを取得します。
otThreadGetNextNeighborInfo ( otInstance *aInstance, otNeighborInfoIterator *aIterator, otNeighborInfo *aInfo)
この関数は、次のネイバー情報を取得します。
otThreadGetParentAverageRssi ( otInstance *aInstance, int8_t *aParentRssi)
この関数は、スレッドの親の平均RSSIを取得します。
otThreadGetParentInfo ( otInstance *aInstance, otRouterInfo *aParentInfo)
この関数は、スレッドルーターの診断情報を親として取得します。
otThreadGetParentLastRssi ( otInstance *aInstance, int8_t *aLastRssi)
この関数は、スレッドの親から最後のパケットのRSSIを取得します。
otThreadGetPartitionId ( otInstance *aInstance)
uint32_t
パーティションIDを取得します。
otThreadGetRealmLocalAllThreadNodesMulticastAddress ( otInstance *aInstance)
const otIp6Address *
この関数は、スレッドレルム-ローカルのすべてのスレッドノードのマルチキャストアドレスを返します。
otThreadGetRloc ( otInstance *aInstance)
const otIp6Address *
この関数は、スレッドルーティングロケーター(RLOC)アドレスへのポインターを返します。
otThreadGetRloc16 ( otInstance *aInstance)
uint16_t
RLOC16を入手してください。
otThreadGetServiceAloc ( otInstance *aInstance, uint8_t aServiceId, otIp6Address *aServiceAloc)
この関数は、指定されたサービスIDのサービスALOCを取得します。
otThreadGetVersion (void)
uint16_t
この関数は、スレッドプロトコルバージョンを取得します。
otThreadIsAnycastLocateInProgress ( otInstance *aInstance)
bool
この関数は、エニーキャスト検索要求が現在進行中であるかどうかを示します。
otThreadIsDiscoverInProgress ( otInstance *aInstance)
bool
この関数は、MLEスレッド検出が現在進行中であるかどうかを判別します。
otThreadIsSingleton ( otInstance *aInstance)
bool
この関数は、ノードがネットワーク上の唯一のルーターであるかどうかを示します。
otThreadLocateAnycastDestination ( otInstance *aInstance, const otIp6Address *aAnycastAddress, otThreadAnycastLocatorCallback aCallback, void *aContext)
この関数は、指定されたエニーキャストアドレスの最も近い宛先を見つけるように要求します。
otThreadRegisterParentResponseCallback ( otInstance *aInstance, otThreadParentResponseCallback aCallback, void *aContext)
void
この関数は、MLE親応答データを受信するためのコールバックを登録します。
otThreadResetIp6Counters ( otInstance *aInstance)
void
IPv6カウンターをリセットします。
otThreadResetMleCounters ( otInstance *aInstance)
void
スレッドMLEカウンターをリセットします。
otThreadSendAddressNotification ( otInstance *aInstance, otIp6Address *aDestination, otIp6Address *aTarget, otIp6InterfaceIdentifier *aMlIid)
void
この関数は、プロアクティブアドレス通知(ADDR_NTF.ntf)メッセージを送信します。
otThreadSendDiagnosticGet ( otInstance *aInstance, const otIp6Address *aDestination, const uint8_t aTlvTypes[], uint8_t aCount, otReceiveDiagnosticGetCallback aCallback, void *aCallbackContext)
ネットワーク診断取得要求を送信します。
otThreadSendDiagnosticReset ( otInstance *aInstance, const otIp6Address *aDestination, const uint8_t aTlvTypes[], uint8_t aCount)
ネットワーク診断リセット要求を送信します。
otThreadSendProactiveBackboneNotification ( otInstance *aInstance, otIp6Address *aTarget, otIp6InterfaceIdentifier *aMlIid, uint32_t aTimeSinceLastTransaction)
この関数は、バックボーンリンクでプロアクティブバックボーン通知(PRO_BB.ntf)メッセージを送信します。
otThreadSetChildTimeout ( otInstance *aInstance, uint32_t aTimeout)
void
子ロールで操作するときに使用されるスレッド子タイムアウトを設定します。
otThreadSetDiscoveryRequestCallback ( otInstance *aInstance, otThreadDiscoveryRequestCallback aCallback, void *aContext)
void
この関数は、MLEディスカバリー要求データを受信するためのコールバックを設定します。
otThreadSetDomainName ( otInstance *aInstance, const char *aDomainName)
スレッドドメイン名を設定します。
otThreadSetEnabled ( otInstance *aInstance, bool aEnabled)
この関数は、スレッドプロトコル操作を開始します。
otThreadSetExtendedPanId ( otInstance *aInstance, const otExtendedPanId *aExtendedPanId)
IEEE802.15.4拡張PANIDを設定します。
otThreadSetFixedDuaInterfaceIdentifier ( otInstance *aInstance, const otIp6InterfaceIdentifier *aIid)
スレッドドメインユニキャストアドレスに手動で指定されたインターフェイス識別子を設定/クリアします。
otThreadSetJoinerAdvertisement ( otInstance *aInstance, uint32_t aOui, const uint8_t *aAdvData, uint8_t aAdvDataLength)
このメソッドは、スレッドネットワークを検出するときにスレッドジョイナーアドバタイズメントを設定します。
otThreadSetKeySequenceCounter ( otInstance *aInstance, uint32_t aKeySequenceCounter)
void
thrKeySequenceCounterを設定します。
otThreadSetKeySwitchGuardTime ( otInstance *aInstance, uint32_t aKeySwitchGuardTime)
void
thrKeySwitchGuardTimeを設定します。
otThreadSetLinkMode ( otInstance *aInstance, otLinkModeConfig aConfig)
MLEリンクモード構成を設定します。
otThreadSetMeshLocalPrefix ( otInstance *aInstance, const otMeshLocalPrefix *aMeshLocalPrefix)
この関数は、メッシュローカルプレフィックスを設定します。
otThreadSetNetworkKey ( otInstance *aInstance, const otNetworkKey *aKey)
スレッドネットワークキーを設定します。
otThreadSetNetworkKeyRef ( otInstance *aInstance, otNetworkKeyRef aKeyRef)
スレッドネットワークキーを設定しotNetworkKeyRef
otThreadSetNetworkName ( otInstance *aInstance, const char *aNetworkName)
スレッドネットワーク名を設定します。

構造体

otBorderRouterConfig

この構造は、ボーダールーター構成を表します。

otExternalRouteConfig

この構造は、外部ルート構成を表します。

otIpCounters

この構造は、IPレベルのカウンターを表します。

otLeaderData

この構造は、スレッドリーダーデータを表します。

otLinkModeConfig

この構造は、MLEリンクモード構成を表します。

otMleCounters

この構造体は、スレッドMLEカウンターを表します。

otNeighborInfo

この構造体は、隣接するスレッドノードの診断情報を保持します。

otNetworkDiagChildEntry

この構造は、ネットワーク診断の子テーブルエントリを表します。

otNetworkDiagConnectivity

この構造は、ネットワーク診断接続の値を表します。

otNetworkDiagMacCounters

この構造は、ネットワーク診断Macカウンターの値を表します。

otNetworkDiagRoute

この構造は、ネットワーク診断ルートのTLV値を表します。

otNetworkDiagRouteData

この構造は、ネットワーク診断ルートデータを表します。

otNetworkDiagTlv

この構造は、ネットワーク診断TLVを表します。

otRouterInfo

この構造体は、スレッドルーターの診断情報を保持します。

otServerConfig

この構造は、サーバー構成を表します。

otServiceConfig

この構造は、サービス構成を表します。

otThreadDiscoveryRequestInfo

この構造は、スレッド検出要求データを表します。

otThreadParentResponseInfo

この構造は、MLE親応答データを表します。

列挙

匿名列挙型

 anonymous enum
プロパティ
OT_NETWORK_DIAGNOSTIC_TLV_BATTERY_LEVEL

バッテリーレベルTLV。

OT_NETWORK_DIAGNOSTIC_TLV_CHANNEL_PAGES

チャネルページTLV。

OT_NETWORK_DIAGNOSTIC_TLV_CHILD_TABLE

子テーブルTLV。

OT_NETWORK_DIAGNOSTIC_TLV_CONNECTIVITY

接続TLV。

OT_NETWORK_DIAGNOSTIC_TLV_EXT_ADDRESS

MAC拡張アドレスTLV。

OT_NETWORK_DIAGNOSTIC_TLV_IP6_ADDR_LIST

IPv6アドレスリストTLV。

OT_NETWORK_DIAGNOSTIC_TLV_LEADER_DATA

リーダーデータTLV。

OT_NETWORK_DIAGNOSTIC_TLV_MAC_COUNTERS

MACカウンターTLV。

OT_NETWORK_DIAGNOSTIC_TLV_MAX_CHILD_TIMEOUT

最大子タイムアウトTLV。

OT_NETWORK_DIAGNOSTIC_TLV_MODE

モードTLV。

OT_NETWORK_DIAGNOSTIC_TLV_NETWORK_DATA

ネットワークデータTLV。

OT_NETWORK_DIAGNOSTIC_TLV_ROUTE

Route64TLV。

OT_NETWORK_DIAGNOSTIC_TLV_SHORT_ADDRESS

アドレス16TLV。

OT_NETWORK_DIAGNOSTIC_TLV_SUPPLY_VOLTAGE

供給電圧TLV。

OT_NETWORK_DIAGNOSTIC_TLV_TIMEOUT

タイムアウトTLV(SEDの最大ポーリング期間)

OT_NETWORK_DIAGNOSTIC_TLV_TYPE_LIST

タイプリストTLV。

otDeviceRole

 otDeviceRole

スレッドデバイスの役割を表します。

プロパティ
OT_DEVICE_ROLE_CHILD

スレッドの子の役割。

OT_DEVICE_ROLE_DETACHED

現在、スレッドネットワーク/パーティションに参加していません。

OT_DEVICE_ROLE_DISABLED

スレッドスタックは無効になっています。

OT_DEVICE_ROLE_LEADER

スレッドリーダーの役割。

OT_DEVICE_ROLE_ROUTER

スレッドルーターの役割。

otNetDataPublisherEvent

 otNetDataPublisherEvent

この列挙は、パブリッシャーコールバックから報告されたイベントを表します。

プロパティ
OT_NETDATA_PUBLISHER_EVENT_ENTRY_ADDED

公開されたエントリがスレッドネットワークデータに追加されます。

OT_NETDATA_PUBLISHER_EVENT_ENTRY_REMOVED

公開されたエントリは、スレッドネットワークデータから削除されます。

otRoutePreference

 otRoutePreference

有効な値を定義しmPreferenceotExternalRouteConfigotBorderRouterConfig

プロパティ
OT_ROUTE_PREFERENCE_HIGH

ルートの優先度が高い。

OT_ROUTE_PREFERENCE_LOW

ルートの優先度が低い。

OT_ROUTE_PREFERENCE_MED

中程度のルート設定。

Typedef

otBorderRouterConfig

struct otBorderRouterConfig otBorderRouterConfig

この構造は、ボーダールーター構成を表します。

otExternalRouteConfig

struct otExternalRouteConfig otExternalRouteConfig

この構造は、外部ルート構成を表します。

otIpCounters

struct otIpCounters otIpCounters

この構造は、IPレベルのカウンターを表します。

otLeaderData

struct otLeaderData otLeaderData

この構造は、スレッドリーダーデータを表します。

otLinkModeConfig

struct otLinkModeConfig otLinkModeConfig

この構造は、MLEリンクモード構成を表します。

otMleCounters

struct otMleCounters otMleCounters

この構造体は、スレッドMLEカウンターを表します。

otNeighborInfoIterator

int16_t otNeighborInfoIterator

ネイバーテーブルを反復処理するために使用されます。

otNetDataDnsSrpServicePublisherCallback

void(* otNetDataDnsSrpServicePublisherCallback)(otNetDataPublisherEvent aEvent, void *aContext)

この関数ポインタタイプは、「DNS / SRPサービス」エントリがスレッドネットワークデータに追加またはスレッドネットワークデータから削除されたときに通知するために使用されるコールバックを定義します。

削除にコールバックは、エントリがによって除去されているかどうかとは無関係に呼び出されたPublisher (例えば、あまりにも多くの類似したネットワークデータ内にすでに存在するエントリがある場合)、エントリを非公開にするか、明示的な呼び出しによっては(すなわち、への呼び出しotNetDataUnpublishDnsSrpService() )。

詳細
パラメーター
[in] aEvent
イベントを示します(エントリが追加されたか削除されたか)。
[in] aContext
アプリケーション固有のコンテキストへのポインタ。

otNetDataPrefixPublisherCallback

void(* otNetDataPrefixPublisherCallback)(otNetDataPublisherEvent aEvent, const otIp6Prefix *aPrefix, void *aContext)

この関数ポインタ型は、プレフィックス(オンメッシュまたは外部ルート)エントリがスレッドネットワークデータに追加またはスレッドネットワークデータから削除されたときに通知するために使用されるコールバックを定義します。

削除にコールバックは、エントリがによって除去されているかどうかとは無関係に呼び出されたPublisher (例えば、すでにネットワークデータに存在する非常に多くの類似したエントリがある場合)またはエントリーを非公開にするには明示的な呼び出しては。

詳細
パラメーター
[in] aEvent
イベントを示します(エントリが追加されたか削除されたか)。
[in] aPrefix
プレフィックスエントリへのポインタ。
[in] aContext
アプリケーション固有のコンテキストへのポインタ。

otNetDataPublisherEvent

enum otNetDataPublisherEvent otNetDataPublisherEvent

この列挙は、パブリッシャーコールバックから報告されたイベントを表します。

otNetworkDataIterator

uint32_t otNetworkDataIterator

ネットワークデータ情報を反復処理するために使用されます。

otNetworkDiagChildEntry

struct otNetworkDiagChildEntry otNetworkDiagChildEntry

この構造は、ネットワーク診断の子テーブルエントリを表します。

otNetworkDiagConnectivity

struct otNetworkDiagConnectivity otNetworkDiagConnectivity

この構造は、ネットワーク診断接続の値を表します。

otNetworkDiagIterator

uint16_t otNetworkDiagIterator

ネットワーク診断TLVを反復処理するために使用されます。

otNetworkDiagMacCounters

struct otNetworkDiagMacCounters otNetworkDiagMacCounters

この構造は、ネットワーク診断Macカウンターの値を表します。

参照してください。 RFC 2863メンバフィールドの定義について。

otNetworkDiagRoute

struct otNetworkDiagRoute otNetworkDiagRoute

この構造は、ネットワーク診断ルートのTLV値を表します。

otNetworkDiagRouteData

struct otNetworkDiagRouteData otNetworkDiagRouteData

この構造は、ネットワーク診断ルートデータを表します。

otNetworkDiagTlv

struct otNetworkDiagTlv otNetworkDiagTlv

この構造は、ネットワーク診断TLVを表します。

otReceiveDiagnosticGetCallback

void(* otReceiveDiagnosticGetCallback)(otError aError, otMessage *aMessage, const otMessageInfo *aMessageInfo, void *aContext)

この関数ポインタは、Network DiagnosticGet応答を受信したときに呼び出されます。

詳細
パラメーター
[in] aError
応答の取得に失敗したときのエラー。
[in] aMessage
受信したNetworkDiagnosticGet応答ペイロードを含むメッセージバッファへのポインタ。場合にのみ使用できaErrorあるOT_ERROR_NONE
[in] aMessageInfo
以下のためのメッセージ情報へのポインタaMessage 。場合にのみ使用できaErrorあるOT_ERROR_NONE
[in] aContext
アプリケーション固有のコンテキストへのポインタ。

otRoutePreference

enum otRoutePreference otRoutePreference

有効な値を定義しmPreferenceotExternalRouteConfigotBorderRouterConfig

otServerConfig

struct otServerConfig otServerConfig

この構造は、サーバー構成を表します。

otServiceConfig

struct otServiceConfig otServiceConfig

この構造は、サービス構成を表します。

otThreadAnycastLocatorCallback

void(* otThreadAnycastLocatorCallback)(void *aContext, otError aError, const otIp6Address *aMeshLocalAddress, uint16_t aRloc16)

この関数ポインタタイプの結果を通知するためのコールバック定義otThreadLocateAnycastDestination()リクエストを。

詳細
パラメーター
[in] aContext
任意のコンテキストへのポインタ(コールバックが登録されたときに提供されます)。
[in] aError
リクエスト処理時のエラー。 OT_ERROR_NONEは成功を示します。 OT_ERROR_RESPONSE_TIMEOUTは、宛先が見つからなかったことを示します。 OT_ERROR_ABORTは、要求が中止されたことを示します。
[in] aMeshLocalAddress
エニーキャストアドレスの最も近い目的地のメッシュローカルEIDへのポインタaError OT_ERROR_NONEで、NULLさもなければ。
[in] aRloc16
見つかった場合は宛先のRLOC16、それ以外の場合は無効なRLOC16(0xfffe)。

otThreadDiscoveryRequestCallback

void(* otThreadDiscoveryRequestCallback)(const otThreadDiscoveryRequestInfo *aInfo, void *aContext)

この関数ポインターは、MLEディスカバリー要求メッセージが受信されるたびに呼び出されます。

詳細
パラメーター
[in] aInfo
ディスカバリー要求情報データへのポインター。
[in] aContext
コールバックアプリケーション固有のコンテキストへのポインタ。

otThreadDiscoveryRequestInfo

struct otThreadDiscoveryRequestInfo otThreadDiscoveryRequestInfo

この構造は、スレッド検出要求データを表します。

otThreadParentResponseCallback

void(* otThreadParentResponseCallback)(otThreadParentResponseInfo *aInfo, void *aContext)

この関数ポインタは、MLE親応答メッセージを受信するたびに呼び出されます。

詳細
パラメーター
[in] aStats
統計データを保持するスタック上の場所へのポインター。
[in] aContext
コールバッククライアント固有のコンテキストへのポインタ。

otThreadParentResponseInfo

struct otThreadParentResponseInfo otThreadParentResponseInfo

この構造は、MLE親応答データを表します。

関数

otNetDataGet

otError otNetDataGet(
  otInstance *aInstance,
  bool aStable,
  uint8_t *aData,
  uint8_t *aDataLength
)

このメソッドは、パーティションのスレッドネットワークデータの完全または安定したコピーを提供します。

詳細
パラメーター
[in] aInstance
OpenThreadインスタンスへのポインタ。
[in] aStable
安定バージョンをコピーする場合はTRUE、フルバージョンをコピーする場合はFALSE。
[out] aData
データバッファへのポインタ。
[in,out] aDataLength
エントリでは、データバッファのサイズは、によって指さaData 。終了時に、コピーされたバイト数。

otNetDataGetNextOnMeshPrefix

otError otNetDataGetNextOnMeshPrefix(
  otInstance *aInstance,
  otNetworkDataIterator *aIterator,
  otBorderRouterConfig *aConfig
)

この関数は、パーティションのネットワークデータで次のオンメッシュプレフィックスを取得します。

詳細
パラメーター
[in] aInstance
OpenThreadインスタンスへのポインタ。
[in,out] aIterator
ネットワークデータイテレータコンテキストへのポインタ。最初のオンメッシュエントリを取得するには、OT_NETWORK_DATA_ITERATOR_INITに設定する必要があります。
[out] aConfig
オンメッシュプレフィックス情報が配置される場所へのポインタ。
戻り値
OT_ERROR_NONE
次のOnMeshプレフィックスが正常に見つかりました。
OT_ERROR_NOT_FOUND
後続のOnMeshプレフィックスはスレッドネットワークデータに存在しません。

otNetDataGetNextRoute

otError otNetDataGetNextRoute(
  otInstance *aInstance,
  otNetworkDataIterator *aIterator,
  otExternalRouteConfig *aConfig
)

この関数は、パーティションのネットワークデータ内の次の外部ルートを取得します。

詳細
パラメーター
[in] aInstance
OpenThreadインスタンスへのポインタ。
[in,out] aIterator
ネットワークデータイテレータコンテキストへのポインタ。最初の外部ルートエントリを取得するには、OT_NETWORK_DATA_ITERATOR_INITに設定する必要があります。
[out] aConfig
外部ルート情報が配置される場所へのポインタ。
戻り値
OT_ERROR_NONE
次の外部ルートが正常に見つかりました。
OT_ERROR_NOT_FOUND
スレッドネットワークデータには、後続の外部ルートエントリは存在しません。

otNetDataGetNextService

otError otNetDataGetNextService(
  otInstance *aInstance,
  otNetworkDataIterator *aIterator,
  otServiceConfig *aConfig
)

この関数は、パーティションのネットワークデータで次のサービスを取得します。

詳細
パラメーター
[in] aInstance
OpenThreadインスタンスへのポインタ。
[in,out] aIterator
ネットワークデータイテレータコンテキストへのポインタ。最初のサービスエントリを取得するには、OT_NETWORK_DATA_ITERATOR_INITに設定する必要があります。
[out] aConfig
サービス情報が配置される場所へのポインター。
戻り値
OT_ERROR_NONE
次のサービスが正常に見つかりました。
OT_ERROR_NOT_FOUND
パーティションのネットワークデータに後続のサービスは存在しません。

otNetDataGetStableVersion

uint8_t otNetDataGetStableVersion(
  otInstance *aInstance
)

安定したネットワークデータバージョンを取得します。

詳細
パラメーター
[in] aInstance
OpenThreadインスタンスへのポインタ。
戻り値
安定したネットワークデータバージョン。

otNetDataGetVersion

uint8_t otNetDataGetVersion(
  otInstance *aInstance
)

ネットワークデータバージョンを取得します。

詳細
パラメーター
[in] aInstance
OpenThreadインスタンスへのポインタ。
戻り値
ネットワークデータバージョン。

otNetDataIsDnsSrpServiceAdded

bool otNetDataIsDnsSrpServiceAdded(
  otInstance *aInstance
)

この関数は、現在「DNS / SRPサービス」エントリがスレッドネットワークデータに追加されているかどうかを示します。

この機能は、機能が必要ですOPENTHREAD_CONFIG_TMF_NETDATA_SERVICE_ENABLE有効にすることを。

詳細
パラメーター
[in] aInstance
OpenThreadインスタンスへのポインタ。
戻り値
TRUE
公開されたDNS / SRPサービスエントリがスレッドネットワークデータに追加されます。
FALSE
エントリがスレッドネットワークデータに追加されていないか、公開するエントリがありません。

otNetDataIsPrefixAdded

bool otNetDataIsPrefixAdded(
  otInstance *aInstance,
  const otIp6Prefix *aPrefix
)

この関数は、現在公開されているプレフィックスエントリ(オンメッシュまたは外部ルート)がスレッドネットワークデータに追加されているかどうかを示します。

この機能は、機能が必要ですOPENTHREAD_CONFIG_BORDER_ROUTER_ENABLE有効にすることを。

詳細
パラメーター
[in] aInstance
OpenThreadインスタンスへのポインタ。
[in] aPrefix
プレフィックスへのポインタ(NULLであってはなりません)。
戻り値
TRUE
公開されたプレフィックスエントリがスレッドネットワークデータに追加されます。
FALSE
エントリがスレッドネットワークデータに追加されていないか、公開するエントリがありません。

otNetDataPublishDnsSrpServiceAnycast

void otNetDataPublishDnsSrpServiceAnycast(
  otInstance *aInstance,
  uint8_t aSequenceNUmber
)

この関数は、「DNS / SRPサービスエニーキャストアドレス」をスレッドネットワークデータに公開するように要求します。

この機能は、機能が必要ですOPENTHREAD_CONFIG_TMF_NETDATA_SERVICE_ENABLE有効にすることを。

この関数への呼び出しは、(任意の以前の呼び出しから公開されていた以前の「DNS / SRPサービス」エントリ削除と置換するotNetDataPublishDnsSrpService{Type}()関数)。

詳細
パラメーター
[in] aInstance
OpenThreadインスタンスへのポインタ。
[in] aSequenceNUmber
DNS / SRPエニーキャストサービスのシーケンス番号。

otNetDataPublishDnsSrpServiceUnicast

void otNetDataPublishDnsSrpServiceUnicast(
  otInstance *aInstance,
  const otIp6Address *aAddress,
  uint16_t aPort
)

この関数は、「DNS / SRPサービスユニキャストアドレス」をスレッドネットワークデータに公開するように要求します。

この機能は、機能が必要ですOPENTHREAD_CONFIG_TMF_NETDATA_SERVICE_ENABLE有効にすることを。

この関数への呼び出しは、(任意の以前の呼び出しから公開されていた以前の「DNS / SRPサービス」エントリ削除と置換するotNetDataPublishDnsSrpService{Type}()関数)。

この機能は、サービスTLVデータにアドレスとポート情報を含めることにより、「DNS / SRPサービスユニキャストアドレス」を公開します。

詳細
パラメーター
[in] aInstance
OpenThreadインスタンスへのポインタ。
[in] aAddress
公開するDNS / SRPサーバーアドレス(NULLであってはなりません)。
[in] aPort
公開するSRPサーバーのポート番号。

otNetDataPublishDnsSrpServiceUnicastMeshLocalEid

void otNetDataPublishDnsSrpServiceUnicastMeshLocalEid(
  otInstance *aInstance,
  uint16_t aPort
)

この関数は、「DNS / SRPサービスユニキャストアドレス」をスレッドネットワークデータに公開するように要求します。

この機能は、機能が必要ですOPENTHREAD_CONFIG_TMF_NETDATA_SERVICE_ENABLE有効にすることを。

この関数への呼び出しは、(任意の以前の呼び出しから公開されていた以前の「DNS / SRPサービス」エントリ削除と置換するotNetDataPublishDnsSrpService{Type}()関数)。

異なりotNetDataPublishDnsSrpServiceUnicast()与えられたことが発表されたアドレスを必要とし、サービスTLVデータ内の情報が含まれ、この機能は、デバイスのメッシュローカルEIDを使用し、サーバーTLVデータ内の情報を含んでいます。

詳細
パラメーター
[in] aInstance
OpenThreadインスタンスへのポインタ。
[in] aPort
公開するSRPサーバーのポート番号。

otNetDataPublishExternalRoute

otError otNetDataPublishExternalRoute(
  otInstance *aInstance,
  const otExternalRouteConfig *aConfig
)

この関数は、外部ルートプレフィックスをスレッドネットワークデータに公開するように要求します。

この機能は、機能が必要ですOPENTHREAD_CONFIG_BORDER_ROUTER_ENABLE有効にすることを。

唯一の安定したエントリは(すなわち、公開することができaConfig.mStable真でなければなりません)。

詳細
パラメーター
[in] aInstance
OpenThreadインスタンスへのポインタ。
[in] aConfig
公開する外部ルート構成(NULLであってはなりません)。
戻り値
OT_ERROR_NONE
外部ルートが正常に公開されました。
OT_ERROR_INVALID_ARGS
aConfig有効な(悪い接頭辞、無効なフラグの組み合わせ、または安定しない)ではありません。
OT_ERROR_ALREADY
同じプレフィックスを持つエントリは、すでに公開リストにあります。
OT_ERROR_NO_BUFS
新しいリクエストのエントリを割り当てることができませんでした。パブリッシャは、設定によって決定(オンメッシュプレフィックスと外部経路との間で共有される)エントリの限られた数のサポートOPENTHREAD_CONFIG_NETDATA_PUBLISHER_MAX_PREFIX_ENTRIES

otNetDataPublishOnMeshPrefix

otError otNetDataPublishOnMeshPrefix(
  otInstance *aInstance,
  const otBorderRouterConfig *aConfig
)

この関数は、メッシュ上のプレフィックスをスレッドネットワークデータで公開するように要求します。

この機能は、機能が必要ですOPENTHREAD_CONFIG_BORDER_ROUTER_ENABLE有効にすることを。

唯一の安定したエントリは(すなわち、公開することができaConfig.mStable真でなければなりません)。

詳細
パラメーター
[in] aInstance
OpenThreadインスタンスへのポインタ。
[in] aConfig
公開するメッシュ上のプレフィックス設定(NULLであってはなりません)。
戻り値
OT_ERROR_NONE
オンメッシュプレフィックスが正常に公開されました。
OT_ERROR_INVALID_ARGS
aConfig有効な(悪い接頭辞、無効なフラグの組み合わせ、または安定しない)ではありません。
OT_ERROR_ALREADY
同じプレフィックスを持つエントリは、すでに公開リストにあります。
OT_ERROR_NO_BUFS
新しいリクエストのエントリを割り当てることができませんでした。パブリッシャは、設定によって決定(オンメッシュプレフィックスと外部経路との間で共有される)エントリの限られた数のサポートOPENTHREAD_CONFIG_NETDATA_PUBLISHER_MAX_PREFIX_ENTRIES

otNetDataSetDnsSrpServicePublisherCallback

void otNetDataSetDnsSrpServicePublisherCallback(
  otInstance *aInstance,
  otNetDataDnsSrpServicePublisherCallback aCallback,
  void *aContext
)

この関数は、公開された「DNS / SRPサービス」が実際にスレッドネットワークデータに追加またはスレッドネットワークデータから削除されたときに通知するためのコールバックを設定します。

この関数への後続の呼び出しは、以前に設定されたコールバック関数を置き換えます。

この機能は、機能が必要ですOPENTHREAD_CONFIG_TMF_NETDATA_SERVICE_ENABLE有効にすることを。

詳細
パラメーター
[in] aInstance
OpenThreadインスタンスへのポインタ。
[in] aCallback
コールバック関数ポインター(不要な場合はNULLにすることができます)。
[in] aContext
(ときに使用されるアプリケーション固有のコンテキストへのポインタaCallback呼び出されます)。

otNetDataSetPrefixPublisherCallback

void otNetDataSetPrefixPublisherCallback(
  otInstance *aInstance,
  otNetDataPrefixPublisherCallback aCallback,
  void *aContext
)

この関数は、公開されたプレフィックスエントリが実際にスレッドネットワークデータに追加またはスレッドネットワークデータから削除されたことを通知するためのコールバックを設定します。

この関数への後続の呼び出しは、以前に設定されたコールバック関数を置き換えます。

この機能は、機能が必要ですOPENTHREAD_CONFIG_BORDER_ROUTER_ENABLE有効にすることを。

詳細
パラメーター
[in] aInstance
OpenThreadインスタンスへのポインタ。
[in] aCallback
コールバック関数ポインター(不要な場合はNULLにすることができます)。
[in] aContext
(ときに使用されるアプリケーション固有のコンテキストへのポインタaCallback呼び出されます)。

otNetDataSteeringDataCheckJoiner

otError otNetDataSteeringDataCheckJoiner(
  otInstance *aInstance,
  const otExtAddress *aEui64
)

ステアリングデータにジョイナが含まれているかどうかを確認します。

詳細
パラメーター
[in] aInstance
OpenThreadインスタンスへのポインタ。
[in] aEui64
ジョイナのIEEEEUI-64へのポインタ。
戻り値
OT_ERROR_NONE
aEui64ステアリングデータに含まれています。
OT_ERROR_INVALID_STATE
ステアリングデータがありません。
OT_ERROR_NOT_FOUND
aEui64ステアリングデータに含まれていません。

otNetDataSteeringDataCheckJoinerWithDiscerner

otError otNetDataSteeringDataCheckJoinerWithDiscerner(
  otInstance *aInstance,
  const struct otJoinerDiscerner *aDiscerner
)

ステアリングデータに、特定の識別値を持つジョイナーが含まれているかどうかを確認します。

詳細
パラメーター
[in] aInstance
OpenThreadインスタンスへのポインタ。
[in] aDiscerner
JoinerDiscernerへのポインタ。
戻り値
OT_ERROR_NONE
aDiscernerステアリングデータに含まれています。
OT_ERROR_INVALID_STATE
ステアリングデータがありません。
OT_ERROR_NOT_FOUND
aDiscernerステアリングデータに含まれていません。

otNetDataUnpublishDnsSrpService

void otNetDataUnpublishDnsSrpService(
  otInstance *aInstance
)

この関数は、以前に追加された「DNS / SRP(AnycastまたはUnicast)サービス」エントリをスレッドネットワークデータから非公開にします。

この機能は、機能が必要ですOPENTHREAD_CONFIG_TMF_NETDATA_SERVICE_ENABLE有効にすることを。

詳細
パラメーター
[in] aInstance
OpenThreadインスタンスへのポインタ。

otNetDataUnpublishPrefix

otError otNetDataUnpublishPrefix(
  otInstance *aInstance,
  const otIp6Prefix *aPrefix
)

この関数は、以前に公開されたプレフィックス(メッシュ上または外部ルート)を公開解除します。

この機能は、機能が必要ですOPENTHREAD_CONFIG_BORDER_ROUTER_ENABLE有効にすることを。

詳細
パラメーター
[in] aInstance
OpenThreadインスタンスへのポインタ。
[in] aPrefix
非公開にするプレフィックス(NULLであってはなりません)。
戻り値
OT_ERROR_NONE
プレフィックスは正常に非公開になりました。
OT_ERROR_NOT_FOUND
公開リストにプレフィックスが見つかりませんでした。

otThreadBecomeChild

otError otThreadBecomeChild(
  otInstance *aInstance
)

子供の頃に再アタッチしてみてください。

詳細
パラメーター
[in] aInstance
OpenThreadインスタンスへのポインタ。
戻り値
OT_ERROR_NONE
正常に子供になる試みを開始します。
OT_ERROR_INVALID_STATE
スレッドが無効になっています。

otThreadBecomeDetached

otError otThreadBecomeDetached(
  otInstance *aInstance
)

スレッドネットワークから切り離します。

詳細
パラメーター
[in] aInstance
OpenThreadインスタンスへのポインタ。
戻り値
OT_ERROR_NONE
スレッドネットワークから正常に切り離されました。
OT_ERROR_INVALID_STATE
スレッドが無効になっています。

otThreadDeviceRoleToString

const char * otThreadDeviceRoleToString(
  otDeviceRole aRole
)

デバイスの役割を人間が読める文字列に変換します。

詳細
パラメーター
[in] aRole
変換するデバイスの役割。
戻り値
表す文字列aRole

otThreadDiscover

otError otThreadDiscover(
  otInstance *aInstance,
  uint32_t aScanChannels,
  uint16_t aPanId,
  bool aJoiner,
  bool aEnableEui64Filtering,
  otHandleActiveScanResult aCallback,
  void *aCallbackContext
)

この関数は、スレッド検出スキャンを開始します。

詳細
パラメーター
[in] aInstance
OpenThreadインスタンスへのポインタ。
[in] aScanChannels
スキャンするチャネルを示すビットベクトル(OT_CHANNEL_11_MASKなど)。
[in] aPanId
PAN IDフィルター(フィルターを無効にするには、PANのブロードキャストに設定します)。
[in] aJoiner
ディスカバリー要求TLVのジョイナーフラグの値。
[in] aEnableEui64Filtering
EUI-64で応答をフィルタリングする場合はTRUE、それ以外の場合はFALSE。
[in] aCallback
MLEディスカバリー応答またはスキャンの受信時に呼び出される関数へのポインターが完了します。
[in] aCallbackContext
アプリケーション固有のコンテキストへのポインタ。
戻り値
OT_ERROR_NONE
スレッド検出スキャンを正常に開始しました。
OT_ERROR_INVALID_STATE
IPv6インターフェースが有効になっていません(netifが起動していません)。
OT_ERROR_NO_BUFS
検出要求にメッセージを割り当てることができませんでした。
OT_ERROR_BUSY
スレッド検出スキャンはすでに進行中です。

otThreadGetChildTimeout

uint32_t otThreadGetChildTimeout(
  otInstance *aInstance
)

子ロールで操作するときに使用されるスレッド子タイムアウトを取得します。

詳細
パラメーター
[in] aInstance
OpenThreadインスタンスへのポインタ。
戻り値
秒単位のスレッド子タイムアウト値。
参照:
otThreadSetChildTimeout

otThreadGetDeviceRole

otDeviceRole otThreadGetDeviceRole(
  otInstance *aInstance
)

デバイスの役割を取得します。

詳細
パラメーター
[in] aInstance
OpenThreadインスタンスへのポインタ。
戻り値
OT_DEVICE_ROLE_DISABLED
スレッドスタックは無効になっています。
OT_DEVICE_ROLE_DETACHED
デバイスは現在、スレッドネットワーク/パーティションに参加していません。
OT_DEVICE_ROLE_CHILD
デバイスは現在、スレッドの子として動作しています。
OT_DEVICE_ROLE_ROUTER
デバイスは現在、スレッドルーターとして動作しています。
OT_DEVICE_ROLE_LEADER
デバイスは現在、スレッドリーダーとして動作しています。

otThreadGetDomainName

const char * otThreadGetDomainName(
  otInstance *aInstance
)

スレッドドメイン名を取得します。

この関数は、スレッド1.2以降でのみ使用できます。

詳細
パラメーター
[in] aInstance
OpenThreadインスタンスへのポインタ。
戻り値
スレッドドメイン名へのポインタ。
参照:
otThreadSetDomainName

otThreadGetExtendedPanId

const otExtendedPanId * otThreadGetExtendedPanId(
  otInstance *aInstance
)

IEEE802.15.4拡張PANIDを取得します。

詳細
パラメーター
[in] aInstance
OpenThreadインスタンスへのポインタ。
戻り値
IEEE802.15.4拡張PANIDへのポインタ。
参照:
otThreadSetExtendedPanId

otThreadGetFixedDuaInterfaceIdentifier

const otIp6InterfaceIdentifier * otThreadGetFixedDuaInterfaceIdentifier(
  otInstance *aInstance
)

スレッドドメインユニキャストアドレスに手動で指定されたインターフェイス識別子を取得します。

この関数は、スレッド1.2以降でのみ使用できますOPENTHREAD_CONFIG_DUA_ENABLE有効になっています。

詳細
パラメーター
[in] aInstance
OpenThreadインスタンスへのポインタ。
戻り値
手動で設定されたインターフェイス識別子へのポインタ。設定されていない場合はNULL。
参照:
otThreadSetFixedDuaInterfaceIdentifier

otThreadGetIp6Counters

const otIpCounters * otThreadGetIp6Counters(
  otInstance *aInstance
)

IPv6カウンターを取得します。

詳細
パラメーター
[in] aInstance
OpenThreadインスタンスへのポインタ。
戻り値
IPv6カウンターへのポインター。

otThreadGetKeySequenceCounter

uint32_t otThreadGetKeySequenceCounter(
  otInstance *aInstance
)

thrKeySequenceCounterを取得します。

詳細
パラメーター
[in] aInstance
OpenThreadインスタンスへのポインタ。
戻り値
thrKeySequenceCounter値。
参照:
otThreadSetKeySequenceCounter

otThreadGetKeySwitchGuardTime

uint32_t otThreadGetKeySwitchGuardTime(
  otInstance *aInstance
)

thrKeySwitchGuardTimeを取得します。

詳細
パラメーター
[in] aInstance
OpenThreadインスタンスへのポインタ。
戻り値
thrKeySwitchGuardTime値(時間単位)。
参照:
otThreadSetKeySwitchGuardTime

otThreadGetLeaderData

otError otThreadGetLeaderData(
  otInstance *aInstance,
  otLeaderData *aLeaderData
)

この関数は、スレッドリーダーデータを取得します。

詳細
パラメーター
[in] aInstance
OpenThreadインスタンスへのポインタ。
[out] aLeaderData
リーダーデータが配置される場所へのポインター。
戻り値
OT_ERROR_NONE
リーダーデータを正常に取得しました。
OT_ERROR_DETACHED
現在は接続されていません。

otThreadGetLeaderRloc

otError otThreadGetLeaderRloc(
  otInstance *aInstance,
  otIp6Address *aLeaderRloc
)

この関数は、リーダーのRLOCへのポインターを返します。

詳細
パラメーター
[in] aInstance
OpenThreadインスタンスへのポインタ。
[out] aLeaderRloc
リーダーのRLOCへのポインター。
戻り値
OT_ERROR_NONE
リーダーのRLOCが正常に書き込まれたaLeaderRloc
OT_ERROR_INVALID_ARGS
aLeaderRloc NULLでした。
OT_ERROR_DETACHED
現在、スレッドパーティションに接続されていません。

otThreadGetLeaderRouterId

uint8_t otThreadGetLeaderRouterId(
  otInstance *aInstance
)

リーダーのルーターIDを取得します。

詳細
パラメーター
[in] aInstance
OpenThreadインスタンスへのポインタ。
戻り値
リーダーのルーターID。

otThreadGetLeaderWeight

uint8_t otThreadGetLeaderWeight(
  otInstance *aInstance
)

リーダーの体重を取得します。

詳細
パラメーター
[in] aInstance
OpenThreadインスタンスへのポインタ。
戻り値
リーダーの重み。

otThreadGetLinkLocalAllThreadNodesMulticastAddress

const otIp6Address * otThreadGetLinkLocalAllThreadNodesMulticastAddress(
  otInstance *aInstance
)

この関数は、スレッドリンクローカルのすべてのスレッドノードのマルチキャストアドレスを返します。

アドレスは、リンクローカルのユニキャストプレフィックスベースのマルチキャストアドレス[RFC 3306]であり、次のものがあります。

  • flgsを3に設定(P = 1およびT = 1)
  • スコプを2に設定
  • plenを64に設定
  • メッシュローカルプレフィックスに設定されたネットワークプレフィックス
  • グループIDを1に設定

詳細
パラメーター
[in] aInstance
OpenThreadインスタンスへのポインタ。
戻り値
スレッドリンクへのポインタ-ローカルのすべてのスレッドノードのマルチキャストアドレス。

otThreadGetLinkLocalIp6Address

const otIp6Address * otThreadGetLinkLocalIp6Address(
  otInstance *aInstance
)

この関数は、スレッドリンクローカルIPv6アドレスを返します。

スレッドリンクローカルアドレスは、インターフェイス識別子としてIEEE802.15.4拡張アドレスを使用して導出されます。

詳細
パラメーター
[in] aInstance
OpenThreadインスタンスへのポインタ。
戻り値
スレッドリンクローカルIPv6アドレスへのポインタ。

otThreadGetLinkMode

otLinkModeConfig otThreadGetLinkMode(
  otInstance *aInstance
)

MLEリンクモード構成を取得します。

詳細
パラメーター
[in] aInstance
OpenThreadインスタンスへのポインタ。
戻り値
MLEリンクモードの構成。
参照:
otThreadSetLinkMode

otThreadGetMeshLocalEid

const otIp6Address * otThreadGetMeshLocalEid(
  otInstance *aInstance
)

この関数は、メッシュローカルEIDアドレスへのポインタを返します。

詳細
パラメーター
[in] aInstance
OpenThreadインスタンスへのポインタ。
戻り値
メッシュローカルEIDアドレスへのポインタ。

otThreadGetMeshLocalPrefix

const otMeshLocalPrefix * otThreadGetMeshLocalPrefix(
  otInstance *aInstance
)

この関数は、メッシュローカルプレフィックスへのポインタを返します。

詳細
パラメーター
[in] aInstance
OpenThreadインスタンスへのポインタ。
戻り値
メッシュローカルプレフィックスへのポインタ。

otThreadGetMleCounters

const otMleCounters * otThreadGetMleCounters(
  otInstance *aInstance
)

スレッドMLEカウンターを取得します。

詳細
パラメーター
[in] aInstance
OpenThreadインスタンスへのポインタ。
戻り値
スレッドMLEカウンターへのポインター。

otThreadGetNetworkKey

void otThreadGetNetworkKey(
  otInstance *aInstance,
  otNetworkKey *aNetworkKey
)

スレッドネットワークキーを取得します。

詳細
パラメーター
[in] aInstance
OpenThreadインスタンスへのポインタ。
[out] aNetworkKey
ポインタotNetworkkeyスレッドネットワークキーを返します。
参照:
otThreadSetNetworkKey

otThreadGetNetworkKeyRef

otNetworkKeyRef otThreadGetNetworkKeyRef(
  otInstance *aInstance
)

取得otNetworkKeyRefスレッドネットワークキーのために。

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

詳細
パラメーター
[in] aInstance
OpenThreadインスタンスへのポインタ。
戻り値
メモリに保存されているスレッドネットワークキーへの参照。
参照:
otThreadSetNetworkKeyRef

otThreadGetNetworkName

const char * otThreadGetNetworkName(
  otInstance *aInstance
)

スレッドネットワーク名を取得します。

詳細
パラメーター
[in] aInstance
OpenThreadインスタンスへのポインタ。
戻り値
スレッドネットワーク名へのポインタ。
参照:
otThreadSetNetworkName

otThreadGetNextDiagnosticTlv

otError otThreadGetNextDiagnosticTlv(
  const otMessage *aMessage,
  otNetworkDiagIterator *aIterator,
  otNetworkDiagTlv *aNetworkDiagTlv
)

この関数は、メッセージ内の次のネットワーク診断TLVを取得します。

この関数への後続の呼び出しは、現在の戻り値がOT_ERROR_NONEの場合にのみ許可されます。

詳細
パラメーター
[in] aMessage
メッセージへのポインタ。
[in,out] aIterator
ネットワーク診断イテレータコンテキストへのポインタ。最初のネットワーク診断TLVを取得するには、OT_NETWORK_DIAGNOSTIC_ITERATOR_INITに設定する必要があります。
[out] aNetworkDiagTlv
ネットワーク診断TLV情報が配置される場所へのポインター。
戻り値
OT_ERROR_NONE
次のネットワーク診断TLVが正常に見つかりました。
OT_ERROR_NOT_FOUND
後続のネットワーク診断TLVはメッセージに存在しません。
OT_ERROR_PARSE
次のネットワーク診断の解析に失敗しました。

otThreadGetNextNeighborInfo

otError otThreadGetNextNeighborInfo(
  otInstance *aInstance,
  otNeighborInfoIterator *aIterator,
  otNeighborInfo *aInfo
)

この関数は、次のネイバー情報を取得します。

ネイバーテーブルのエントリを調べるために使用されます。

詳細
パラメーター
[in] aInstance
OpenThreadインスタンスへのポインタ。
[in,out] aIterator
イテレータコンテキストへのポインタ。最初のネイバーエントリを取得するには、OT_NEIGHBOR_INFO_ITERATOR_INITに設定する必要があります。
[out] aInfo
ネイバー情報へのポインタ。
戻り値
OT_ERROR_NONE
テーブル内の次のネイバーエントリが正常に見つかりました。
OT_ERROR_NOT_FOUND
後続のネイバーエントリはテーブルに存在しません。
OT_ERROR_INVALID_ARGS
aIteratorまたはaInfo NULLでした。

otThreadGetParentAverageRssi

otError otThreadGetParentAverageRssi(
  otInstance *aInstance,
  int8_t *aParentRssi
)

この関数は、スレッドの親の平均RSSIを取得します。

詳細
パラメーター
[in] aInstance
OpenThreadインスタンスへのポインタ。
[out] aParentRssi
親RSSIを配置する場所へのポインター。

otThreadGetParentInfo

otError otThreadGetParentInfo(
  otInstance *aInstance,
  otRouterInfo *aParentInfo
)

The function retrieves diagnostic information for a Thread Router as parent.

Details
Parameters
[in] aInstance
A pointer to an OpenThread instance.
[out] aParentInfo
A pointer to where the parent router information is placed.

otThreadGetParentLastRssi

otError otThreadGetParentLastRssi(
  otInstance *aInstance,
  int8_t *aLastRssi
)

The function retrieves the RSSI of the last packet from the Thread Parent.

Details
Parameters
[in] aInstance
A pointer to an OpenThread instance.
[out] aLastRssi
A pointer to where the last RSSI should be placed.
Return Values
OT_ERROR_NONE
Successfully retrieved the RSSI data.
OT_ERROR_FAILED
Unable to get RSSI data.
OT_ERROR_INVALID_ARGS
aLastRssi is NULL.

otThreadGetPartitionId

uint32_t otThreadGetPartitionId(
  otInstance *aInstance
)

Get the Partition ID.

Details
Parameters
[in] aInstance
A pointer to an OpenThread instance.
Returns
The Partition ID.

otThreadGetRealmLocalAllThreadNodesMulticastAddress

const otIp6Address * otThreadGetRealmLocalAllThreadNodesMulticastAddress(
  otInstance *aInstance
)

This function returns the Thread Realm-Local All Thread Nodes multicast address.

The address is a realm-local Unicast Prefix-Based Multcast Address [RFC 3306], with:

  • flgs set to 3 (P = 1 and T = 1)
  • scop set to 3
  • plen set to 64
  • network prefix set to the Mesh Local Prefix
  • group ID set to 1

Details
Parameters
[in] aInstance
A pointer to an OpenThread instance.
Returns
A pointer to Thread Realm-Local All Thread Nodes multicast address.

otThreadGetRloc

const otIp6Address * otThreadGetRloc(
  otInstance *aInstance
)

This function returns a pointer to the Thread Routing Locator (RLOC) address.

Details
Parameters
[in] aInstance
A pointer to an OpenThread instance.
Returns
A pointer to the Thread Routing Locator (RLOC) address.

otThreadGetRloc16

uint16_t otThreadGetRloc16(
  otInstance *aInstance
)

Get the RLOC16.

Details
Parameters
[in] aInstance
A pointer to an OpenThread instance.
Returns
The RLOC16.

otThreadGetServiceAloc

otError otThreadGetServiceAloc(
  otInstance *aInstance,
  uint8_t aServiceId,
  otIp6Address *aServiceAloc
)

This function retrieves the Service ALOC for given Service ID.

Details
Parameters
[in] aInstance
A pointer to an OpenThread instance.
[in] aServiceId
Service ID to get ALOC for.
[out] aServiceAloc
A pointer to output the Service ALOC. MUST NOT BE NULL.
Return Values
OT_ERROR_NONE
Successfully retrieved the Service ALOC.
OT_ERROR_DETACHED
The Thread interface is not currently attached to a Thread Partition.

otThreadGetVersion

uint16_t otThreadGetVersion(
  void
)

This function gets the Thread protocol version.

Details
Returns
the Thread protocol version.

otThreadIsAnycastLocateInProgress

bool otThreadIsAnycastLocateInProgress(
  otInstance *aInstance
)

This function indicates whether an anycast locate request is currently in progress.

This function is only available when OPENTHREAD_CONFIG_TMF_ANYCAST_LOCATOR_ENABLE is enabled.

Details
Parameters
[in] aInstance
A pointer to an OpenThread instance.
Returns
TRUE if an anycast locate request is currently in progress, FALSE otherwise.

otThreadIsDiscoverInProgress

bool otThreadIsDiscoverInProgress(
  otInstance *aInstance
)

This function determines if an MLE Thread Discovery is currently in progress.

Details
Parameters
[in] aInstance
A pointer to an OpenThread instance.

otThreadIsSingleton

bool otThreadIsSingleton(
  otInstance *aInstance
)

This function indicates whether a node is the only router on the network.

Details
Parameters
[in] aInstance
A pointer to an OpenThread instance.
Return Values
TRUE
It is the only router in the network.
FALSE
It is a child or is not a single router in the network.

otThreadLocateAnycastDestination

otError otThreadLocateAnycastDestination(
  otInstance *aInstance,
  const otIp6Address *aAnycastAddress,
  otThreadAnycastLocatorCallback aCallback,
  void *aContext
)

This function requests the closest destination of a given anycast address to be located.

This function is only available when OPENTHREAD_CONFIG_TMF_ANYCAST_LOCATOR_ENABLE is enabled.

If a previous request is ongoing, a subsequent call to this function will cancel and replace the earlier request.

Details
Parameters
[in] aInstance
A pointer to an OpenThread instance.
[in] aAnycastAddress
The anycast address to locate. MUST NOT be NULL.
[in] aCallback
The callback function to report the result.
[in] aContext
An arbitrary context used with aCallback .
Return Values
OT_ERROR_NONE
The request started successfully. aCallback will be invoked to report the result.
OT_ERROR_INVALID_ARGS
The aAnycastAddress is not a valid anycast address or aCallback is NULL.
OT_ERROR_NO_BUFS
Out of buffer to prepare and send the request message.

otThreadRegisterParentResponseCallback

void otThreadRegisterParentResponseCallback(
  otInstance *aInstance,
  otThreadParentResponseCallback aCallback,
  void *aContext
)

This function registers a callback to receive MLE Parent Response data.

Details
Parameters
[in] aInstance
A pointer to an OpenThread instance.
[in] aCallback
A pointer to a function that is called upon receiving an MLE Parent Response message.
[in] aContext
A pointer to callback client-specific context.

otThreadResetIp6Counters

void otThreadResetIp6Counters(
  otInstance *aInstance
)

Reset the IPv6 counters.

Details
Parameters
[in] aInstance
A pointer to an OpenThread instance.

otThreadResetMleCounters

void otThreadResetMleCounters(
  otInstance *aInstance
)

Reset the Thread MLE counters.

Details
Parameters
[in] aInstance
A pointer to an OpenThread instance.

otThreadSendAddressNotification

void otThreadSendAddressNotification(
  otInstance *aInstance,
  otIp6Address *aDestination,
  otIp6Address *aTarget,
  otIp6InterfaceIdentifier *aMlIid
)

This function sends a Proactive Address Notification (ADDR_NTF.ntf) message.

This function is only available when OPENTHREAD_CONFIG_REFERENCE_DEVICE_ENABLE is enabled.

Details
Parameters
[in] aInstance
A pointer to an OpenThread instance.
[in] aDestination
The destination to send the ADDR_NTF.ntf message.
[in] aTarget
The target address of the ADDR_NTF.ntf message.
[in] aMlIid
The ML-IID of the ADDR_NTF.ntf message.

otThreadSendDiagnosticGet

otError otThreadSendDiagnosticGet(
  otInstance *aInstance,
  const otIp6Address *aDestination,
  const uint8_t aTlvTypes[],
  uint8_t aCount,
  otReceiveDiagnosticGetCallback aCallback,
  void *aCallbackContext
)

Send a Network Diagnostic Get request.

Details
Parameters
[in] aInstance
A pointer to an OpenThread instance.
[in] aDestination
A pointer to destination address.
[in] aTlvTypes
An array of Network Diagnostic TLV types.
[in] aCount
Number of types in aTlvTypes.
[in] aCallback
A pointer to a function that is called when Network Diagnostic Get response is received or NULL to disable the callback.
[in] aCallbackContext
A pointer to application-specific context.
Return Values
OT_ERROR_NONE
Successfully queued the DIAG_GET.req.
OT_ERROR_NO_BUFS
Insufficient message buffers available to send DIAG_GET.req.

otThreadSendDiagnosticReset

otError otThreadSendDiagnosticReset(
  otInstance *aInstance,
  const otIp6Address *aDestination,
  const uint8_t aTlvTypes[],
  uint8_t aCount
)

Send a Network Diagnostic Reset request.

Details
Parameters
[in] aInstance
A pointer to an OpenThread instance.
[in] aDestination
A pointer to destination address.
[in] aTlvTypes
An array of Network Diagnostic TLV types. Currently only Type 9 is allowed.
[in] aCount
Number of types in aTlvTypes
Return Values
OT_ERROR_NONE
Successfully queued the DIAG_RST.ntf.
OT_ERROR_NO_BUFS
Insufficient message buffers available to send DIAG_RST.ntf.

otThreadSendProactiveBackboneNotification

otError otThreadSendProactiveBackboneNotification(
  otInstance *aInstance,
  otIp6Address *aTarget,
  otIp6InterfaceIdentifier *aMlIid,
  uint32_t aTimeSinceLastTransaction
)

This function sends a Proactive Backbone Notification (PRO_BB.ntf) message on the Backbone link.

This function is only available when OPENTHREAD_CONFIG_REFERENCE_DEVICE_ENABLE is enabled.

Details
Parameters
[in] aInstance
A pointer to an OpenThread instance.
[in] aTarget
The target address of the PRO_BB.ntf message.
[in] aMlIid
The ML-IID of the PRO_BB.ntf message.
[in] aTimeSinceLastTransaction
Time since last transaction (in seconds).
Return Values
OT_ERROR_NONE
Successfully sent PRO_BB.ntf on backbone link.
OT_ERROR_NO_BUFS
If insufficient message buffers available.

otThreadSetChildTimeout

void otThreadSetChildTimeout(
  otInstance *aInstance,
  uint32_t aTimeout
)

Set the Thread Child Timeout used when operating in the Child role.

Details
Parameters
[in] aInstance
A pointer to an OpenThread instance.
[in] aTimeout
The timeout value in seconds.
See also:
otThreadGetChildTimeout

otThreadSetDiscoveryRequestCallback

void otThreadSetDiscoveryRequestCallback(
  otInstance *aInstance,
  otThreadDiscoveryRequestCallback aCallback,
  void *aContext
)

This function sets a callback to receive MLE Discovery Request data.

Details
Parameters
[in] aInstance
A pointer to an OpenThread instance.
[in] aCallback
A pointer to a function that is called upon receiving an MLE Discovery Request message.
[in] aContext
A pointer to callback application-specific context.

otThreadSetDomainName

otError otThreadSetDomainName(
  otInstance *aInstance,
  const char *aDomainName
)

Set the Thread Domain Name.

This function is only available since Thread 1.2. This function succeeds only when Thread protocols are disabled.

Details
Parameters
[in] aInstance
A pointer to an OpenThread instance.
[in] aDomainName
A pointer to the Thread Domain Name.
Return Values
OT_ERROR_NONE
Successfully set the Thread Domain Name.
OT_ERROR_INVALID_STATE
Thread protocols are enabled.
See also:
otThreadGetDomainName

otThreadSetEnabled

otError otThreadSetEnabled(
  otInstance *aInstance,
  bool aEnabled
)

This function starts Thread protocol operation.

The interface must be up when calling this function.

Details
Parameters
[in] aInstance
A pointer to an OpenThread instance.
[in] aEnabled
TRUE if Thread is enabled, FALSE otherwise.
Return Values
OT_ERROR_NONE
Successfully started Thread protocol operation.
OT_ERROR_INVALID_STATE
The network interface was not not up.

otThreadSetExtendedPanId

otError otThreadSetExtendedPanId(
  otInstance *aInstance,
  const otExtendedPanId *aExtendedPanId
)

Set the IEEE 802.15.4 Extended PAN ID.

This function can only be called while Thread protocols are disabled. A successful call to this function invalidates the Active and Pending Operational Datasets in non-volatile memory.

Details
Parameters
[in] aInstance
A pointer to an OpenThread instance.
[in] aExtendedPanId
A pointer to the IEEE 802.15.4 Extended PAN ID.
Return Values
OT_ERROR_NONE
Successfully set the Extended PAN ID.
OT_ERROR_INVALID_STATE
Thread protocols are enabled.
See also:
otThreadGetExtendedPanId

otThreadSetFixedDuaInterfaceIdentifier

otError otThreadSetFixedDuaInterfaceIdentifier(
  otInstance *aInstance,
  const otIp6InterfaceIdentifier *aIid
)

Set/Clear the Interface Identifier manually specified for the Thread Domain Unicast Address.

This function is only available since Thread 1.2 when OPENTHREAD_CONFIG_DUA_ENABLE is enabled.

Details
Parameters
[in] aInstance
A pointer to an OpenThread instance.
[in] aIid
A pointer to the Interface Identifier to set or NULL to clear.
Return Values
OT_ERROR_NONE
Successfully set/cleared the Interface Identifier.
OT_ERROR_INVALID_ARGS
The specified Interface Identifier is reserved.
See also:
otThreadGetFixedDuaInterfaceIdentifier

otThreadSetJoinerAdvertisement

otError otThreadSetJoinerAdvertisement(
  otInstance *aInstance,
  uint32_t aOui,
  const uint8_t *aAdvData,
  uint8_t aAdvDataLength
)

This method sets the Thread Joiner Advertisement when discovering Thread network.

Thread Joiner Advertisement is used to allow a Joiner to advertise its own application-specific information (such as Vendor ID, Product ID, Discriminator, etc.) via a newly-proposed Joiner Advertisement TLV, and to make this information available to Commissioners or Commissioner Candidates without human interaction.

Details
Parameters
[in] aInstance
A pointer to an OpenThread instance.
[in] aOui
The Vendor IEEE OUI value that will be included in the Joiner Advertisement. Only the least significant 3 bytes will be used, and the most significant byte will be ignored.
[in] aAdvData
A pointer to the AdvData that will be included in the Joiner Advertisement.
[in] aAdvDataLength
The length of AdvData in bytes.
Return Values
OT_ERROR_NONE
Successfully set Joiner Advertisement.
OT_ERROR_INVALID_ARGS
Invalid AdvData.

otThreadSetKeySequenceCounter

void otThreadSetKeySequenceCounter(
  otInstance *aInstance,
  uint32_t aKeySequenceCounter
)

Set the thrKeySequenceCounter.

Details
Parameters
[in] aInstance
A pointer to an OpenThread instance.
[in] aKeySequenceCounter
The thrKeySequenceCounter value.
See also:
otThreadGetKeySequenceCounter

otThreadSetKeySwitchGuardTime

void otThreadSetKeySwitchGuardTime(
  otInstance *aInstance,
  uint32_t aKeySwitchGuardTime
)

Set the thrKeySwitchGuardTime.

Details
Parameters
[in] aInstance
A pointer to an OpenThread instance.
[in] aKeySwitchGuardTime
The thrKeySwitchGuardTime value (in hours).
See also:
otThreadGetKeySwitchGuardTime

otThreadSetLinkMode

otError otThreadSetLinkMode(
  otInstance *aInstance,
  otLinkModeConfig aConfig
)

Set the MLE Link Mode configuration.

Details
Parameters
[in] aInstance
A pointer to an OpenThread instance.
[in] aConfig
A pointer to the Link Mode configuration.
Return Values
OT_ERROR_NONE
Successfully set the MLE Link Mode configuration.
See also:
otThreadGetLinkMode

otThreadSetMeshLocalPrefix

otError otThreadSetMeshLocalPrefix(
  otInstance *aInstance,
  const otMeshLocalPrefix *aMeshLocalPrefix
)

This function sets the Mesh Local Prefix.

This function succeeds only when Thread protocols are disabled. A successful call to this function invalidates the Active and Pending Operational Datasets in non-volatile memory.

Details
Parameters
[in] aInstance
A pointer to an OpenThread instance.
[in] aMeshLocalPrefix
A pointer to the Mesh Local Prefix.
Return Values
OT_ERROR_NONE
Successfully set the Mesh Local Prefix.
OT_ERROR_INVALID_STATE
Thread protocols are enabled.

otThreadSetNetworkKey

otError otThreadSetNetworkKey(
  otInstance *aInstance,
  const otNetworkKey *aKey
)

Set the Thread Network Key.

This function succeeds only when Thread protocols are disabled. A successful call to this function invalidates the Active and Pending Operational Datasets in non-volatile memory.

Details
Parameters
[in] aInstance
A pointer to an OpenThread instance.
[in] aKey
A pointer to a buffer containing the Thread Network Key.
Return Values
OT_ERROR_NONE
Successfully set the Thread Network Key.
OT_ERROR_INVALID_STATE
Thread protocols are enabled.
See also:
otThreadGetNetworkKey

otThreadSetNetworkKeyRef

otError otThreadSetNetworkKeyRef(
  otInstance *aInstance,
  otNetworkKeyRef aKeyRef
)

Set the Thread Network Key as a otNetworkKeyRef .

This function succeeds only when Thread protocols are disabled. A successful call to this function invalidates the Active and Pending Operational Datasets in non-volatile memory.

This function requires the build-time feature OPENTHREAD_CONFIG_PLATFORM_KEY_REFERENCES_ENABLE to be enabled.

Details
Parameters
[in] aInstance
A pointer to an OpenThread instance.
[in] aKeyRef
Reference to the Thread Network Key.
Return Values
OT_ERROR_NONE
Successfully set the Thread Network Key.
OT_ERROR_INVALID_STATE
Thread protocols are enabled.
See also:
otThreadGetNetworkKeyRef

otThreadSetNetworkName

otError otThreadSetNetworkName(
  otInstance *aInstance,
  const char *aNetworkName
)

Set the Thread Network Name.

This function succeeds only when Thread protocols are disabled. A successful call to this function invalidates the Active and Pending Operational Datasets in non-volatile memory.

Details
Parameters
[in] aInstance
A pointer to an OpenThread instance.
[in] aNetworkName
A pointer to the Thread Network Name.
Return Values
OT_ERROR_NONE
Successfully set the Thread Network Name.
OT_ERROR_INVALID_STATE
Thread protocols are enabled.
See also:
otThreadGetNetworkName

Macros

OT_JOINER_ADVDATA_MAX_LENGTH

 OT_JOINER_ADVDATA_MAX_LENGTH 64

Maximum AdvData Length of Joiner Advertisement.

OT_NEIGHBOR_INFO_ITERATOR_INIT

 OT_NEIGHBOR_INFO_ITERATOR_INIT 0

Initializer for otNeighborInfoIterator.

OT_NETWORK_BASE_TLV_MAX_LENGTH

 OT_NETWORK_BASE_TLV_MAX_LENGTH 254

Maximum value length of Thread Base TLV.

OT_NETWORK_DATA_ITERATOR_INIT

 OT_NETWORK_DATA_ITERATOR_INIT 0

Value to initialize otNetworkDataIterator .

OT_NETWORK_DIAGNOSTIC_CHILD_TABLE_ENTRY_SIZE

 OT_NETWORK_DIAGNOSTIC_CHILD_TABLE_ENTRY_SIZE 3

Size of Network Diagnostic Child Table entry.

OT_NETWORK_DIAGNOSTIC_ITERATOR_INIT

 OT_NETWORK_DIAGNOSTIC_ITERATOR_INIT 0

Initializer for otNetworkDiagIterator.

OT_NETWORK_DIAGNOSTIC_TYPELIST_MAX_ENTRIES

 OT_NETWORK_DIAGNOSTIC_TYPELIST_MAX_ENTRIES 19

Maximum Number of Network Diagnostic TLV Types to Request or Reset.

OT_NETWORK_MAX_ROUTER_ID

 OT_NETWORK_MAX_ROUTER_ID 62

Maximum Router ID.

OT_SERVER_DATA_MAX_SIZE

 OT_SERVER_DATA_MAX_SIZE 248

Max size of Server Data in bytes. Theoretical limit, practically much lower.

OT_SERVICE_DATA_MAX_SIZE

 OT_SERVICE_DATA_MAX_SIZE 252

Max size of Service Data in bytes.