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

一般

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

まとめ

ネットワークデータパブリッシャーは、ネットワークデータをモニタリングし、エントリを追加または削除するタイミングを管理することにより、Thread ネットワークデータ内の類似の Service プレフィックスまたは接頭辞（オンメッシュプレフィックスまたは外部ルート）エントリの数を制限するメカニズムを提供します。

このモジュールのすべての関数を有効にするには、OPENTHREAD_CONFIG_NETDATA_PUBLISHER_ENABLE を有効にする必要があります。

注: このモジュールの関数には OPENTHREAD_FTD=1 または OPENTHREAD_MTD=1 が必要です。

列挙型
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, OT_NETWORK_DIAGNOSTIC_TLV_VERSION = 24 }	enum
`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 }`	enum Thread デバイスのロールを表します。
`otNetDataPublisherEvent{ OT_NETDATA_PUBLISHER_EVENT_ENTRY_ADDED = 0, OT_NETDATA_PUBLISHER_EVENT_ENTRY_REMOVED = 1 }`	enum この列挙型は、パブリッシャーのコールバックから報告されたイベントを表します。
`otRoutePreference{ OT_ROUTE_PREFERENCE_LOW = -1, OT_ROUTE_PREFERENCE_MED = 0, OT_ROUTE_PREFERENCE_HIGH = 1 }`	enum `otExternalRouteConfig` と `otBorderRouterConfig` で `mPreference` の有効な値を定義します。

Typedef
`otBorderRouterConfig`	typedef `struct otBorderRouterConfig` この構造は、ボーダールーター構成を表しています。
`otDetachGracefullyCallback)(void *aContext)`	typedef `void(*` このコールバックは、接続解除プロセスが完了したことをアプリケーションに通知します。
`otExternalRouteConfig`	typedef `struct otExternalRouteConfig` この構造は外部ルートの構成を表します。
`otIpCounters`	typedef `struct otIpCounters` この構造は IP レベルのカウンタを表します。
`otLeaderData`	typedef `struct otLeaderData` この構造は Thread リーダーデータを表します。
`otLinkModeConfig`	typedef `struct otLinkModeConfig` この構造は MLE リンクモード構成を表します。
`otMleCounters`	typedef `struct otMleCounters` この構造は Thread MLE カウンタを表します。
`otNeighborInfoIterator`	typedef `int16_t` ネイバーテーブルを反復処理するために使用される。
`otNetDataDnsSrpServicePublisherCallback)(otNetDataPublisherEvent aEvent, void *aContext)`	typedef `void(*` この関数ポインタタイプは、Thread ネットワークデータで「DNS/SRP サービス」エントリが追加または削除されたときに通知に使用されるコールバックを定義します。
`otNetDataPrefixPublisherCallback)(otNetDataPublisherEvent aEvent, const otIp6Prefix aPrefix, void aContext)`	typedef `void(*` この関数ポインタ型は、スレッドネットワークデータに対して接頭辞（メッシュ上または外部ルート）のエントリが追加または削除されたときに通知に使用されるコールバックを定義します。
`otNetDataPublisherEvent`	typedef `enum otNetDataPublisherEvent` この列挙型は、パブリッシャーのコールバックから報告されたイベントを表します。
`otNetworkDataIterator`	typedef `uint32_t` ネットワークデータ情報を反復処理するために使用します。
`otNetworkDiagChildEntry`	typedef `struct otNetworkDiagChildEntry` この構造は、ネットワーク診断用の子テーブルのエントリを表します。
`otNetworkDiagConnectivity`	typedef `struct otNetworkDiagConnectivity` この構造は、ネットワーク診断接続の値を表します。
`otNetworkDiagIterator`	typedef `uint16_t` ネットワーク診断 TLV の反復処理に使用されます。
`otNetworkDiagMacCounters`	typedef `struct otNetworkDiagMacCounters` この構造は、ネットワーク診断の Mac カウンタ値を表します。
`otNetworkDiagRoute`	typedef `struct otNetworkDiagRoute` この構造は、ネットワーク診断ルートの TLV 値を表します。
`otNetworkDiagRouteData`	typedef `struct otNetworkDiagRouteData` この構造は、ネットワーク診断ルートのデータを表します。
`otNetworkDiagTlv`	typedef `struct otNetworkDiagTlv` この構造はネットワーク診断 TLV を表します。
`otReceiveDiagnosticGetCallback)(otError aError, otMessage aMessage, const otMessageInfo aMessageInfo, void *aContext)`	typedef `void(*` この関数ポインタは、ネットワーク診断の取得レスポンスを受け取ると呼び出されます。
`otRoutePreference`	typedef `enum otRoutePreference` `otExternalRouteConfig` と `otBorderRouterConfig` で `mPreference` の有効な値を定義します。
`otServerConfig`	typedef `struct otServerConfig` この構造はサーバー構成を表します。
`otServiceConfig`	typedef `struct otServiceConfig` この構造は Service の構成を表します。
`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 `struct otThreadDiscoveryRequestInfo` この構造は、スレッド検出リクエストのデータを表します。
`otThreadParentResponseCallback)(otThreadParentResponseInfo aInfo, void aContext)`	typedef `void(*` この関数ポインタは、MLE 親レスポンスメッセージを受信するたびに呼び出されます。
`otThreadParentResponseInfo`	typedef `struct otThreadParentResponseInfo` この構造は MLE の親レスポンスデータを表します。

関数
`otNetDataContainsOmrPrefix(otInstance aInstance, const otIp6Prefix aPrefix)`	`bool` 特定の接頭辞が有効な OMR 接頭辞として機能し、リーダーのネットワークデータにもこの接頭辞が含まれているかどうかを確認します。
`otNetDataGet(otInstance aInstance, bool aStable, uint8_t aData, uint8_t *aDataLength)`	`otError` パーティションの Thread ネットワークデータの完全なコピーまたは安定したコピーを提供します。
`otNetDataGetLength(otInstance *aInstance)`	`uint8_t` パーティションのスレッドネットワークデータの現在の長さ（バイト数）を取得します。
`otNetDataGetMaxLength(otInstance *aInstance)`	`uint8_t` OT スタックの初期化または最後の `otNetDataResetMaxLength()` 呼び出し以降の Thread ネットワークデータの最大観測長を取得します。
`otNetDataGetNextOnMeshPrefix(otInstance aInstance, otNetworkDataIterator aIterator, otBorderRouterConfig *aConfig)`	`otError` パーティションのネットワークデータ内の次のメッシュプレフィックスを取得します。
`otNetDataGetNextRoute(otInstance aInstance, otNetworkDataIterator aIterator, otExternalRouteConfig *aConfig)`	`otError` パーティションのネットワークデータ内の次の外部ルートを取得します。
`otNetDataGetNextService(otInstance aInstance, otNetworkDataIterator aIterator, otServiceConfig *aConfig)`	`otError` パーティションのネットワークデータで次のサービスを取得します。
`otNetDataGetStableVersion(otInstance *aInstance)`	`uint8_t` 安定版のネットワークデータバージョンを取得します。
`otNetDataGetVersion(otInstance *aInstance)`	`uint8_t` ネットワークデータバージョンを取得します。
`otNetDataIsDnsSrpServiceAdded(otInstance *aInstance)`	`bool` この関数は、現在「DNS/SRP サービス」エントリが Thread ネットワークデータに追加されているかどうかを示します。
`otNetDataIsPrefixAdded(otInstance aInstance, const otIp6Prefix aPrefix)`	`bool` この関数は、現在公開されているプレフィックスエントリ（メッシュ上または外部ルート）が Thread ネットワークデータに追加されているかどうかを示します。
`otNetDataPublishDnsSrpServiceAnycast(otInstance *aInstance, uint8_t aSequenceNUmber)`	`void` この関数は、Thread ネットワークデータで「DNS/SRP サービスのエニーキャストアドレス」を公開するようリクエストします。
`otNetDataPublishDnsSrpServiceUnicast(otInstance aInstance, const otIp6Address aAddress, uint16_t aPort)`	`void` この関数は、Thread ネットワークデータで「DNS/SRP サービスのユニキャストアドレス」を公開するようリクエストします。
`otNetDataPublishDnsSrpServiceUnicastMeshLocalEid(otInstance *aInstance, uint16_t aPort)`	`void` この関数は、Thread ネットワークデータで「DNS/SRP サービスのユニキャストアドレス」を公開するようリクエストします。
`otNetDataPublishExternalRoute(otInstance aInstance, const otExternalRouteConfig aConfig)`	`otError` この関数は、Thread ネットワークデータで公開される外部ルートプレフィックスをリクエストします。
`otNetDataPublishOnMeshPrefix(otInstance aInstance, const otBorderRouterConfig aConfig)`	`otError` この関数は、スレッドネットワークデータで公開されるメッシュ上の接頭辞をリクエストします。
`otNetDataResetMaxLength(otInstance *aInstance)`	`void` トラッキングされたスレッドネットワークデータの最大長をリセットします。
`otNetDataSetDnsSrpServicePublisherCallback(otInstance aInstance, otNetDataDnsSrpServicePublisherCallback aCallback, void aContext)`	`void` この関数は、公開済みの「DNS/SRP サービス」が Thread ネットワークデータに実際に追加または削除されたときに通知するコールバックを設定します。
`otNetDataSetPrefixPublisherCallback(otInstance aInstance, otNetDataPrefixPublisherCallback aCallback, void aContext)`	`void` この関数は、公開されたプレフィックスエントリが Thread ネットワークデータに実際に追加または削除されたときに通知するためのコールバックを設定します。
`otNetDataSteeringDataCheckJoiner(otInstance aInstance, const otExtAddress aEui64)`	`otError` ステアリングデータにジョイナーが含まれているかどうかを確認する。
`otNetDataSteeringDataCheckJoinerWithDiscerner(otInstance aInstance, const struct otJoinerDiscerner aDiscerner)`	`otError` ステアラーデータに、指定した分類機能を持つジョイナーが含まれているかどうかを確認します。
`otNetDataUnpublishDnsSrpService(otInstance *aInstance)`	`void` 以前に追加した DNS/SRP（エニーキャストまたはユニキャスト）サービスのエントリを Thread ネットワークデータから公開停止します。
`otNetDataUnpublishPrefix(otInstance aInstance, const otIp6Prefix aPrefix)`	`otError` 以前に公開したメッシュまたは外部ルートのプレフィックスの公開を停止します。
`otThreadBecomeChild(otInstance *aInstance)`	`otError` 子供として再接続してみる。
`otThreadBecomeDetached(otInstance *aInstance)`	`otError` Thread ネットワークから切断する。
`otThreadDetachGracefully(otInstance aInstance, otDetachGracefullyCallback aCallback, void aContext)`	`otError` この関数は、ネットワーク内の他のノード（存在する場合）に通知し、Thread プロトコルオペレーションを停止します。
`otThreadDeviceRoleToString(otDeviceRole aRole)`	`const char *` デバイスのロールを人が読める文字列に変換する。
`otThreadDiscover(otInstance aInstance, uint32_t aScanChannels, uint16_t aPanId, bool aJoiner, bool aEnableEui64Filtering, otHandleActiveScanResult aCallback, void aCallbackContext)`	`otError` この関数は、Thread 検出スキャンを開始します。
`otThreadGetChildTimeout(otInstance *aInstance)`	`uint32_t` 子ロールで動作する際に使用されるスレッドの子タイムアウト（秒単位）を取得します。
`otThreadGetDeviceRole(otInstance *aInstance)`	`otDeviceRole` デバイスのロールを取得します。
`otThreadGetDomainName(otInstance *aInstance)`	`const char *` スレッドドメイン名を取得します。
`otThreadGetExtendedPanId(otInstance *aInstance)`	`const otExtendedPanId *` IEEE 802.15.4 Extended PAN ID を取得します。
`otThreadGetFixedDuaInterfaceIdentifier(otInstance *aInstance)`	`const otIp6InterfaceIdentifier *` Thread ドメインのユニキャストアドレスに手動で指定されたインターフェース識別子を取得します。
`otThreadGetIp6Counters(otInstance *aInstance)`	`const otIpCounters *` IPv6 カウンタを取得します。
`otThreadGetKeySequenceCounter(otInstance *aInstance)`	`uint32_t` thrKeySequenceCounter を取得します。
`otThreadGetKeySwitchGuardTime(otInstance *aInstance)`	`uint32_t` thrKeySwitchGuardTime を取得します（時間単位）。
`otThreadGetLeaderData(otInstance aInstance, otLeaderData aLeaderData)`	`otError` この関数は、Thread リーダーデータを取得します。
`otThreadGetLeaderRloc(otInstance aInstance, otIp6Address aLeaderRloc)`	`otError` この関数は、リーダーの RLOC へのポインタを返します。
`otThreadGetLeaderRouterId(otInstance *aInstance)`	`uint8_t` リーダーのルーター ID を取得します。
`otThreadGetLeaderWeight(otInstance *aInstance)`	`uint8_t` リーダーの体重を取得します。
`otThreadGetLinkLocalAllThreadNodesMulticastAddress(otInstance *aInstance)`	`const otIp6Address *` スレッドリンクローカルのすべてのスレッドノードのマルチキャストアドレスを取得します。
`otThreadGetLinkLocalIp6Address(otInstance *aInstance)`	`const otIp6Address *` Thread リンクローカル IPv6 アドレスを取得します。
`otThreadGetLinkMode(otInstance *aInstance)`	`otLinkModeConfig` MLE リンクモードの構成を取得します。
`otThreadGetMeshLocalEid(otInstance *aInstance)`	`const otIp6Address *` メッシュのローカル EID アドレスを取得します。
`otThreadGetMeshLocalPrefix(otInstance *aInstance)`	`const otMeshLocalPrefix *` この関数は、メッシュローカルプレフィックスへのポインタを返します。
`otThreadGetMleCounters(otInstance *aInstance)`	`const otMleCounters *` Thread MLE カウンタを取得します。
`otThreadGetNetworkKey(otInstance aInstance, otNetworkKey aNetworkKey)`	`void` Thread ネットワークキーを取得します。
`otThreadGetNetworkKeyRef(otInstance *aInstance)`	`otNetworkKeyRef` Thread ネットワークキーの `otNetworkKeyRef` を取得します。
`otThreadGetNetworkName(otInstance *aInstance)`	`const char *` Thread ネットワーク名を取得します。
`otThreadGetNextDiagnosticTlv(const otMessage aMessage, otNetworkDiagIterator aIterator, otNetworkDiagTlv *aNetworkDiagTlv)`	`otError` この関数は、メッセージの次のネットワーク診断 TLV を取得します。
`otThreadGetNextNeighborInfo(otInstance aInstance, otNeighborInfoIterator aIterator, otNeighborInfo *aInfo)`	`otError` この関数は、次の隣の情報を取得します。
`otThreadGetParentAverageRssi(otInstance aInstance, int8_t aParentRssi)`	`otError` この関数は、Thread 親の平均 RSSI を取得します。
`otThreadGetParentInfo(otInstance aInstance, otRouterInfo aParentInfo)`	`otError` この関数は、Thread ルーターの診断情報を親として取得します。
`otThreadGetParentLastRssi(otInstance aInstance, int8_t aLastRssi)`	`otError` この関数は、Thread 親から最後のパケットの RSSI を取得します。
`otThreadGetPartitionId(otInstance *aInstance)`	`uint32_t` パーティション ID を取得します。
`otThreadGetRealmLocalAllThreadNodesMulticastAddress(otInstance *aInstance)`	`const otIp6Address *` スレッドレルムローカルすべてのスレッドノードのマルチキャストアドレスを取得します。
`otThreadGetRloc(otInstance *aInstance)`	`const otIp6Address *` Thread ルーティングロケーター（RLOC）のアドレスを取得します。
`otThreadGetRloc16(otInstance *aInstance)`	`uint16_t` RLOC16 を取得します。
`otThreadGetServiceAloc(otInstance aInstance, uint8_t aServiceId, otIp6Address aServiceAloc)`	`otError` この関数は、指定されたサービス ID のサービス ALOC を取得します。
`otThreadGetVersion(void)`	`uint16_t` この関数は、Thread プロトコルバージョンを取得します。
`otThreadIsAnycastLocateInProgress(otInstance *aInstance)`	`bool` この関数は、エニーキャスト検索リクエストが現在進行中かどうかを示します。
`otThreadIsDiscoverInProgress(otInstance *aInstance)`	`bool` この関数は、MLE スレッドの検出が現在進行中かどうかを判断します。
`otThreadIsSingleton(otInstance *aInstance)`	`bool` この関数は、ノードがネットワーク上の唯一のルーターであるかどうかを示します。
`otThreadLocateAnycastDestination(otInstance aInstance, const otIp6Address aAnycastAddress, otThreadAnycastLocatorCallback aCallback, void *aContext)`	`otError` この関数は、特定のエニーキャストアドレスに最も近い目的地をリクエストします。
`otThreadRegisterParentResponseCallback(otInstance aInstance, otThreadParentResponseCallback aCallback, void aContext)`	`void` この関数は、MLE の親レスポンスデータを受け取るコールバックを登録します。
`otThreadResetIp6Counters(otInstance *aInstance)`	`void` IPv6 カウンタをリセットします。
`otThreadResetMleCounters(otInstance *aInstance)`	`void` Thread MLE カウンタをリセットします。
`otThreadSearchForBetterParent(otInstance *aInstance)`	`otError` 子が現在の親を維持したまま、より適切な保護者を検索するプロセスを開始します。
`otThreadSendAddressNotification(otInstance aInstance, otIp6Address aDestination, otIp6Address aTarget, otIp6InterfaceIdentifier aMlIid)`	`void` この関数は、Proactive Address Notification（ADDR_NTF.ntf）メッセージを送信する。
`otThreadSendDiagnosticGet(otInstance aInstance, const otIp6Address aDestination, const uint8_t aTlvTypes[], uint8_t aCount, otReceiveDiagnosticGetCallback aCallback, void *aCallbackContext)`	`otError` ネットワーク診断の取得リクエストを送信します。
`otThreadSendDiagnosticReset(otInstance aInstance, const otIp6Address aDestination, const uint8_t aTlvTypes[], uint8_t aCount)`	`otError` ネットワーク診断のリセットリクエストを送信します。
`otThreadSendProactiveBackboneNotification(otInstance aInstance, otIp6Address aTarget, otIp6InterfaceIdentifier *aMlIid, uint32_t aTimeSinceLastTransaction)`	`otError` この関数は、バックボーンリンクでプロアクティブなバックボーン通知（PRO_BB.ntf）メッセージを送信します。
`otThreadSetChildTimeout(otInstance *aInstance, uint32_t aTimeout)`	`void` 子ロールでの操作で使用されるスレッドの子タイムアウト（秒単位）を設定します。
`otThreadSetDiscoveryRequestCallback(otInstance aInstance, otThreadDiscoveryRequestCallback aCallback, void aContext)`	`void` この関数は、MLE Discovery リクエストデータを受信するコールバックを設定します。
`otThreadSetDomainName(otInstance aInstance, const char aDomainName)`	`otError` スレッドドメイン名を設定します。
`otThreadSetEnabled(otInstance *aInstance, bool aEnabled)`	`otError` この関数は、Thread プロトコルオペレーションを開始します。
`otThreadSetExtendedPanId(otInstance aInstance, const otExtendedPanId aExtendedPanId)`	`otError` IEEE 802.15.4 Extended PAN ID を設定します。
`otThreadSetFixedDuaInterfaceIdentifier(otInstance aInstance, const otIp6InterfaceIdentifier aIid)`	`otError` Thread ドメインのユニキャストアドレスに手動で指定されたインターフェース識別子を設定またはクリアします。
`otThreadSetJoinerAdvertisement(otInstance aInstance, uint32_t aOui, const uint8_t aAdvData, uint8_t aAdvDataLength)`	`otError` このメソッドは、Thread ネットワークを検出する際に Thread Joiner Advertisement を設定します。
`otThreadSetKeySequenceCounter(otInstance *aInstance, uint32_t aKeySequenceCounter)`	`void` thrKeySequenceCounter を設定します。
`otThreadSetKeySwitchGuardTime(otInstance *aInstance, uint32_t aKeySwitchGuardTime)`	`void` thrKeySwitchGuardTime を時間単位で設定します。
`otThreadSetLinkMode(otInstance *aInstance, otLinkModeConfig aConfig)`	`otError` MLE リンクモード構成を設定します。
`otThreadSetMeshLocalPrefix(otInstance aInstance, const otMeshLocalPrefix aMeshLocalPrefix)`	`otError` この関数は、メッシュローカルプレフィックスを設定します。
`otThreadSetNetworkKey(otInstance aInstance, const otNetworkKey aKey)`	`otError` Thread ネットワークキーを設定します。
`otThreadSetNetworkKeyRef(otInstance *aInstance, otNetworkKeyRef aKeyRef)`	`otError` Thread ネットワークキーを `otNetworkKeyRef` として設定します。
`otThreadSetNetworkName(otInstance aInstance, const char aNetworkName)`	`otError` Thread ネットワーク名を設定します。

構造体
otBorderRouterConfig	この構造は、ボーダールーター構成を表しています。
otExternalRouteConfig	この構造は外部ルートの構成を表します。
otIpCounters	この構造は IP レベルのカウンタを表します。
otLeaderData	この構造は Thread リーダーデータを表します。
otLinkModeConfig	この構造は MLE リンクモード構成を表します。
otMleCounters	この構造は Thread MLE カウンタを表します。
otNeighborInfo	この構造は、隣接する Thread ノードの診断情報を保持します。
otNetworkDiagChildEntry	この構造は、ネットワーク診断用の子テーブルのエントリを表します。
otNetworkDiagConnectivity	この構造は、ネットワーク診断接続の値を表します。
otNetworkDiagMacCounters	この構造は、ネットワーク診断の Mac カウンタ値を表します。
otNetworkDiagRoute	この構造は、ネットワーク診断ルートの TLV 値を表します。
otNetworkDiagRouteData	この構造は、ネットワーク診断ルートのデータを表します。
otNetworkDiagTlv	この構造はネットワーク診断 TLV を表します。
otRouterInfo	この構造は Thread Router の診断情報を保持します。
otServerConfig	この構造はサーバー構成を表します。
otServiceConfig	この構造は Service の構成を表します。
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`	Route64 の TLV。
`OT_NETWORK_DIAGNOSTIC_TLV_SHORT_ADDRESS`	Address16 TLV。
`OT_NETWORK_DIAGNOSTIC_TLV_SUPPLY_VOLTAGE`	供給電圧 TLV。
`OT_NETWORK_DIAGNOSTIC_TLV_TIMEOUT`	タイムアウト TLV（SED の最大ポーリング期間）
`OT_NETWORK_DIAGNOSTIC_TLV_TYPE_LIST`	リスト TLV を入力します。
`OT_NETWORK_DIAGNOSTIC_TLV_VERSION`	バージョン TLV。

OtDeviceRole

 otDeviceRole

Thread デバイスのロールを表します。

プロパティ
`OT_DEVICE_ROLE_CHILD`	Thread Child のロール。
`OT_DEVICE_ROLE_DETACHED`	現在、Thread ネットワーク/パーティションに参加していません。
`OT_DEVICE_ROLE_DISABLED`	Thread スタックが無効になっています。
`OT_DEVICE_ROLE_LEADER`	Thread リーダーのロール。
`OT_DEVICE_ROLE_ROUTER`	Thread Router のロール。

otNetDataPublisherEvent

 otNetDataPublisherEvent

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

プロパティ
`OT_NETDATA_PUBLISHER_EVENT_ENTRY_ADDED`	公開済みエントリが Thread ネットワークデータに追加されます。
`OT_NETDATA_PUBLISHER_EVENT_ENTRY_REMOVED`	パブリッシュされたエントリが Thread ネットワークデータから削除されます。

otRoutePreference

 otRoutePreference

otExternalRouteConfig と otBorderRouterConfig で mPreference の有効な値を定義します。

プロパティ
`OT_ROUTE_PREFERENCE_HIGH`	ルート設定が高い。
`OT_ROUTE_PREFERENCE_LOW`	ルート設定が低いです。
`OT_ROUTE_PREFERENCE_MED`	中程度のルート。

Typedef

otBorderRouterConfig

struct otBorderRouterConfig otBorderRouterConfig

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

otDetachGracefulCallback

void(* otDetachGracefullyCallback)(void *aContext)

このコールバックは、接続解除プロセスが完了したことをアプリケーションに通知します。

詳細

パラメータ

[in] aContext

アプリケーション固有のコンテキストへのポインタ。

otExternalRouteConfig

struct otExternalRouteConfig otExternalRouteConfig

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

OTI カウンタ

struct otIpCounters otIpCounters

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

otLeader データ

struct otLeaderData otLeaderData

この構造は Thread リーダーデータを表します。

otLinkModeConfig

struct otLinkModeConfig otLinkModeConfig

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

otMleCounters

struct otMleCounters otMleCounters

この構造は Thread MLE カウンタを表します。

otNeighborInfoIterator

int16_t otNeighborInfoIterator

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

otNetDataDnsSrpServicePublisherCallback

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

この関数ポインタタイプは、Thread ネットワークデータで「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)

この関数ポインタは、ネットワーク診断の取得レスポンスを受け取ると呼び出されます。

詳細

パラメータ

`[in] aError`	レスポンスを取得できませんでした。
`[in] aMessage`	受信したネットワーク診断取得レスポンスのペイロードを含むメッセージバッファへのポインタ。`aError` が `OT_ERROR_NONE` の場合にのみ使用できます。
`[in] aMessageInfo`	`aMessage` のメッセージ情報へのポインタ。`aError` が `OT_ERROR_NONE` の場合にのみ使用できます。
`[in] aContext`	アプリケーション固有のコンテキストへのポインタ。

otRoutePreference

enum otRoutePreference otRoutePreference

otExternalRouteConfig と otBorderRouterConfig で mPreference の有効な値を定義します。

otServerConfig

struct otServerConfig otServerConfig

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

otServiceConfig

struct otServiceConfig otServiceConfig

この構造は Service の構成を表します。

otThreadAnycastLocatorCallback

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

この関数ポインタ型は、otThreadLocateAnycastDestination() リクエストの結果を通知するコールバックを定義します。

詳細

パラメータ

`[in] aContext`	任意のコンテキストへのポインタ（コールバックの登録時に提供されます）。
`[in] aError`	リクエストの処理中にエラーが発生しました。OT_ERROR_NONE は成功を示します。OT_ERROR_DELAY_TIMEOUT は、目的地が見つからなかったことを示します。OT_ERROR_ABORT は、リクエストが中断されたことを示します。
`[in] aMeshLocalAddress`	`aError` が OT_ERROR_NONE、それ以外の場合は NULL の場合は、エニーキャストアドレスの最も近い宛先のメッシュローカル EID へのポインタ。
`[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] aInfo`	統計データを保持するスタック上の場所へのポインタ。
`[in] aContext`	コールバッククライアント固有のコンテキストへのポインタ。

otThreadParentResponseInfo

struct otThreadParentResponseInfo otThreadParentResponseInfo

この構造は MLE の親レスポンスデータを表します。

関数

otNetDataContainsOmrPrefix

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

特定の接頭辞が有効な OMR 接頭辞として機能し、リーダーのネットワークデータにもこの接頭辞が含まれているかどうかを確認します。

注: この API は OPENTHREAD_CONFIG_BORDER_ROUTING_ENABLE を使用している場合にのみ使用できます。

詳細

パラメータ

`[in] aInstance`	OpenThread インスタンスへのポインタ。
`[in] aPrefix`	IPv6 接頭辞へのポインタ。

戻り値

aPrefix が有効な OMR プレフィックスで、リーダーのネットワークデータに OMR プレフィックス aPrefix が含まれているかどうか。

otNetData 取得

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

パーティションの Thread ネットワークデータの完全なコピーまたは安定したコピーを提供します。

詳細

パラメータ

`[in] aInstance`	OpenThread インスタンスへのポインタ。
`[in] aStable`	安定版をコピーすると TRUE、完全版をコピーすると FALSE にします。
`[out] aData`	データバッファへのポインタ。
`[in,out] aDataLength`	入力時に、`aData` が指すデータバッファのサイズ。終了時にコピーされたバイト数。

戻り値

`OT_ERROR_NONE`	Thread ネットワークデータを `aData` にコピーし、`aDataLength` を更新しました。
`OT_ERROR_NO_BUFS`	`aData` に十分な空き容量がないため、Thread ネットワークデータを完全にコピーできません。

otNetDataGetLength

uint8_t otNetDataGetLength(
  otInstance *aInstance
)

パーティションのスレッドネットワークデータの現在の長さ（バイト数）を取得します。

詳細

パラメータ

[in] aInstance

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

戻り値

ネットワークデータの長さ。

otNetDataGetMaxLength

uint8_t otNetDataGetMaxLength(
  otInstance *aInstance
)

OT スタックの初期化または最後の otNetDataResetMaxLength() 呼び出し以降の Thread ネットワークデータの最大観測長を取得します。

詳細

パラメータ

[in] aInstance

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

戻り値

ネットワークデータの最大長（ネットワークデータの長さのハイウォーターマーク）。

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`	次のメッシュメッシュ接頭辞が見つかりました。
`OT_ERROR_NOT_FOUND`	後続のネットワークメッシュ接頭辞が Thread ネットワークデータに存在しない。

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`	以降の外部ルートエントリが Thread ネットワークデータに存在しない。

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 サービス」エントリが Thread ネットワークデータに追加されているかどうかを示します。

この機能を使用するには、機能 OPENTHREAD_CONFIG_TMF_NETDATA_SERVICE_ENABLE を有効にする必要があります。

詳細

パラメータ

[in] aInstance

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

戻り値

`TRUE`	公開済みの DNS/SRP Service エントリが Thread ネットワークデータに追加されます。
`FALSE`	このエントリは、Thread ネットワークデータに追加されていないか、公開するエントリがありません。

otNetDataIsPrefixAdded

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

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

この機能を使用するには、機能 OPENTHREAD_CONFIG_BORDER_ROUTER_ENABLE を有効にする必要があります。

詳細

パラメータ

`[in] aInstance`	OpenThread インスタンスへのポインタ。
`[in] aPrefix`	接頭辞へのポインタ（NULL にすることはできません）。

戻り値

`TRUE`	パブリッシュされたプレフィックスエントリが Thread ネットワークデータに追加されます。
`FALSE`	このエントリは、Thread ネットワークデータに追加されていないか、公開するエントリがありません。

otNetDataPublishDnsSrpServiceAnycast

void otNetDataPublishDnsSrpServiceAnycast(
  otInstance *aInstance,
  uint8_t aSequenceNUmber
)

この関数は、Thread ネットワークデータで「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
)

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

この機能を使用するには、機能 OPENTHREAD_CONFIG_TMF_NETDATA_SERVICE_ENABLE を有効にする必要があります。

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

詳細

パラメータ

`[in] aInstance`	OpenThread インスタンスへのポインタ。
`[in] aAddress`	公開する DNS/SRP サーバーのアドレス（NULL にすることはできません）。
`[in] aPort`	公開する SRP サーバーのポート番号。

otNetDataPublishDnsSrpServiceUnicastMeshLocalEid

void otNetDataPublishDnsSrpServiceUnicastMeshLocalEid(
  otInstance *aInstance,
  uint16_t aPort
)

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

この機能を使用するには、機能 OPENTHREAD_CONFIG_TMF_NETDATA_SERVICE_ENABLE を有効にする必要があります。

パブリックアドレスの指定を必須とし、Service TLV データに情報を含める otNetDataPublishDnsSrpServiceUnicast() とは異なり、この関数はデバイスのメッシュローカル EID を使用し、その情報を Server TLV データに含めます。

詳細

パラメータ

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

otNetDataPublishExternalRoute

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

この関数は、Thread ネットワークデータで公開される外部ルートプレフィックスをリクエストします。

この機能を使用するには、機能 OPENTHREAD_CONFIG_BORDER_ROUTER_ENABLE を有効にする必要があります。

公開できるのは安定したエントリ（aConfig.mStable は TRUE でなければなりません）。

その後このメソッドを呼び出すと、同じプレフィックスの以前のリクエストが置き換えられます。特に、新しい呼び出しでフラグ（設定レベルなど）のみが変更され、接頭辞がすでにネットワークデータに追加されている場合、フラグの変更はすぐにネットワークデータに反映されます。これにより、ネットワークデータの既存のエントリが突然削除されることがなくなります。設定レベルの変更により、同じまたはより高い設定の同じ接頭辞を公開している他のノードがあることを確認した後、ネットワークデータからそのエントリが削除される可能性があります。

詳細

パラメータ

`[in] aInstance`	OpenThread インスタンスへのポインタ。
`[in] aConfig`	公開する外部ルート構成（NULL にはできません）。

戻り値

`OT_ERROR_NONE`	外部ルートが正常に公開されました。
`OT_ERROR_INVALID_ARGS`	`aConfig` が無効です（接頭辞が間違っている、フラグの組み合わせが無効、安定していないなど）。
`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 は TRUE でなければなりません）。

詳細

パラメータ

`[in] aInstance`	OpenThread インスタンスへのポインタ。
`[in] aConfig`	公開するメッシュ上の接頭辞構成（NULL であってはなりません）。

戻り値

`OT_ERROR_NONE`	メッシュの接頭辞が正常に公開されました。
`OT_ERROR_INVALID_ARGS`	`aConfig` が無効です（接頭辞が間違っている、フラグの組み合わせが無効、安定していないなど）。
`OT_ERROR_NO_BUFS`	新しいリクエストにエントリを割り当てることができませんでした。ニュースメディアは、構成 `OPENTHREAD_CONFIG_NETDATA_PUBLISHER_MAX_PREFIX_ENTRIES` によって決定される限られた数のエントリ（メッシュ上のプレフィックスと外部ルートの間で共有）をサポートします。

otNetDataResetMaxLength

void otNetDataResetMaxLength(
  otInstance *aInstance
)

トラッキングされたスレッドネットワークデータの最大長をリセットします。

詳細

パラメータ

[in] aInstance

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

関連情報:
otNetDataGetMaxLength

otNetDataSetDnsSrpServicePublisherCallback

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

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

この関数を後で呼び出すと、以前に設定されたコールバック関数が置き換えられます。

この機能を使用するには、機能 OPENTHREAD_CONFIG_TMF_NETDATA_SERVICE_ENABLE を有効にする必要があります。

詳細

パラメータ

`[in] aInstance`	OpenThread インスタンスへのポインタ。
`[in] aCallback`	コールバック関数のポインタ（不要な場合は NULL にできます）。
`[in] aContext`	アプリケーション固有のコンテキストへのポインタ（`aCallback` が呼び出された場合）。

otNetDataSetPrefixPublisherCallback

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

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

この関数を後で呼び出すと、以前に設定されたコールバック関数が置き換えられます。

この機能を使用するには、機能 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`	Joiner の IEEE EUI-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`	Joiner Discerner へのポインタ。

戻り値

`OT_ERROR_NONE`	`aDiscerner` はステアリングデータに含まれています。
`OT_ERROR_INVALID_STATE`	ステアリングデータがありません。
`OT_ERROR_NOT_FOUND`	`aDiscerner` はステアリングデータに含まれていません。

otNetDataUnpublishDnsSrpService

void otNetDataUnpublishDnsSrpService(
  otInstance *aInstance
)

以前に追加した DNS/SRP（エニーキャストまたはユニキャスト）サービスのエントリを Thread ネットワークデータから公開停止します。

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`	公開リストに接頭辞がありません。

otThread を変更する子供

otError otThreadBecomeChild(
  otInstance *aInstance
)

子供として再接続してみる。

詳細

パラメータ

[in] aInstance

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

戻り値

`OT_ERROR_NONE`	子供になることができました。
`OT_ERROR_INVALID_STATE`	スレッドが無効になっています。

otThreadMakeDetached

otError otThreadBecomeDetached(
  otInstance *aInstance
)

Thread ネットワークから切断する。

詳細

パラメータ

[in] aInstance

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

戻り値

`OT_ERROR_NONE`	Thread ネットワークから正常に接続解除されました。
`OT_ERROR_INVALID_STATE`	スレッドが無効になっています。

otThreadDetachGraceful

otError otThreadDetachGracefully(
  otInstance *aInstance,
  otDetachGracefullyCallback aCallback,
  void *aContext
)

この関数は、ネットワーク内の他のノード（存在する場合）に通知し、Thread プロトコルオペレーションを停止します。

ルーターの場合はアドレスリリースを送信し、子の場合は子タイムアウトを 0 に設定します。

詳細

パラメータ

`[in] aInstance`	OpenThread インスタンスへのポインタ。
`[in] aCallback`	切断の終了時に呼び出される関数へのポインタ。
`[in] aContext`	コールバックアプリケーション固有のコンテキストへのポインタ。

戻り値

`OT_ERROR_NONE`	接続解除を開始しました。
`OT_ERROR_BUSY`	切断はすでに進行中です。

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
)

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

詳細

パラメータ

`[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 Discovery Response の受信またはスキャン完了時に呼び出される関数へのポインタ。
`[in] aCallbackContext`	アプリケーション固有のコンテキストへのポインタ。

戻り値

`OT_ERROR_NONE`	スレッド検出のスキャンが正常に開始されました。
`OT_ERROR_INVALID_STATE`	IPv6 インターフェースが有効になっていません（netif が稼働していません）。
`OT_ERROR_NO_BUFS`	検出リクエストにメッセージを割り当てることができませんでした。
`OT_ERROR_BUSY`	Thread Discovery のスキャンはすでに進行中です。

otThreadGetChildTimeout

uint32_t otThreadGetChildTimeout(
  otInstance *aInstance
)

子ロールで動作する際に使用されるスレッドの子タイムアウト（秒単位）を取得します。

詳細

パラメータ

[in] aInstance

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

戻り値

スレッドの子タイムアウト値（秒）。

関連情報:
otThreadSetChildTimeout

otThreadGetDeviceRole

otDeviceRole otThreadGetDeviceRole(
  otInstance *aInstance
)

デバイスのロールを取得します。

詳細

パラメータ

[in] aInstance

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

戻り値

`OT_DEVICE_ROLE_DISABLED`	Thread スタックが無効になっています。
`OT_DEVICE_ROLE_DETACHED`	デバイスは現在、Thread ネットワーク/パーティションに参加していません。
`OT_DEVICE_ROLE_CHILD`	デバイスは現在、Thread Child として動作しています。
`OT_DEVICE_ROLE_ROUTER`	デバイスは現在、Thread Router として動作しています。
`OT_DEVICE_ROLE_LEADER`	デバイスは現在、Thread リーダーとして動作しています。

otThreadGetDomainName

const char * otThreadGetDomainName(
  otInstance *aInstance
)

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

詳細

パラメータ

[in] aInstance

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

戻り値

スレッドドメイン名へのポインタ。

関連情報:
otThreadSetDomainName

otThreadGetExtendedPanId

const otExtendedPanId * otThreadGetExtendedPanId(
  otInstance *aInstance
)

IEEE 802.15.4 Extended PAN ID を取得します。

詳細

パラメータ

[in] aInstance

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

戻り値

IEEE 802.15.4 Extended PAN ID へのポインタ。

関連情報:
otThreadSetExtendedPanId

otThreadGetFixedDuaInterfaceIdentifier

const otIp6InterfaceIdentifier * otThreadGetFixedDuaInterfaceIdentifier(
  otInstance *aInstance
)

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

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
)

この関数は、Thread リーダーデータを取得します。

詳細

パラメータ

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

Thread リンクローカル IPv6 アドレスを取得します。

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

詳細

パラメータ

[in] aInstance

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

戻り値

Thread リンクローカル 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
)

Thread MLE カウンタを取得します。

詳細

パラメータ

[in] aInstance

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

戻り値

Thread MLE カウンタへのポインタ。

otThreadGetNetworkKey

void otThreadGetNetworkKey(
  otInstance *aInstance,
  otNetworkKey *aNetworkKey
)

Thread ネットワークキーを取得します。

詳細

パラメータ

`[in] aInstance`	OpenThread インスタンスへのポインタ。
`[out] aNetworkKey`	Thread ネットワークキーを返す `otNetworkkey` へのポインタ。

関連情報:
otThreadSetNetworkKey

otThreadGetNetworkKeyRef

otNetworkKeyRef otThreadGetNetworkKeyRef(
  otInstance *aInstance
)

Thread ネットワークキーの otNetworkKeyRef を取得します。

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

詳細

パラメータ

[in] aInstance

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

戻り値

メモリに保存されている Thread ネットワークキーへの参照。

関連情報:
otThreadSetNetworkKeyRef

otThreadGetNetworkName

const char * otThreadGetNetworkName(
  otInstance *aInstance
)

Thread ネットワーク名を取得します。

詳細

パラメータ

[in] aInstance

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

戻り値

Thread ネットワーク名へのポインタ。

関連情報:
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
)

この関数は、次の隣の情報を取得します。

これは、neighbor テーブルのエントリを経由するときに使用されます。

詳細

パラメータ

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

この関数は、Thread 親の平均 RSSI を取得します。

詳細

パラメータ

`[in] aInstance`	OpenThread インスタンスへのポインタ。
`[out] aParentRssi`	親 RSSI を配置する場所へのポインタ。

otThreadGetParentInfo

otError otThreadGetParentInfo(
  otInstance *aInstance,
  otRouterInfo *aParentInfo
)

この関数は、Thread ルーターの診断情報を親として取得します。

詳細

パラメータ

`[in] aInstance`	OpenThread インスタンスへのポインタ。
`[out] aParentInfo`	親ルーター情報が配置されている場所へのポインタ。

otThreadGetParentLastRssi

otError otThreadGetParentLastRssi(
  otInstance *aInstance,
  int8_t *aLastRssi
)

この関数は、Thread 親から最後のパケットの RSSI を取得します。

詳細

パラメータ

`[in] aInstance`	OpenThread インスタンスへのポインタ。
`[out] aLastRssi`	最後の RSSI の設置場所へのポインタ。

戻り値

`OT_ERROR_NONE`	RSSI データを取得しました。
`OT_ERROR_FAILED`	RSSI データを取得できません。
`OT_ERROR_INVALID_ARGS`	`aLastRssi` が NULL である。

otThreadGetPartitionId

uint32_t otThreadGetPartitionId(
  otInstance *aInstance
)

パーティション ID を取得します。

詳細

パラメータ

[in] aInstance

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

戻り値

パーティション ID。

otThreadGetRealmLocalAllThreadNodesMulticastAddress

const otIp6Address * otThreadGetRealmLocalAllThreadNodesMulticastAddress(
  otInstance *aInstance
)

スレッドレルムローカルすべてのスレッドノードのマルチキャストアドレスを取得します。

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

flgs を 3 に設定（P = 1、T = 1）
スコープを 3 に設定
plen を 64 に設定
メッシュローカルプレフィックスに設定されたネットワークプレフィックス
グループ ID を 1 に設定

詳細

パラメータ

[in] aInstance

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

戻り値

スレッドレルムローカルすべてのスレッドノードのマルチキャストアドレスへのポインタ。

otThreadGetRloc

const otIp6Address * otThreadGetRloc(
  otInstance *aInstance
)

Thread ルーティングロケーター（RLOC）のアドレスを取得します。

詳細

パラメータ

[in] aInstance

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

戻り値

Thread ルーティングロケータ（RLOC）アドレスへのポインタ。

otThreadGetRloc16

uint16_t otThreadGetRloc16(
  otInstance *aInstance
)

RLOC16 を取得します。

詳細

パラメータ

[in] aInstance

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

戻り値

RLOC16。

otThreadGetServiceAloc

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

この関数は、指定されたサービス ID のサービス ALOC を取得します。

詳細

パラメータ

`[in] aInstance`	OpenThread インスタンスへのポインタ。
`[in] aServiceId`	ALOC を取得するサービス ID。
`[out] aServiceAloc`	Service ALOC を出力するためのポインタ。NULL にすることはできません。

戻り値

`OT_ERROR_NONE`	Service ALOC を取得しました。
`OT_ERROR_DETACHED`	現在、Thread インターフェースは Thread パーティションには接続されていません。

otThreadGetVersion

uint16_t otThreadGetVersion(
  void
)

この関数は、Thread プロトコルバージョンを取得します。

詳細
戻り値	スレッドプロトコルバージョン。

otThreadIsAnycastLocateInProgress

bool otThreadIsAnycastLocateInProgress(
  otInstance *aInstance
)

この関数は、エニーキャスト検索リクエストが現在進行中かどうかを示します。

この機能は、OPENTHREAD_CONFIG_TMF_ANYCAST_LOCATOR_ENABLE が有効になっている場合にのみ使用できます。

詳細

パラメータ

[in] aInstance

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

戻り値

エニーキャスト位置情報リクエストが現在進行中の場合は TRUE、そうでない場合は FALSE。

otThreadIsDiscoverInProgress

bool otThreadIsDiscoverInProgress(
  otInstance *aInstance
)

この関数は、MLE スレッドの検出が現在進行中かどうかを判断します。

詳細

パラメータ

[in] aInstance

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

otThreadIsSingleton

bool otThreadIsSingleton(
  otInstance *aInstance
)

この関数は、ノードがネットワーク上の唯一のルーターであるかどうかを示します。

詳細

パラメータ

[in] aInstance

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

戻り値

`TRUE`	ネットワーク内で唯一のルーターです。
`FALSE`	子ネットワークであるか、ネットワーク内の単一のルーターではない。

otThreadLocateAnycastDestination

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

この関数は、特定のエニーキャストアドレスに最も近い目的地をリクエストします。

この機能は、OPENTHREAD_CONFIG_TMF_ANYCAST_LOCATOR_ENABLE が有効になっている場合にのみ使用できます。

前のリクエストが進行中の場合、この関数への後続の呼び出しは、前のリクエストをキャンセルして置き換えます。

詳細

パラメータ

`[in] aInstance`	OpenThread インスタンスへのポインタ。
`[in] aAnycastAddress`	検索するエニーキャストアドレス。NULL にすることはできません。
`[in] aCallback`	結果をレポートするコールバック関数。
`[in] aContext`	`aCallback` で使用される任意のコンテキスト。

戻り値

`OT_ERROR_NONE`	リクエストが正常に開始されました。`aCallback` が呼び出され、結果が報告されます。
`OT_ERROR_INVALID_ARGS`	`aAnycastAddress` は有効なエニーキャストアドレスでないか、`aCallback` が NULL です。
`OT_ERROR_NO_BUFS`	リクエストメッセージを準備して送信するためのバッファが不足しています。

otThreadRegisterParentResponseCallback

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

この関数は、MLE の親レスポンスデータを受け取るコールバックを登録します。

詳細

パラメータ

`[in] aInstance`	OpenThread インスタンスへのポインタ。
`[in] aCallback`	MLE 親レスポンスメッセージを受信したときに呼び出される関数へのポインタ。
`[in] aContext`	コールバッククライアント固有のコンテキストへのポインタ。

otThreadResetIp6Counters

void otThreadResetIp6Counters(
  otInstance *aInstance
)

IPv6 カウンタをリセットします。

詳細

パラメータ

[in] aInstance

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

otThreadResetMleCounters

void otThreadResetMleCounters(
  otInstance *aInstance
)

Thread MLE カウンタをリセットします。

詳細

パラメータ

[in] aInstance

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

otThreadSearchForBetterParent

otError otThreadSearchForBetterParent(
  otInstance *aInstance
)

子が現在の親を維持したまま、より適切な保護者を検索するプロセスを開始します。

子供としてデバイスを装着する場合に使用します。

詳細

戻り値

`OT_ERROR_NONE`	より良い保護者を探すプロセスを開始しました。
`OT_ERROR_INVALID_STATE`	デバイスのロールが子ではありません。

otThreadSendAddressNotification

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

この関数は、Proactive Address Notification（ADDR_NTF.ntf）メッセージを送信する。

この機能は、OPENTHREAD_CONFIG_REFERENCE_DEVICE_ENABLE が有効になっている場合にのみ使用できます。

詳細

パラメータ

`[in] aInstance`	OpenThread インスタンスへのポインタ。
`[in] aDestination`	ADDR_NTF.ntf メッセージを送信する宛先。
`[in] aTarget`	ADDR_NTF.ntf メッセージのターゲットアドレス。
`[in] aMlIid`	ADDR_NTF.ntf メッセージの ML-IID。

otThreadSendDiagnosticGet

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

ネットワーク診断の取得リクエストを送信します。

詳細

パラメータ

`[in] aInstance`	OpenThread インスタンスへのポインタ。
`[in] aDestination`	宛先アドレスへのポインタ。
`[in] aTlvTypes`	ネットワーク診断 TLV 型の配列。
`[in] aCount`	aTlvTypes のタイプの数。
`[in] aCallback`	ネットワーク診断の取得レスポンスを受け取ったときに呼び出される関数へのポインタ。コールバックを無効にする場合は NULL。
`[in] aCallbackContext`	アプリケーション固有のコンテキストへのポインタ。

戻り値

`OT_ERROR_NONE`	DIAG_GET.req をキューに登録しました。
`OT_ERROR_NO_BUFS`	DIAG_GET.req を送信するのに十分なメッセージバッファがありません。

otThreadSendDiagnosticReset

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

ネットワーク診断のリセットリクエストを送信します。

詳細

パラメータ

`[in] aInstance`	OpenThread インスタンスへのポインタ。
`[in] aDestination`	宛先アドレスへのポインタ。
`[in] aTlvTypes`	ネットワーク診断 TLV 型の配列。現在のところ、使用できるのはタイプ 9 のみです。
`[in] aCount`	aTlvTypes のタイプ数

戻り値

`OT_ERROR_NONE`	DIAG_RST.ntf のキューを作成しました。
`OT_ERROR_NO_BUFS`	DIAG_RST.ntf を送信するためにメッセージバッファが不足しています。

otThreadSendProactiveBackboneNotification

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

この関数は、バックボーンリンクでプロアクティブなバックボーン通知（PRO_BB.ntf）メッセージを送信します。

この機能は、OPENTHREAD_CONFIG_REFERENCE_DEVICE_ENABLE が有効になっている場合にのみ使用できます。

詳細

パラメータ

`[in] aInstance`	OpenThread インスタンスへのポインタ。
`[in] aTarget`	PRO_BB.ntf メッセージのターゲットアドレス。
`[in] aMlIid`	PRO_BB.ntf メッセージの ML-IID。
`[in] aTimeSinceLastTransaction`	最後のトランザクションからの時間（秒単位）。

戻り値

`OT_ERROR_NONE`	バックボーンリンクで PRO_BB.ntf を送信しました。
`OT_ERROR_NO_BUFS`	メッセージバッファが不足している場合。

otThreadSetChildTimeout

void otThreadSetChildTimeout(
  otInstance *aInstance,
  uint32_t aTimeout
)

子ロールでの操作で使用されるスレッドの子タイムアウト（秒単位）を設定します。

詳細

パラメータ

`[in] aInstance`	OpenThread インスタンスへのポインタ。
`[in] aTimeout`	タイムアウト値（秒）。

関連情報:
otThreadGetChildTimeout

otThreadSetDiscoveryRequestCallback

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

この関数は、MLE Discovery リクエストデータを受信するコールバックを設定します。

詳細

パラメータ

`[in] aInstance`	OpenThread インスタンスへのポインタ。
`[in] aCallback`	MLE Discovery Request を受信したときに呼び出される関数へのポインタ。
`[in] aContext`	コールバックアプリケーション固有のコンテキストへのポインタ。

otThreadSetDomainName

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

スレッドドメイン名を設定します。

スレッドプロトコルが無効になっている場合にのみ成功します。

詳細

パラメータ

`[in] aInstance`	OpenThread インスタンスへのポインタ。
`[in] aDomainName`	スレッドドメイン名へのポインタ。

戻り値

`OT_ERROR_NONE`	スレッドドメイン名が正常に設定されました。
`OT_ERROR_INVALID_STATE`	スレッドプロトコルが有効になっています。

関連情報:
otThreadGetDomainName

otThreadSetEnabled

otError otThreadSetEnabled(
  otInstance *aInstance,
  bool aEnabled
)

この関数は、Thread プロトコルオペレーションを開始します。

この関数を呼び出すときはインターフェースを起動する必要があります。

aEnabled を FALSE に設定してこの関数を呼び出すと、otThreadDetachGraceful() によって開始される切断の進行中のプロセスがすべて停止されます。そのコールバックが呼び出されます。

詳細

パラメータ

`[in] aInstance`	OpenThread インスタンスへのポインタ。
`[in] aEnabled`	スレッドが有効になっている場合は TRUE、それ以外の場合は FALSE。

戻り値

`OT_ERROR_NONE`	Thread プロトコルオペレーションを開始しました。
`OT_ERROR_INVALID_STATE`	ネットワークインターフェースが稼働していませんでした。

otThreadSetExtendedPanId

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

IEEE 802.15.4 Extended PAN ID を設定します。

詳細

パラメータ

`[in] aInstance`	OpenThread インスタンスへのポインタ。
`[in] aExtendedPanId`	IEEE 802.15.4 Extended PAN ID へのポインタ。

戻り値

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

関連情報:
otThreadGetExtendedPanId

otThreadSetFixedDuaInterfaceIdentifier

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

Thread ドメインのユニキャストアドレスに手動で指定されたインターフェース識別子を設定またはクリアします。

OPENTHREAD_CONFIG_DUA_ENABLE が有効になっている場合に利用可能です。

詳細

パラメータ

`[in] aInstance`	OpenThread インスタンスへのポインタ。
`[in] aIid`	設定するインターフェース識別子へのポインタ。クリアする場合は NULL。

戻り値

`OT_ERROR_NONE`	インターフェース識別子を設定またはクリアしました。
`OT_ERROR_INVALID_ARGS`	指定されたインターフェース識別子は予約されています。

関連情報:
otThreadGetFixedDuaInterfaceIdentifier

otThreadSetJoinerAdvertising

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

このメソッドは、Thread ネットワークを検出する際に Thread Joiner Advertisement を設定します。

Thread Joiner Advertisement は、新たに提案された Joiner Advertisement TLV を通じて Joiner が独自のアプリケーション固有の情報（ベンダー ID、プロダクト ID、Discriminator など）をアドバタイズして、この情報がコミッショナーまたはコミッショナーの候補に人間によるやり取りなしで利用できるようにするために使用されます。

詳細

パラメータ

`[in] aInstance`	OpenThread インスタンスへのポインタ。
`[in] aOui`	Joiner Advertisement に含まれるベンダー IEEE OUI 値。最小の 3 バイトのみが使用され、最上位のバイトは無視されます。
`[in] aAdvData`	Joiner Advertisement に含まれる AdvData へのポインタ。
`[in] aAdvDataLength`	AdvData の長さ（バイト単位）

戻り値

`OT_ERROR_NONE`	Joiner Advertising を設定しました。
`OT_ERROR_INVALID_ARGS`	無効な AdvData です。

otThreadSetKeySequenceCounter

void otThreadSetKeySequenceCounter(
  otInstance *aInstance,
  uint32_t aKeySequenceCounter
)

thrKeySequenceCounter を設定します。

詳細

パラメータ

`[in] aInstance`	OpenThread インスタンスへのポインタ。
`[in] aKeySequenceCounter`	thrKeySequenceCounter 値。

関連情報:
otThreadGetKeySequenceCounter

otThreadSetKeySwitchGuardTime

void otThreadSetKeySwitchGuardTime(
  otInstance *aInstance,
  uint32_t aKeySwitchGuardTime
)

thrKeySwitchGuardTime を時間単位で設定します。

詳細

パラメータ

`[in] aInstance`	OpenThread インスタンスへのポインタ。
`[in] aKeySwitchGuardTime`	thrKeySwitchGuardTime の値（時間）。

関連情報:
otThreadGetKeySwitchGuardTime

otThreadSetLinkMode

otError otThreadSetLinkMode(
  otInstance *aInstance,
  otLinkModeConfig aConfig
)

MLE リンクモード構成を設定します。

詳細

パラメータ

`[in] aInstance`	OpenThread インスタンスへのポインタ。
`[in] aConfig`	リンクモード設定へのポインタ。

戻り値

OT_ERROR_NONE

MLE リンクモードの構成を設定しました。

関連情報:
otThreadGetLinkMode

otThreadSetMeshLocalPrefix

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

この関数は、メッシュローカルプレフィックスを設定します。

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

詳細

パラメータ

`[in] aInstance`	OpenThread インスタンスへのポインタ。
`[in] aMeshLocalPrefix`	メッシュローカルプレフィックスへのポインタ。

戻り値

`OT_ERROR_NONE`	メッシュのローカルプレフィックスが正常に設定されました。
`OT_ERROR_INVALID_STATE`	スレッドプロトコルが有効になっています。

otThreadSetNetworkKey

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

Thread ネットワークキーを設定します。

詳細

パラメータ

`[in] aInstance`	OpenThread インスタンスへのポインタ。
`[in] aKey`	Thread ネットワークキーを含むバッファへのポインタ。

戻り値

`OT_ERROR_NONE`	Thread ネットワークキーが正常に設定されました。
`OT_ERROR_INVALID_STATE`	スレッドプロトコルが有効になっています。

関連情報:
otThreadGetNetworkKey

otThreadSetNetworkKeyRef

otError otThreadSetNetworkKeyRef(
  otInstance *aInstance,
  otNetworkKeyRef aKeyRef
)

Thread ネットワークキーを otNetworkKeyRef として設定します。

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

詳細

パラメータ

`[in] aInstance`	OpenThread インスタンスへのポインタ。
`[in] aKeyRef`	Thread ネットワークキーへの参照。

戻り値

`OT_ERROR_NONE`	Thread ネットワークキーが正常に設定されました。
`OT_ERROR_INVALID_STATE`	スレッドプロトコルが有効になっています。

関連情報:
otThreadGetNetworkKeyRef

otThreadSetNetworkName

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

Thread ネットワーク名を設定します。

詳細

パラメータ

`[in] aInstance`	OpenThread インスタンスへのポインタ。
`[in] aNetworkName`	Thread ネットワーク名へのポインタ。

戻り値

`OT_ERROR_NONE`	Thread ネットワーク名が正常に設定されました。
`OT_ERROR_INVALID_STATE`	スレッドプロトコルが有効になっています。

関連情報:
otThreadGetNetworkName

マクロ

OT_JOINER_ADVDATA_MAX_LENGTH

 OT_JOINER_ADVDATA_MAX_LENGTH 64

Joiner アドバタイズの最大 AdvData の長さ。

OT_NEIGHBOR_INFO_ITERATOR_INIT

 OT_NEIGHBOR_INFO_ITERATOR_INIT 0

otNeighborInfoIterator の初期化子。

OT_NETWORK_BASE_TLV_MAX_LENGTH

 OT_NETWORK_BASE_TLV_MAX_LENGTH 254

スレッドベース TLV の最大長。

OT_NETWORK_DATA_ITERATOR_INIT

 OT_NETWORK_DATA_ITERATOR_INIT 0

otNetworkDataIterator を初期化する値。

OT_NETWORK_DIAGNOSTIC_CHILD_TABLE_ENTRY_SIZE

 OT_NETWORK_DIAGNOSTIC_CHILD_TABLE_ENTRY_SIZE 3

ネットワーク診断用の子テーブルのエントリのサイズ。

OT_NETWORK_DIAGNOSTIC_ITERATOR_INIT

 OT_NETWORK_DIAGNOSTIC_ITERATOR_INIT 0

otNetworkDiagIterator の初期化子。

OT_NETWORK_DIAGNOSTIC_TYPELIST_MAX_ENTRIES

 OT_NETWORK_DIAGNOSTIC_TYPELIST_MAX_ENTRIES 19

リクエストまたはリセットするネットワーク診断 TLV タイプの最大数。

OT_NETWORK_MAX_ROUTER_ID

 OT_NETWORK_MAX_ROUTER_ID 62

最大ルーター ID。

OT_SERVER_DATA_MAX_SIZE

 OT_SERVER_DATA_MAX_SIZE 248

サーバーデータの最大サイズ（バイト単位）。理論上の上限は、実際よりもはるかに低くなります。

OT_SERVICE_DATA_MAX_SIZE

 OT_SERVICE_DATA_MAX_SIZE 252

サービスデータの最大サイズ（バイト単位）。

リソース

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

一般

まとめ

列挙型

Typedef

関数

構造体

列挙型

匿名列挙型

OtDeviceRole

otNetDataPublisherEvent

otRoutePreference

Typedef

otBorderRouterConfig

otDetachGracefulCallback

otExternalRouteConfig

OTI カウンタ

otLeader データ

otLinkModeConfig

otMleCounters

otNeighborInfoIterator

otNetDataDnsSrpServicePublisherCallback

otNetDataPrefixPublisherCallback

otNetDataPublisherEvent

otNetworkDataIterator

otNetworkDiagChildEntry

otNetworkDiagConnectivity

otNetworkDiagIterator

otNetworkDiagMacCounters

otNetworkDiagRoute

otNetworkDiagRouteData

otNetworkDiagTlv

otReceiveDiagnosticGetCallback

otRoutePreference

otServerConfig

otServiceConfig

otThreadAnycastLocatorCallback

otThreadDiscoveryRequestCallback

otThreadDiscoveryRequestInfo

otThreadParentResponseCallback

otThreadParentResponseInfo

関数

otNetDataContainsOmrPrefix

otNetData 取得

otNetDataGetLength

otNetDataGetMaxLength

otNetDataGetNextOnMeshPrefix

otNetDataGetNextRoute

otNetDataGetNextService

otNetDataGetStableVersion

otNetDataGetVersion

otNetDataIsDnsSrpServiceAdded

otNetDataIsPrefixAdded

otNetDataPublishDnsSrpServiceAnycast

otNetDataPublishDnsSrpServiceUnicast

otNetDataPublishDnsSrpServiceUnicastMeshLocalEid

otNetDataPublishExternalRoute

otNetDataPublishOnMeshPrefix

otNetDataResetMaxLength

otNetDataSetDnsSrpServicePublisherCallback

otNetDataSetPrefixPublisherCallback

otNetDataSteeringDataCheckJoiner

otNetDataSteeringDataCheckJoinerWithDiscerner

otNetDataUnpublishDnsSrpService

otNetDataUnpublishPrefix

otThread を変更する子供

otThreadMakeDetached

otThreadDetachGraceful

otThreadDeviceRoleToString

OTThreadDiscover

otThreadGetChildTimeout

otThreadGetDeviceRole

otThreadGetDomainName

otThreadGetExtendedPanId

otThreadGetFixedDuaInterfaceIdentifier

otThreadGetIp6Counters

otThreadGetKeySequenceCounter

otThreadGetKeySwitchGuardTime

otThreadGetLeaderData

otThreadGetLeaderRloc

otThreadGetLeaderRouterId