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

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

全般

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

概要

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

このモジュールのすべての関数で 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, OT_NETWORK_DIAGNOSTIC_TLV_VENDOR_NAME = 25, OT_NETWORK_DIAGNOSTIC_TLV_VENDOR_MODEL = 26, OT_NETWORK_DIAGNOSTIC_TLV_VENDOR_SW_VERSION = 27, OT_NETWORK_DIAGNOSTIC_TLV_THREAD_STACK_VERSION = 28, OT_NETWORK_DIAGNOSTIC_TLV_CHILD = 29, OT_NETWORK_DIAGNOSTIC_TLV_CHILD_IP6_ADDR_LIST = 30, OT_NETWORK_DIAGNOSTIC_TLV_ROUTER_NEIGHBOR = 31, OT_NETWORK_DIAGNOSTIC_TLV_ANSWER = 32, OT_NETWORK_DIAGNOSTIC_TLV_QUERY_ID = 33, OT_NETWORK_DIAGNOSTIC_TLV_MLE_COUNTERS = 34 }	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` スレッドリーダーデータを表します。
`otLinkModeConfig`	typedef `struct otLinkModeConfig` MLE リンクモード構成を表します。
`otLowpanContextInfo`	typedef `struct otLowpanContextInfo` ネットワークデータのプレフィックスに関連付けられた 6LoWPAN コンテキスト ID 情報を表します。
`otMleCounters`	typedef `struct otMleCounters` スレッド MLE カウンタを表します。
`otNeighborInfoIterator`	typedef `int16_t` 近傍テーブルを反復処理するために使用されます。
`otNetDataDnsSrpServicePublisherCallback)(otNetDataPublisherEvent aEvent, void *aContext)`	typedef `void(*` ポインタの種類は、「DNS/SRP サービス」エントリが Thread ネットワークデータに対して追加または削除されたときの通知に使用するコールバックを定義します。
`otNetDataPrefixPublisherCallback)(otNetDataPublisherEvent aEvent, const otIp6Prefix aPrefix, void aContext)`	typedef `void(*` ポインタの種類は、プレフィックス（メッシュまたは外部ルート）のエントリが Thread ネットワークデータに追加またはスレッドネットワークデータから削除されたときに通知するコールバックを定義します。
`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 カウンタの値を表します。
`otNetworkDiagMleCounters`	typedef `struct otNetworkDiagMleCounters` ネットワーク診断 MLE カウンタの値を表します。
`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(*` Network Diagnostic Get のレスポンスを受信すると、ポインタが呼び出されます。
`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 の親レスポンスデータを表します。

関数
`otConvertDurationInSecondsToString(uint32_t aDuration, char *aBuffer, uint16_t aSize)`	`void` `uint32_t` 期間（秒単位）を人が読める文字列に変換します。
`otNetDataContainsOmrPrefix(otInstance aInstance, const otIp6Prefix aPrefix)`	`bool` 指定されたプレフィックスが有効な OMR プレフィックスとして機能でき、リーダーのネットワークデータにもこのプレフィックスが含まれているかどうかを確認します。
`otNetDataGet(otInstance aInstance, bool aStable, uint8_t aData, uint8_t *aDataLength)`	`otError` パーティションのスレッドネットワークデータの完全版または安定したコピーを提供します。
`otNetDataGetCommissioningDataset(otInstance aInstance, otCommissioningDataset aDataset)`	`void` パーティションのネットワークデータからコミッショニングデータセットを取得します。
`otNetDataGetLength(otInstance *aInstance)`	`uint8_t` パーティションのスレッドネットワークデータの現在の長さ（バイト数）を取得します。
`otNetDataGetMaxLength(otInstance *aInstance)`	`uint8_t` OT スタックの初期化以降、または最後の `otNetDataResetMaxLength()` 呼び出し以降のスレッドネットワークデータの観測最大長を取得します。
`otNetDataGetNextLowpanContextInfo(otInstance aInstance, otNetworkDataIterator aIterator, otLowpanContextInfo *aContextInfo)`	`otError` パーティションのネットワークデータから、次の 6LoWPAN コンテキスト ID の情報を取得します。
`otNetDataGetNextOnMeshPrefix(otInstance aInstance, otNetworkDataIterator aIterator, otBorderRouterConfig *aConfig)`	`otError` パーティションのネットワークデータの次の On Mesh プレフィックスを取得します。
`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` 「DNS/SRP サービスエニーキャストアドレス」を Thread ネットワークデータで公開するようリクエストします。
`otNetDataPublishDnsSrpServiceUnicast(otInstance aInstance, const otIp6Address aAddress, uint16_t aPort)`	`void` 「DNS/SRP Service Unicast Address」を Thread ネットワークデータで公開するようリクエストします。
`otNetDataPublishDnsSrpServiceUnicastMeshLocalEid(otInstance *aInstance, uint16_t aPort)`	`void` 「DNS/SRP Service Unicast Address」を Thread ネットワークデータで公開するようリクエストします。
`otNetDataPublishExternalRoute(otInstance aInstance, const otExternalRouteConfig aConfig)`	`otError` Thread ネットワークデータに外部ルートプレフィックスを公開するようリクエストします。
`otNetDataPublishOnMeshPrefix(otInstance aInstance, const otBorderRouterConfig aConfig)`	`otError` スレッドネットワークデータでメッシュ上のプレフィックスを公開するようリクエストします。
`otNetDataReplacePublishedExternalRoute(otInstance aInstance, const otIp6Prefix aPrefix, const otExternalRouteConfig *aConfig)`	`otError` Thread ネットワークデータで以前に公開された外部ルートを置き換えます。
`otNetDataResetMaxLength(otInstance *aInstance)`	`void` Thread ネットワークデータのトラッキングされている最大長をリセットします。
`otNetDataSetDnsSrpServicePublisherCallback(otInstance aInstance, otNetDataDnsSrpServicePublisherCallback aCallback, void aContext)`	`void` 公開された「DNS/SRP サービス」が実際に Thread ネットワークデータに追加または Thread ネットワークデータから削除されたときに通知するためのコールバックを設定します。
`otNetDataSetPrefixPublisherCallback(otInstance aInstance, otNetDataPrefixPublisherCallback aCallback, void aContext)`	`void` 公開されたプレフィックスエントリが Thread ネットワークデータに対して実際に追加または削除されたときに通知するコールバックを設定します。
`otNetDataSteeringDataCheckJoiner(otInstance aInstance, const otExtAddress aEui64)`	`otError` ステアリングデータに Joiner が含まれているかどうかを確認します。
`otNetDataSteeringDataCheckJoinerWithDiscerner(otInstance aInstance, const struct otJoinerDiscerner aDiscerner)`	`otError` ステアリングデータに、特定の識別値を持つ Joiner が含まれているかどうかを確認します。
`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` ネットワーク内の他のノードに通知して（存在する場合）、スレッドプロトコルオペレーションを停止します。
`otThreadDeviceRoleToString(otDeviceRole aRole)`	`const char *` デバイスロールを人が読める文字列に変換します。
`otThreadDiscover(otInstance aInstance, uint32_t aScanChannels, uint16_t aPanId, bool aJoiner, bool aEnableEui64Filtering, otHandleActiveScanResult aCallback, void aCallbackContext)`	`otError` スレッド検出スキャンを開始します。
`otThreadGetChildTimeout(otInstance *aInstance)`	`uint32_t` 子ロールで操作する際に使用されるスレッドの子タイムアウト（秒単位）を取得します。
`otThreadGetDeviceRole(otInstance *aInstance)`	`otDeviceRole` デバイスのロールを取得します。
`otThreadGetDomainName(otInstance *aInstance)`	`const char *` Thread ドメイン名を取得します。
`otThreadGetExtendedPanId(otInstance *aInstance)`	`const otExtendedPanId *` IEEE 802.15.4 拡張 PAN ID を取得します。
`otThreadGetFixedDuaInterfaceIdentifier(otInstance *aInstance)`	`const otIp6InterfaceIdentifier *` スレッドドメインのユニキャストアドレスに手動で指定されたインターフェース ID を取得します。
`otThreadGetIp6Counters(otInstance *aInstance)`	`const otIpCounters *` IPv6 カウンタを取得します。
`otThreadGetKeySequenceCounter(otInstance *aInstance)`	`uint32_t` thrKeySequenceCounter を取得します。
`otThreadGetKeySwitchGuardTime(otInstance *aInstance)`	`uint32_t` thrKeySwitchGuardTime（時間単位）を取得します。
`otThreadGetLeaderData(otInstance aInstance, otLeaderData aLeaderData)`	`otError` スレッドリーダーのデータを取得します。
`otThreadGetLeaderRloc(otInstance aInstance, otIp6Address aLeaderRloc)`	`otError` リーダーの RLOC へのポインタを返します。
`otThreadGetLeaderRouterId(otInstance *aInstance)`	`uint8_t` リーダーのルーター ID を取得します。
`otThreadGetLeaderWeight(otInstance *aInstance)`	`uint8_t` リーダーの体重をゲットしましょう。
`otThreadGetLinkLocalAllThreadNodesMulticastAddress(otInstance *aInstance)`	`const otIp6Address *` Thread Link-Local All Thread Nodes マルチキャストアドレスを取得します。
`otThreadGetLinkLocalIp6Address(otInstance *aInstance)`	`const otIp6Address *` Thread のリンクローカル IPv6 アドレスを取得します。
`otThreadGetLinkMode(otInstance *aInstance)`	`otLinkModeConfig` MLE リンクモードの構成を取得します。
`otThreadGetMaxTimeInQueue(otInstance *aInstance)`	`uint32_t` TX キュー内のメッセージの最大キュー内時間を取得します。
`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` この関数は、スレッドの親の平均 RSSI を取得します。
`otThreadGetParentInfo(otInstance aInstance, otRouterInfo aParentInfo)`	`otError` この関数は、親として Thread Router の診断情報を取得します。
`otThreadGetParentLastRssi(otInstance aInstance, int8_t aLastRssi)`	`otError` この関数は、スレッドの親から最後のパケットの 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)`	`otError` 指定された Service ID のサービス ALOC を取得します。
`otThreadGetTimeInQueueHistogram(otInstance aInstance, uint16_t aNumBins, uint32_t *aBinInterval)`	`const uint32_t *` TX キュー内のメッセージについて、キュー内時間ヒストグラムを取得します。
`otThreadGetVendorModel(otInstance *aInstance)`	`const char *` ベンダーモデル文字列を取得します。
`otThreadGetVendorName(otInstance *aInstance)`	`const char *` ベンダー名の文字列を取得します。
`otThreadGetVendorSwVersion(otInstance *aInstance)`	`const char *` ベンダーのソフトウェアバージョン文字列を取得します。
`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 カウンタをリセットします。
`otThreadResetTimeInQueueStat(otInstance *aInstance)`	`void` TX キューのキュー内時間統計情報をリセットします。
`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 検出リクエストデータを受信するコールバックを設定します。
`otThreadSetDomainName(otInstance aInstance, const char aDomainName)`	`otError` スレッドのドメイン名を設定します。
`otThreadSetEnabled(otInstance *aInstance, bool aEnabled)`	`otError` スレッドプロトコルオペレーションを開始します。
`otThreadSetExtendedPanId(otInstance aInstance, const otExtendedPanId aExtendedPanId)`	`otError` IEEE 802.15.4 拡張 PAN ID を設定します。
`otThreadSetFixedDuaInterfaceIdentifier(otInstance aInstance, const otIp6InterfaceIdentifier aIid)`	`otError` スレッドドメインユニキャストアドレスに手動で指定されたインターフェース識別子を設定またはクリアします。
`otThreadSetJoinerAdvertisement(otInstance aInstance, uint32_t aOui, const uint8_t aAdvData, uint8_t aAdvDataLength)`	`otError` Thread ネットワークを検出する際の Thread Joiner アドバタイズメントを設定します。
`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 ネットワーク名を設定します。
`otThreadSetVendorModel(otInstance aInstance, const char aVendorModel)`	`otError` ベンダーのモデル文字列を設定します。
`otThreadSetVendorName(otInstance aInstance, const char aVendorName)`	`otError` ベンダー名の文字列を設定します。
`otThreadSetVendorSwVersion(otInstance aInstance, const char aVendorSwVersion)`	`otError` ベンダーのソフトウェアバージョン文字列を設定します。

構造体
otBorderRouterConfig	ボーダールーターの構成を表します。
otExternalRouteConfig	外部ルートの構成を表します。
otIpCounters	IP レベルのカウンタを表します。
otLeaderData	スレッドリーダーデータを表します。
otLinkModeConfig	MLE リンクモード構成を表します。
otLowpanContextInfo	ネットワークデータのプレフィックスに関連付けられた 6LoWPAN コンテキスト ID 情報を表します。
otMleCounters	スレッド MLE カウンタを表します。
otNeighborInfo	隣接するスレッドノードの診断情報を保持します。
otNetworkDiagChildEntry	ネットワーク診断の子テーブルエントリを表します。
otNetworkDiagConnectivity	ネットワーク診断接続の値を表します。
otNetworkDiagMacCounters	ネットワーク診断 Mac カウンタの値を表します。
otNetworkDiagMleCounters	ネットワーク診断 MLE カウンタの値を表します。
otNetworkDiagRoute	ネットワーク診断ルートの TLV 値を表します。
otNetworkDiagRouteData	ネットワーク診断ルートデータを表します。
otNetworkDiagTlv	ネットワーク診断 TLV を表します。
otRouterInfo	Thread ルーターの診断情報を保持します。
otServerConfig	サーバー構成を表します。
otServiceConfig	Service の構成を表します。
otThreadDiscoveryRequestInfo	スレッド検出リクエストのデータを表します。
otThreadParentResponseInfo	MLE の親レスポンスデータを表します。

列挙型

匿名列挙型

 anonymous enum

プロパティ
`OT_NETWORK_DIAGNOSTIC_TLV_ANSWER`	TLV に回答します。
`OT_NETWORK_DIAGNOSTIC_TLV_BATTERY_LEVEL`	バッテリー残量 TLV。
`OT_NETWORK_DIAGNOSTIC_TLV_CHANNEL_PAGES`	チャンネルページ TLV。
`OT_NETWORK_DIAGNOSTIC_TLV_CHILD`	子 TLV。
`OT_NETWORK_DIAGNOSTIC_TLV_CHILD_IP6_ADDR_LIST`	子 IPv6 アドレスリスト 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`	Max Child Timeout TLV。
`OT_NETWORK_DIAGNOSTIC_TLV_MLE_COUNTERS`	MLE カウンタ TLV。
`OT_NETWORK_DIAGNOSTIC_TLV_MODE`	TLV モード。
`OT_NETWORK_DIAGNOSTIC_TLV_NETWORK_DATA`	ネットワークデータ TLV。
`OT_NETWORK_DIAGNOSTIC_TLV_QUERY_ID`	クエリ ID の TLV。
`OT_NETWORK_DIAGNOSTIC_TLV_ROUTE`	Route64 TLV。
`OT_NETWORK_DIAGNOSTIC_TLV_ROUTER_NEIGHBOR`	ルーターネイバーの TLV。
`OT_NETWORK_DIAGNOSTIC_TLV_SHORT_ADDRESS`	住所 16 の TLV。
`OT_NETWORK_DIAGNOSTIC_TLV_SUPPLY_VOLTAGE`	電源電圧の TLV。
`OT_NETWORK_DIAGNOSTIC_TLV_THREAD_STACK_VERSION`	スレッドスタックバージョンの TLV。
`OT_NETWORK_DIAGNOSTIC_TLV_TIMEOUT`	タイムアウト TLV（SED の最大ポーリング時間）
`OT_NETWORK_DIAGNOSTIC_TLV_TYPE_LIST`	タイプリスト TLV。
`OT_NETWORK_DIAGNOSTIC_TLV_VENDOR_MODEL`	ベンダーモデルの TLV。
`OT_NETWORK_DIAGNOSTIC_TLV_VENDOR_NAME`	Vendor Name TLV.
`OT_NETWORK_DIAGNOSTIC_TLV_VENDOR_SW_VERSION`	ベンダー SW バージョンの TLV。
`OT_NETWORK_DIAGNOSTIC_TLV_VERSION`	バージョン TLV。

otDeviceRole

 otDeviceRole

Thread デバイスの役割を表します。

プロパティ
`OT_DEVICE_ROLE_CHILD`	Thread の子ロール。
`OT_DEVICE_ROLE_DETACHED`	現在、Thread ネットワーク/パーティションに参加していない。
`OT_DEVICE_ROLE_DISABLED`	スレッドスタックが無効になっている。
`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

ボーダールーターの構成を表します。

otDetachGracefullyCallback

void(* otDetachGracefullyCallback)(void *aContext)

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

詳細

パラメータ

[in] aContext

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

otExternalRouteConfig

struct otExternalRouteConfig otExternalRouteConfig

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

otIpCounters

struct otIpCounters otIpCounters

IP レベルのカウンタを表します。

otLeaderData

struct otLeaderData otLeaderData

スレッドリーダーデータを表します。

otLinkModeConfig

struct otLinkModeConfig otLinkModeConfig

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

otLowpanContextInfo

struct otLowpanContextInfo otLowpanContextInfo

ネットワークデータのプレフィックスに関連付けられた 6LoWPAN コンテキスト ID 情報を表します。

otMleCounters

struct otMleCounters otMleCounters

スレッド MLE カウンタを表します。

otNeighborInfoIterator

int16_t otNeighborInfoIterator

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

otNetDataDnsSrpServicePublisherCallback

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

ポインタの種類は、「DNS/SRP サービス」エントリが Thread ネットワークデータに対して追加または削除されたときの通知に使用するコールバックを定義します。

削除時は、Publisher によってエントリが削除されたかどうか（たとえば、ネットワークデータにすでに同様のエントリが多すぎる場合など）、またはエントリを公開停止するための明示的な呼び出し（otNetDataUnpublishDnsSrpService() の呼び出し）に関係なく、コールバックが呼び出されます。

詳細

パラメータ

`[in] aEvent`	イベント（エントリが追加または削除されたかどうか）を示します。
`[in] aContext`	アプリケーション固有のコンテキストへのポインタ。

otNetDataPrefixPublisherCallback

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

ポインタの種類は、プレフィックス（メッシュまたは外部ルート）のエントリが Thread ネットワークデータに追加またはスレッドネットワークデータから削除されたときに通知するコールバックを定義します。

削除時は、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 をご覧ください。

otNetworkDiagMleCounters

struct otNetworkDiagMleCounters otNetworkDiagMleCounters

ネットワーク診断 MLE カウンタの値を表します。

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 Diagnostic Get のレスポンスを受信すると、ポインタが呼び出されます。

詳細

パラメータ

`[in] aError`	レスポンスを取得できなかったときのエラー。
`[in] aMessage`	受信した Network Diagnostic Get レスポンスペイロードを含むメッセージバッファへのポインタ。`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_RESPONSE_TIMEOUT は、宛先が見つからなかったことを示します。OT_ERROR_ABORT は、リクエストが中止されたことを示します。
`[in] aMeshLocalAddress`	`aError` が OT_ERROR_NONE の場合、エニーキャストアドレスの最も近い宛先のメッシュローカル EID へのポインタ。それ以外の場合は 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 親応答メッセージを受信するたびに呼び出されます。

otThreadRegisterParentResponseCallback() で使用されます。

詳細

パラメータ

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

otThreadParentResponseInfo

struct otThreadParentResponseInfo otThreadParentResponseInfo

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

関数

otConvertDurationInSecondsToString

void otConvertDurationInSecondsToString(
  uint32_t aDuration,
  char *aBuffer,
  uint16_t aSize
)

uint32_t 期間（秒単位）を人が読める文字列に変換します。

OPENTHREAD_CONFIG_UPTIME_ENABLE を有効にする必要があります。

文字列は、時間、分、秒（期間が 1 日未満の場合は ::）またはの形式になります。

d.::" （1 日を超える場合）。

結果の文字列が aSize 文字内の aBuffer に収まらない場合、文字列は切り捨てられますが、出力される文字列は常に null で終わる文字列になります。

otNeighborInfo または otChildInfo 構造内の mAge または mConnectionTime で使用するためのものです。

詳細

パラメータ

`[in] aDuration`	期間（秒単位）。
`[out] aBuffer`	文字列を出力するための char 配列へのポインタ。
`[in] aSize`	`aBuffer` のサイズ（バイト単位）。`OT_DURATION_STRING_SIZE` を使用することをおすすめします。

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 が含まれているかどうか。

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` が指すデータバッファのサイズ。終了時にコピーされたバイト数。

戻り値

`OT_ERROR_NONE`	Thread ネットワークデータを `aData` にコピーし、`aDataLength` を更新しました。
`OT_ERROR_NO_BUFS`	`aData` に、スレッドネットワークデータを完全にコピーするための十分な空き容量がありません。

otNetDataGetCommissioningDataset

void otNetDataGetCommissioningDataset(
  otInstance *aInstance,
  otCommissioningDataset *aDataset
)

パーティションのネットワークデータからコミッショニングデータセットを取得します。

詳細

パラメータ

`[in] aInstance`	OpenThread インスタンスへのポインタ。
`[out] aDataset`	入力対象の `otCommissioningDataset` へのポインタ。

otNetDataGetLength

uint8_t otNetDataGetLength(
  otInstance *aInstance
)

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

詳細

パラメータ

[in] aInstance

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

戻り値

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

otNetDataGetMaxLength

uint8_t otNetDataGetMaxLength(
  otInstance *aInstance
)

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

詳細

パラメータ

[in] aInstance

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

戻り値

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

otNetDataGetNextLowpanContextInfo

otError otNetDataGetNextLowpanContextInfo(
  otInstance *aInstance,
  otNetworkDataIterator *aIterator,
  otLowpanContextInfo *aContextInfo
)

パーティションのネットワークデータから、次の 6LoWPAN コンテキスト ID の情報を取得します。

詳細

パラメータ

`[in] aInstance`	OpenThread インスタンスへのポインタ。
`[in,out] aIterator`	ネットワークデータイテレータへのポインタ。最初のサービスエントリを取得するには、OT_NETWORK_DATA_ITERATOR_INIT に設定する必要があります。
`[out] aContextInfo`	取得した 6LoWPAN コンテキスト ID 情報が配置される場所へのポインタ。

戻り値

`OT_ERROR_NONE`	次の 6LoWPAN コンテキスト ID 情報が見つかりました。
`OT_ERROR_NOT_FOUND`	パーティションのネットワークデータに、これ以降の 6LoWPAN コンテキスト情報はありません。

otNetDataGetNextOnMeshPrefix

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

パーティションのネットワークデータの次の On Mesh プレフィックスを取得します。

詳細

パラメータ

`[in] aInstance`	OpenThread インスタンスへのポインタ。
`[in,out] aIterator`	ネットワークデータイテレータコンテキストへのポインタ。メッシュ上の最初のエントリを取得するには、OT_NETWORK_DATA_ITERATOR_INIT に設定する必要があります。
`[out] aConfig`	[On Mesh Prefix] 情報が配置される場所へのポインタ。

戻り値

`OT_ERROR_NONE`	次のメッシュプレフィックスが見つかりました。
`OT_ERROR_NOT_FOUND`	Thread ネットワークデータに後続の On Mesh プレフィックスは存在しない。

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 サービスエントリが 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
)

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

OPENTHREAD_CONFIG_TMF_NETDATA_SERVICE_ENABLE 機能を有効にする必要があります。

この関数を呼び出すと、前の otNetDataPublishDnsSrpService{Type}() 関数の呼び出しで公開されていた「DNS/SRP サービス」のエントリが削除され、置き換えられます。

詳細

パラメータ

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

otNetDataPublishDnsSrpServiceUnicast

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

「DNS/SRP Service Unicast Address」を Thread ネットワークデータで公開するようリクエストします。

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
)

「DNS/SRP Service Unicast Address」を Thread ネットワークデータで公開するようリクエストします。

OPENTHREAD_CONFIG_TMF_NETDATA_SERVICE_ENABLE 機能を有効にする必要があります。

公開アドレスを指定してサービス TLV データに情報を含める otNetDataPublishDnsSrpServiceUnicast() とは異なり、この関数はデバイスのメッシュローカル EID を使用し、サーバー 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` 構成によって決定される（メッシュ上のプレフィックスと外部ルートの間で共有される）が限られています。

otNetDataReplacePublishedExternalRoute

otError otNetDataReplacePublishedExternalRoute(
  otInstance *aInstance,
  const otIp6Prefix *aPrefix,
  const otExternalRouteConfig *aConfig
)

Thread ネットワークデータで以前に公開された外部ルートを置き換えます。

OPENTHREAD_CONFIG_BORDER_ROUTER_ENABLE 機能を有効にする必要があります。

aPrefix に一致する以前に公開された外部ルートがない場合、この関数は otNetDataPublishExternalRoute() と同様に動作します。つまり、Thread ネットワークデータの外部ルートとして aConfig を公開するプロセスを開始します。

aPrefix に一致する、以前に公開したルートエントリがある場合は、aConfig の新しい接頭辞に置き換えられます。

aPrefix がすでにネットワークデータに追加されている場合、aConfig の新しい接頭辞への変更は、すぐにネットワークデータに反映されます。これにより、ネットワークデータのルートエントリが突然削除されず、aPrefix から新しいプレフィックスへの移行がスムーズになります。
公開された古い aPrefix がネットワークデータに追加されていない場合、新しい aConfig 接頭辞に置き換えられますが、すぐには追加されません。代わりに、ネットワークデータに公開するプロセスを開始します（ネットワークデータをモニタリングして、ネットワークデータに存在する類似の接頭辞の数に応じて、接頭辞を追加するタイミングや追加の有無を判断します）。

詳細

パラメータ

`[in] aInstance`	OpenThread インスタンスへのポインタ。
`[in] aPrefix`	以前に公開された外部ルートの接頭辞。
`[in] aConfig`	公開する外部ルート構成。

戻り値

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

otNetDataResetMaxLength

void otNetDataResetMaxLength(
  otInstance *aInstance
)

Thread ネットワークデータのトラッキングされている最大長をリセットします。

詳細

パラメータ

[in] aInstance

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

関連項目:
otNetDataGetMaxLength

otNetDataSetDnsSrpServicePublisherCallback

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

公開された「DNS/SRP サービス」が実際に Thread ネットワークデータに追加または 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
)

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

詳細

パラメータ

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

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

詳細

パラメータ

`[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`	公開リストにプレフィックスが見つかりませんでした。

otThreadBecomeChild

otError otThreadBecomeChild(
  otInstance *aInstance
)

お子様として再度関連付けてみます。

詳細

パラメータ

[in] aInstance

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

戻り値

`OT_ERROR_NONE`	子供になる試行が正常に開始します。
`OT_ERROR_INVALID_STATE`	Thread は無効になっています。

otThreadBecomeDetached

otError otThreadBecomeDetached(
  otInstance *aInstance
)

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

詳細

パラメータ

[in] aInstance

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

戻り値

`OT_ERROR_NONE`	Thread ネットワークから切断しました。
`OT_ERROR_INVALID_STATE`	Thread は無効になっています。

otThreadDetachGracefully

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

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

ルーターの場合は Address Release を送信し、子の場合は、子タイムアウトを 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
)

スレッド検出スキャンを開始します。

詳細

パラメータ

`[in] aInstance`	OpenThread インスタンスへのポインタ。
`[in] aScanChannels`	スキャンするチャンネルを示すビットベクトル（例: OT_CHANNEL_11_MASK）。
`[in] aPanId`	PAN ID フィルタ（フィルタを無効にするには、PAN ブロードキャストに設定）。
`[in] aJoiner`	ディスカバリリクエストの TLV の Joiner フラグの値。
`[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`	デバイスは現在、Thread ネットワーク/パーティションに参加していません。
`OT_DEVICE_ROLE_CHILD`	デバイスは現在、Thread 子として動作しています。
`OT_DEVICE_ROLE_ROUTER`	デバイスは現在、Thread ルーターとして動作しています。
`OT_DEVICE_ROLE_LEADER`	デバイスは現在、Thread リーダーとして動作しています。

otThreadGetDomainName

const char * otThreadGetDomainName(
  otInstance *aInstance
)

Thread ドメイン名を取得します。

詳細

パラメータ

[in] aInstance

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

戻り値

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

関連情報:
otThreadSetDomainName

otThreadGetExtendedPanId

const otExtendedPanId * otThreadGetExtendedPanId(
  otInstance *aInstance
)

IEEE 802.15.4 拡張 PAN ID を取得します。

詳細

パラメータ

[in] aInstance

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

戻り値

IEEE 802.15.4 拡張 PAN ID へのポインタ。

関連情報:
otThreadSetExtendedPanId

otThreadGetFixedDuaInterfaceIdentifier

const otIp6InterfaceIdentifier * otThreadGetFixedDuaInterfaceIdentifier(
  otInstance *aInstance
)

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

OPENTHREAD_CONFIG_DUA_ENABLE が有効な場合に利用可能です。

詳細

パラメータ

[in] aInstance

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

戻り値

手動で設定されたインターフェース ID へのポインタ。設定されていない場合は 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`	現在、Thread パーティションにはアタッチされていません。

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
)

Thread Link-Local All Thread Nodes マルチキャストアドレスを取得します。

アドレスは、リンクローカルのユニキャストプレフィックスベースのマルチキャストアドレス [RFC 3306] で、次の特性を持ちます。

flgs を 3 に設定（P = 1、T = 1）
scop を 2 に設定
プレンを 64 に設定
ネットワークプレフィックスがメッシュローカルプレフィックスに設定されている
グループ ID を 1 に設定

詳細

パラメータ

[in] aInstance

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

戻り値

スレッドリンクローカル全スレッドノードのマルチキャストアドレスへのポインタ。

otThreadGetLinkLocalIp6Address

const otIp6Address * otThreadGetLinkLocalIp6Address(
  otInstance *aInstance
)

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

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

詳細

パラメータ

[in] aInstance

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

戻り値

スレッドのリンクローカル IPv6 アドレスへのポインタ。

otThreadGetLinkMode

otLinkModeConfig otThreadGetLinkMode(
  otInstance *aInstance
)

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

詳細

パラメータ

[in] aInstance

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

戻り値

MLE リンクモードの構成。

関連情報:
otThreadSetLinkMode

otThreadGetMaxTimeInQueue

uint32_t otThreadGetMaxTimeInQueue(
  otInstance *aInstance
)

TX キュー内のメッセージの最大キュー内時間を取得します。

OPENTHREAD_CONFIG_TX_QUEUE_STATISTICS_ENABLE が必要です。

キュー内の時間は直接送信についてのみ追跡され、メッセージが送信キューに追加されてから、送信のために MAC レイヤに渡すか破棄されるまでの期間として測定されます。

収集された統計情報は、otThreadResetTimeInQueueStat() を呼び出してリセットできます。

詳細

パラメータ

[in] aInstance

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

戻り値

現在までの TX キュー内のすべてのメッセージの最大キュー内時間（ミリ秒）。

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 インスタンスへのポインタ。

戻り値

スレッド 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 インスタンスへのポインタ。

戻り値

スレッドネットワーク名へのポインタ。

関連情報:
otThreadSetNetworkName

otThreadGetNextDiagnosticTlv

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

メッセージの次のネットワーク診断 TLV を取得します。

OPENTHREAD_CONFIG_TMF_NETDIAG_CLIENT_ENABLE が必要です。

この関数の後続の呼び出しは、現在の戻り値が 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
)

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

詳細

パラメータ

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

otThreadGetParentLastRssi

otError otThreadGetParentLastRssi(
  otInstance *aInstance,
  int8_t *aLastRssi
)

この関数は、スレッドの親から最後のパケットの 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 に設定
プレンを 64 に設定
ネットワークプレフィックスがメッシュローカルプレフィックスに設定されている
グループ ID を 1 に設定

詳細

パラメータ

[in] aInstance

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

戻り値

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

otThreadGetRloc

const otIp6Address * otThreadGetRloc(
  otInstance *aInstance
)

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

詳細

パラメータ

[in] aInstance

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

戻り値

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

otThreadGetRloc16

uint16_t otThreadGetRloc16(
  otInstance *aInstance
)

RLOC16 を入手します。

詳細

パラメータ

[in] aInstance

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

戻り値

RLOC16.

otThreadGetServiceAloc

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

指定された Service ID のサービス ALOC を取得します。

詳細

パラメータ

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

戻り値

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

otThreadGetTimeInQueueHistogram

const uint32_t * otThreadGetTimeInQueueHistogram(
  otInstance *aInstance,
  uint16_t *aNumBins,
  uint32_t *aBinInterval
)

TX キュー内のメッセージについて、キュー内時間ヒストグラムを取得します。

OPENTHREAD_CONFIG_TX_QUEUE_STATISTICS_ENABLE が必要です。

送信キュー内のメッセージのキュー内時間のヒストグラムが収集されます。キュー内の時間は直接送信についてのみ追跡され、メッセージが送信キューに追加されてから、送信のために MAC レイヤに渡すか破棄されるまでの期間として測定されます。

ヒストグラムは、aNumBins エントリを含む uint32_t 値の配列として返されます。配列の最初のエントリ（インデックス 0）は、キュー内待機時間が aBinInterval 未満のメッセージの数を表します。2 番目のエントリは、キューに入っている時間が aBinInterval 以上、2 * aBinInterval 未満のメッセージの数を表します。といった情報です。最後のエントリは、キューに入っている時間が (aNumBins - 1) * aBinInterval 以上のメッセージの数を表します。

収集された統計情報は、otThreadResetTimeInQueueStat() を呼び出してリセットできます。ヒストグラム情報は、OpenThread インスタンスが初期化された後、または最後に otThreadResetTimeInQueueStat() を呼び出して統計情報収集がリセットされた後に収集されます。

ポインタ aNumBins と aBinInterval が null であってはなりません。

詳細

パラメータ

`[in] aInstance`	OpenThread インスタンスへのポインタ。
`[out] aNumBins`	ヒストグラム内のビンの数（配列長）を返すポインタ。
`[out] aBinInterval`	ヒストグラムのビンの間隔の長さ（ミリ秒単位）を返すポインタ。

戻り値

収集されたヒストグラム情報を表す aNumBins エントリの配列へのポインタ。

otThreadGetVendorModel

const char * otThreadGetVendorModel(
  otInstance *aInstance
)

ベンダーモデル文字列を取得します。

詳細

パラメータ

[in] aInstance

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

戻り値

ベンダーのモデル文字列。

otThreadGetVendorName

const char * otThreadGetVendorName(
  otInstance *aInstance
)

ベンダー名の文字列を取得します。

詳細

パラメータ

[in] aInstance

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

戻り値

ベンダー名の文字列。

otThreadGetVendorSwVersion

const char * otThreadGetVendorSwVersion(
  otInstance *aInstance
)

ベンダーのソフトウェアバージョン文字列を取得します。

詳細

パラメータ

[in] aInstance

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

戻り値

ベンダーのソフトウェアバージョンの文字列。

otThreadGetVersion

uint16_t otThreadGetVersion(
  void
)

Thread プロトコルバージョンを取得します。

詳細
戻り値	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 親レスポンスデータを受信するコールバックを登録します。

OPENTHREAD_CONFIG_MLE_PARENT_RESPONSE_CALLBACK_API_ENABLE が必要です。

詳細

パラメータ

`[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 インスタンスへのポインタ。

otThreadResetTimeInQueueStat

void otThreadResetTimeInQueueStat(
  otInstance *aInstance
)

TX キューのキュー内時間統計情報をリセットします。

OPENTHREAD_CONFIG_TX_QUEUE_STATISTICS_ENABLE が必要です。

詳細

パラメータ

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

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

OPENTHREAD_CONFIG_TMF_NETDIAG_CLIENT_ENABLE が必要です。

詳細

パラメータ

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

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

OPENTHREAD_CONFIG_TMF_NETDIAG_CLIENT_ENABLE が必要です。

詳細

パラメータ

`[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 検出リクエストデータを受信するコールバックを設定します。

詳細

パラメータ

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

otThreadSetDomainName

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

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

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

詳細

パラメータ

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

戻り値

`OT_ERROR_NONE`	Thread Domain Name が正常に設定されました。
`OT_ERROR_INVALID_STATE`	スレッドプロトコルが有効になっている。

関連情報:
otThreadGetDomainName

otThreadSetEnabled

otError otThreadSetEnabled(
  otInstance *aInstance,
  bool aEnabled
)

スレッドプロトコルオペレーションを開始します。

この関数を呼び出すときにインターフェースが動作している必要があります。

aEnabled を FALSE に設定してこの関数を呼び出すと、otThreadDetachGracefully() によって開始された接続解除の進行中のプロセスが停止し、コールバックが呼び出されます。

詳細

パラメータ

`[in] aInstance`	OpenThread インスタンスへのポインタ。
`[in] aEnabled`	Thread が有効な場合は TRUE、そうでない場合は FALSE です。

戻り値

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

otThreadSetExtendedPanId

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

IEEE 802.15.4 拡張 PAN ID を設定します。

詳細

パラメータ

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

戻り値

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

関連情報:
otThreadGetExtendedPanId

otThreadSetFixedDuaInterfaceIdentifier

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

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

OPENTHREAD_CONFIG_DUA_ENABLE が有効な場合に利用可能です。

詳細

パラメータ

`[in] aInstance`	OpenThread インスタンスへのポインタ。
`[in] aIid`	設定するインターフェース ID へのポインタ。クリアする場合は NULL を指定します。

戻り値

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

関連情報:
otThreadGetFixedDuaInterfaceIdentifier

otThreadSetJoinerAdvertisement

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

Thread ネットワークを検出する際の Thread Joiner アドバタイズメントを設定します。

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

詳細

パラメータ

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

戻り値

`OT_ERROR_NONE`	ジョイナーアドバタイズが正常に設定されました。
`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`	スレッドネットワーク名へのポインタ。

戻り値

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

関連情報:
otThreadGetNetworkName

otThreadSetVendorModel

otError otThreadSetVendorModel(
  otInstance *aInstance,
  const char *aVendorModel
)

ベンダーのモデル文字列を設定します。

OPENTHREAD_CONFIG_NET_DIAG_VENDOR_INFO_SET_API_ENABLE が必要です。

aVendorModel は UTF8 で、最大長 32 文字（MAX_VENDOR_MODEL_TLV_LENGTH）にする必要があります。最大長に null 文字（\0）は含まれません。

詳細

パラメータ

`[in] aInstance`	OpenThread インスタンスへのポインタ。
`[in] aVendorModel`	ベンダーのモデル文字列。

戻り値

`OT_ERROR_NONE`	ベンダーモデルを設定しました。
`OT_ERROR_INVALID_ARGS`	`aVendorModel` は有効ではありません（長すぎるか、UTF8 ではありません）。

otThreadSetVendorName

otError otThreadSetVendorName(
  otInstance *aInstance,
  const char *aVendorName
)

ベンダー名の文字列を設定します。

OPENTHREAD_CONFIG_NET_DIAG_VENDOR_INFO_SET_API_ENABLE が必要です。

aVendorName は UTF8 で、最大長 32 文字（MAX_VENDOR_NAME_TLV_LENGTH）にする必要があります。最大長に null 文字（\0）は含まれません。

詳細

パラメータ

`[in] aInstance`	OpenThread インスタンスへのポインタ。
`[in] aVendorName`	ベンダー名の文字列。

戻り値

`OT_ERROR_NONE`	ベンダー名を設定しました。
`OT_ERROR_INVALID_ARGS`	`aVendorName` は有効ではありません（長すぎるか、UTF8 ではありません）。

otThreadSetVendorSwVersion

otError otThreadSetVendorSwVersion(
  otInstance *aInstance,
  const char *aVendorSwVersion
)

ベンダーのソフトウェアバージョン文字列を設定します。

OPENTHREAD_CONFIG_NET_DIAG_VENDOR_INFO_SET_API_ENABLE が必要です。

aVendorSwVersion は UTF8 で、最大長 16 文字（MAX_VENDOR_SW_VERSION_TLV_LENGTH）にする必要があります。最大長に null 文字（\0）は含まれません。

詳細

パラメータ

`[in] aInstance`	OpenThread インスタンスへのポインタ。
`[in] aVendorSwVersion`	ベンダーのソフトウェアバージョン文字列。

戻り値

`OT_ERROR_NONE`	ベンダーのソフトウェアバージョンを設定しました。
`OT_ERROR_INVALID_ARGS`	`aVendorSwVersion` は有効ではありません（長すぎるか、UTF8 ではありません）。

マクロ

OT_DURATION_STRING_SIZE

 OT_DURATION_STRING_SIZE 21

uint32_t 期間の文字列表現の推奨サイズ（秒単位）。

OT_JOINER_ADVDATA_MAX_LENGTH

 OT_JOINER_ADVDATA_MAX_LENGTH 64

ジョイナーアドバタイズメントの 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_MAX_THREAD_STACK_VERSION_TLV_LENGTH

 OT_NETWORK_DIAGNOSTIC_MAX_THREAD_STACK_VERSION_TLV_LENGTH 64

スレッドスタックバージョンの TLV の最大長。

OT_NETWORK_DIAGNOSTIC_MAX_VENDOR_MODEL_TLV_LENGTH

 OT_NETWORK_DIAGNOSTIC_MAX_VENDOR_MODEL_TLV_LENGTH 32

ベンダーモデルの TLV の最大長。

OT_NETWORK_DIAGNOSTIC_MAX_VENDOR_NAME_TLV_LENGTH

 OT_NETWORK_DIAGNOSTIC_MAX_VENDOR_NAME_TLV_LENGTH 32

ベンダー名 TLV の最大長

OT_NETWORK_DIAGNOSTIC_MAX_VENDOR_SW_VERSION_TLV_LENGTH

 OT_NETWORK_DIAGNOSTIC_MAX_VENDOR_SW_VERSION_TLV_LENGTH 16

ベンダー SW バージョンの TLV の最大長。

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

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

全般

概要

列挙型

Typedef

関数

構造体

列挙型

匿名列挙型

otDeviceRole

otNetDataPublisherEvent

otRoutePreference

Typedef

otBorderRouterConfig

otDetachGracefullyCallback

otExternalRouteConfig

otIpCounters

otLeaderData

otLinkModeConfig

otLowpanContextInfo

otMleCounters

otNeighborInfoIterator

otNetDataDnsSrpServicePublisherCallback

otNetDataPrefixPublisherCallback

otNetDataPublisherEvent

otNetworkDataIterator

otNetworkDiagChildEntry

otNetworkDiagConnectivity

otNetworkDiagIterator

otNetworkDiagMacCounters

otNetworkDiagMleCounters

otNetworkDiagRoute

otNetworkDiagRouteData

otNetworkDiagTlv

otReceiveDiagnosticGetCallback

otRoutePreference

otServerConfig

otServiceConfig

otThreadAnycastLocatorCallback

otThreadDiscoveryRequestCallback

otThreadDiscoveryRequestInfo

otThreadParentResponseCallback

otThreadParentResponseInfo

関数

otConvertDurationInSecondsToString

otNetDataContainsOmrPrefix

otNetDataGet

otNetDataGetCommissioningDataset

otNetDataGetLength

otNetDataGetMaxLength

otNetDataGetNextLowpanContextInfo

otNetDataGetNextOnMeshPrefix

otNetDataGetNextRoute

otNetDataGetNextService

otNetDataGetStableVersion

otNetDataGetVersion

otNetDataIsDnsSrpServiceAdded

otNetDataIsPrefixAdded

otNetDataPublishDnsSrpServiceAnycast

otNetDataPublishDnsSrpServiceUnicast

otNetDataPublishDnsSrpServiceUnicastMeshLocalEid

otNetDataPublishExternalRoute

otNetDataPublishOnMeshPrefix

otNetDataReplacePublishedExternalRoute

otNetDataResetMaxLength

otNetDataSetDnsSrpServicePublisherCallback

otNetDataSetPrefixPublisherCallback

otNetDataSteeringDataCheckJoiner

otNetDataSteeringDataCheckJoinerWithDiscerner

otNetDataUnpublishDnsSrpService

otNetDataUnpublishPrefix

otThreadBecomeChild

otThreadBecomeDetached

otThreadDetachGracefully

otThreadDeviceRoleToString

otThreadDiscover

otThreadGetChildTimeout

otThreadGetDeviceRole

otThreadGetDomainName

otThreadGetExtendedPanId

otThreadGetFixedDuaInterfaceIdentifier