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

General

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

まとめ

ネットワーク データ パブリッシャーは、ネットワーク データを監視し、エントリを追加または削除するタイミングを管理することで、スレッド ネットワーク データ内の類似したサービスまたはプレフィックス(メッシュ内のプレフィックスまたは外部ルート)のエントリ数を制限するメカニズムを提供します。

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

列挙型

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

Typedef

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

Functions

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

構造体

otBorderRouterConfig

この構造は、Border Router の構成を表します。

otExternalRouteConfig

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

otIpCounters

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

otLeaderData

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

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
Properties
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。

otDeviceRole

 otDeviceRole

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

Properties
OT_DEVICE_ROLE_CHILD

スレッドの子のロール。

OT_DEVICE_ROLE_DETACHED

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

OT_DEVICE_ROLE_DISABLED

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

OT_DEVICE_ROLE_LEADER

スレッド リーダーのロール

OT_DEVICE_ROLE_ROUTER

スレッド ルーターのロール

otNetDataPublisherEvent

 otNetDataPublisherEvent

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

Properties
OT_NETDATA_PUBLISHER_EVENT_ENTRY_ADDED

Thread Network データにパブリッシュされたエントリが追加されます。

OT_NETDATA_PUBLISHER_EVENT_ENTRY_REMOVED

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

otRoutePreference

 otRoutePreference

otExternalRouteConfigotBorderRouterConfigmPreference に有効な値を定義します。

Properties
OT_ROUTE_PREFERENCE_HIGH

ルート設定。

OT_ROUTE_PREFERENCE_LOW

ルート設定が低くなっています。

OT_ROUTE_PREFERENCE_MED

ルート設定: 中

Typedef

otBorderRouterConfig

struct otBorderRouterConfig otBorderRouterConfig

この構造は、Border Router の構成を表します。

otExternalRouteConfig

struct otExternalRouteConfig otExternalRouteConfig

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

otIpCounters

struct otIpCounters otIpCounters

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

otLeaderData

struct otLeaderData otLeaderData

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

otLinkModeConfig

struct otLinkModeConfig otLinkModeConfig

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

otMleCounters

struct otMleCounters otMleCounters

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

otNeighborInfoIterator

int16_t otNeighborInfoIterator

隣接テーブルの反復処理に使用されます。

otNetDataDnsSrpServicePublisherCallback

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

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

削除時に、エントリが Publisher によって削除されたかどうか(ネットワーク データにすでに存在するエントリが多すぎるなど)や、エントリを非公開にする明示的な呼び出し(otNetDataUnpublishDnsSrpService() の呼び出しなど)に関係なく、コールバックが呼び出されます。

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

otNetDataPrefixPublisherCallback

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

この関数のポインタ型は、スレッド ネットワーク データへの接頭辞(メッシュまたは外部ルート)エントリの追加または削除があった場合に通知されるコールバックを定義します。

削除時に、そのエントリが Publisher によって削除されたかどうか(ネットワーク データにすでに存在するエントリが多すぎるなど)に関係なく、またはエントリを非公開にするための明示的な呼び出しによってコールバックが呼び出されます。

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

otNetDataPublisherEvent

enum otNetDataPublisherEvent otNetDataPublisherEvent

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

otNetworkDataIterator

uint32_t otNetworkDataIterator

ネットワーク データの情報を繰り返し処理するために使用します。

otNetworkDiagChildEntry

struct otNetworkDiagChildEntry otNetworkDiagChildEntry

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

otNetworkDiagConnectivity

struct otNetworkDiagConnectivity otNetworkDiagConnectivity

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

otNetworkDiagIterator

uint16_t otNetworkDiagIterator

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

otNetworkDiagMacCounters

struct otNetworkDiagMacCounters otNetworkDiagMacCounters

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

メンバー フィールドの定義については、RFC 2863 をご覧ください。

otNetworkDiagRoute

struct otNetworkDiagRoute otNetworkDiagRoute

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

otNetworkDiagRouteData

struct otNetworkDiagRouteData otNetworkDiagRouteData

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

otNetworkDiagTlv

struct otNetworkDiagTlv otNetworkDiagTlv

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

otReceiveDiagnosticGetCallback

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

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

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

otRoutePreference

enum otRoutePreference otRoutePreference

otExternalRouteConfigotBorderRouterConfigmPreference に有効な値を定義します。

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 の親レスポンス メッセージを受信するたびに呼び出されます。

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

otThreadParentResponseInfo

struct otThreadParentResponseInfo otThreadParentResponseInfo

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

Functions

otNetDataContainsOmrPrefix

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

この関数は、指定されたプレフィックスが有効な OMR プレフィックスとして機能し、リーダーのネットワーク データにもこのプレフィックスが含まれているかどうかを確認します。

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

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
次の On Mesh プレフィックスが見つかりました。
OT_ERROR_NOT_FOUND
Thread Network データに、後続の 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
スレッド ネットワーク データに、後続の外部ルート エントリはありません。

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(OTNetDataIsDnsSrpServiceAdded)

bool otNetDataIsDnsSrpServiceAdded(
  otInstance *aInstance
)

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

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

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

otNetDataIsPrefixAdded

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

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

この機能を使用するには、機能 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 サービスのエニーキャスト アドレスをスレッド ネットワーク データで公開するようリクエストします。

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

この関数を呼び出すと、以前の(DNS または SRP の)関数(以前の otNetDataPublishDnsSrpService{Type}() 関数の呼び出しからの呼び出し)が削除されます。

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

otNetDataPublishDnsSrpServiceUnicast

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

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

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

この関数を呼び出すと、以前の(DNS または SRP の)関数(以前の otNetDataPublishDnsSrpService{Type}() 関数の呼び出しからの呼び出し)が削除されます。

この関数は、DNS/SRP ユニキャスト アドレス(Service TLV データにアドレスとポート情報を含む)を公開します。

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

otNetDataPublishDnsSrpServiceUnicastMeshLocalEid

void otNetDataPublishDnsSrpServiceUnicastMeshLocalEid(
  otInstance *aInstance,
  uint16_t aPort
)

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

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

この関数を呼び出すと、以前の(DNS または SRP の)関数(以前の otNetDataPublishDnsSrpService{Type}() 関数の呼び出しからの呼び出し)が削除されます。

公開されたアドレスが指定され、サービス TLV データの情報が含まれる otNetDataPublishDnsSrpServiceUnicast() とは異なり、この関数はデバイスのメッシュ ローカル EID を使用し、サーバーの TLV データに情報を含めます。

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

otNetDataPublishExternalRoute

otError otNetDataPublishExternalRoute(
  otInstance *aInstance,
  const otExternalRouteConfig *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_ALREADY
同じ接頭辞を持つエントリが公開リスト内にすでにあります。
OT_ERROR_NO_BUFS
新しいリクエストにエントリを割り当てることができませんでした。パブリッシャーは、構成 OPENTHREAD_CONFIG_NETDATA_PUBLISHER_MAX_PREFIX_ENTRIES によって決定される限られた数のエントリ(メッシュ内の接頭辞と外部ルートの間で共有)をサポートします。

otNetDataPublishOnMeshPrefix

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

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

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

安定したエントリのみを公開できます(例:aConfig.mStable は TRUE でなければなりません)。

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

otNetDataSetDnsSrpServicePublisherCallback

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

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

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

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

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

otNetDataSetPrefixPublisherCallback

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

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

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

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

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

otNetDataSteeringDataCheckJoiner

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

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

詳細
パラメータ
[in] aInstance
OpenThread インスタンスへのポインタ。
[in] aEui64
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(エニーキャストまたはユニキャスト)サービス」エントリを非公開にします。

この機能を使用するには、機能 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
公開リストで接頭辞が見つかりませんでした。

otThreadBeginChild

otError otThreadBecomeChild(
  otInstance *aInstance
)

子として再接続を試みます。

詳細
パラメータ
[in] aInstance
OpenThread インスタンスへのポインタ。
戻り値
OT_ERROR_NONE
子として参加できるようになります。
OT_ERROR_INVALID_STATE
このスレッドは無効になっています。

otThreadBeginDetached

otError otThreadBecomeDetached(
  otInstance *aInstance
)

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

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

otThreadDeviceRoleToString

const char * otThreadDeviceRoleToString(
  otDeviceRole aRole
)

デバイスロールを人が読める文字列に変換します。

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

otThreadDiscover

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

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

詳細
パラメータ
[in] aInstance
OpenThread インスタンスへのポインタ。
[in] aScanChannels
スキャンするチャネルを示すビットベクトル(例: OT_CHANNEL_11_MASK)。
[in] aPanId
PAN ID フィルタ(フィルタを無効にする場合はブロードキャスト PAN に設定)。
[in] aJoiner
調査リクエスト TLV の 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
このデバイスは現在、スレッドの子として動作しています。
OT_DEVICE_ROLE_ROUTER
このデバイスは現在、スレッドルーターとして動作しています。
OT_DEVICE_ROLE_LEADER
このデバイスは現在、スレッド リーダーとして動作しています。

otThreadGetDomainName

const char * otThreadGetDomainName(
  otInstance *aInstance
)

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

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

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

otThreadGetExtendedPanId

const otExtendedPanId * otThreadGetExtendedPanId(
  otInstance *aInstance
)

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 が有効になっている場合にスレッド 1.2 以降でのみ使用できます。

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

otThreadGetIp6Counters

const otIpCounters * otThreadGetIp6Counters(
  otInstance *aInstance
)

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

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

otThreadGetKeySequenceCounter

uint32_t otThreadGetKeySequenceCounter(
  otInstance *aInstance
)

thrKeySequenceCounter を取得します。

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

otThreadGetKeySwitchGuardTime

uint32_t otThreadGetKeySwitchGuardTime(
  otInstance *aInstance
)

thrKeySwitchGuardTime を取得します。

詳細
パラメータ
[in] aInstance
OpenThread インスタンスへのポインタ。
戻り値
thrKeySwitchGuardTime 値(時間)。
関連情報:
otThreadSetKeySwitchGuardTime

otThreadGetLeaderData

otError otThreadGetLeaderData(
  otInstance *aInstance,
  otLeaderData *aLeaderData
)

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

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

otThreadGetLeaderRloc

otError otThreadGetLeaderRloc(
  otInstance *aInstance,
  otIp6Address *aLeaderRloc
)

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

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

otThreadGetLeaderRouterId

uint8_t otThreadGetLeaderRouterId(
  otInstance *aInstance
)

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

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

otThreadGetLeaderWeight

uint8_t otThreadGetLeaderWeight(
  otInstance *aInstance
)

リーダーの体重を把握しましょう。

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

otThreadGetLinkLocalAllThreadNodesMulticastAddress

const otIp6Address * otThreadGetLinkLocalAllThreadNodesMulticastAddress(
  otInstance *aInstance
)

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

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

  • flgs を 3(P = 1、T = 1)に設定
  • スコープを 2 に設定
  • plen を 64 に設定
  • メッシュのローカル接頭辞に設定されたネットワーク接頭辞
  • グループ ID を 1 に設定

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

otThreadGetLinkLocalIp6Address

const otIp6Address * otThreadGetLinkLocalIp6Address(
  otInstance *aInstance
)

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

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

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

otThreadGetLinkMode

otLinkModeConfig otThreadGetLinkMode(
  otInstance *aInstance
)

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

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

otThreadGetMeshLocalEid

const otIp6Address * otThreadGetMeshLocalEid(
  otInstance *aInstance
)

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

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

otThreadGetMeshLocalPrefix

const otMeshLocalPrefix * otThreadGetMeshLocalPrefix(
  otInstance *aInstance
)

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

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

otThreadGetMleCounters

const otMleCounters * otThreadGetMleCounters(
  otInstance *aInstance
)

Thread MLE カウンタを取得する。

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

otThreadGetNetworkKey

void otThreadGetNetworkKey(
  otInstance *aInstance,
  otNetworkKey *aNetworkKey
)

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

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

otThreadGetNetworkKeyRef

otNetworkKeyRef otThreadGetNetworkKeyRef(
  otInstance *aInstance
)

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

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

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

otThreadGetNetworkName

const char * otThreadGetNetworkName(
  otInstance *aInstance
)

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

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

otThreadGetNextDiagnosticTlv

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

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

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

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

otThreadGetNextNeighborInfo

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

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

これは、ネイバー テーブルのエントリを通過するために使用されます。

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

otThreadGetParentAverageRssi

otError otThreadGetParentAverageRssi(
  otInstance *aInstance,
  int8_t *aParentRssi
)

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

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

otThreadGetParentInfo

otError otThreadGetParentInfo(
  otInstance *aInstance,
  otRouterInfo *aParentInfo
)

この関数は、親として 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
)

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

このアドレスは、次のようにレルムローカル Unicast Prefix ベースのマルチキャスト アドレス [RFC 3306] になります。

  • flgs を 3(P = 1、T = 1)に設定
  • スコープを 3 に設定
  • plen を 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
)

この関数は、指定されたサービス 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 プロトコル バージョンを取得します。

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

詳細
パラメータ
[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 インスタンスへのポインタ。

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
ネットワーク診断 Get レスポンスを受信したときに呼び出される関数へのポインタ。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 検出リクエスト データを受信するコールバックを設定します。

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

otThreadSetDomainName

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

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

この関数は、スレッド 1.2 以降でのみ使用できます。この関数は、スレッド プロトコルが無効になっている場合にのみ成功します。

詳細
パラメータ
[in] aInstance
OpenThread インスタンスへのポインタ。
[in] aDomainName
スレッド ドメイン名へのポインタ。
戻り値
OT_ERROR_NONE
スレッド ドメイン名を設定しました。
OT_ERROR_INVALID_STATE
スレッド プロトコルが有効になっている。
関連情報:
otThreadGetDomainName

otThreadSetEnabled(OT スレッドセットの有効化)

otError otThreadSetEnabled(
  otInstance *aInstance,
  bool aEnabled
)

この関数は、スレッド プロトコル操作を開始します。

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

詳細
パラメータ
[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 Extended PAN ID を設定します。

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

詳細
パラメータ
[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 が有効になっている場合にスレッド 1.2 以降でのみ使用できます。

詳細
パラメータ
[in] aInstance
OpenThread インスタンスへのポインタ。
[in] aIid
設定するインターフェース識別子へのポインタ、またはクリアする NULL。
戻り値
OT_ERROR_NONE
インターフェース ID を設定またはクリアしました。
OT_ERROR_INVALID_ARGS
指定されたインターフェース識別子は予約されています。
関連情報:
otThreadGetFixedDuaInterfaceIdentifier

otThreadSetJoinerAdvertisement

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

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

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

詳細
パラメータ
[in] aInstance
OpenThread インスタンスへのポインタ。
[in] aOui
Joiner アドバタイズメントに含まれるベンダー IEEE OUI 値。下位の 3 バイトのみが使用され、上位のバイトは無視されます。
[in] aAdvData
Joiner アドバタイズメントに含まれる AdvData へのポインタ。
[in] aAdvDataLength
AdvData の長さ(バイト単位)。
戻り値
OT_ERROR_NONE
Joiner アドバタイズが正常に設定されました。
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
)

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

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

詳細
パラメータ
[in] aInstance
OpenThread インスタンスへのポインタ。
[in] aMeshLocalPrefix
メッシュ ローカル プレフィックスへのポインタ。
戻り値
OT_ERROR_NONE
メッシュのローカル接頭辞を設定しました。
OT_ERROR_INVALID_STATE
スレッド プロトコルが有効になっている。

otThreadSetNetworkKey

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

スレッド ネットワーク キーを設定します。

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

詳細
パラメータ
[in] aInstance
OpenThread インスタンスへのポインタ。
[in] aKey
Thread Network Key を含むバッファへのポインタ。
戻り値
OT_ERROR_NONE
スレッド ネットワーク キーを設定しました。
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
スレッド ネットワーク キーへの参照。
戻り値
OT_ERROR_NONE
スレッド ネットワーク キーを設定しました。
OT_ERROR_INVALID_STATE
スレッド プロトコルが有効になっている。
関連情報:
otThreadGetNetworkKeyRef

otThreadSetNetworkName

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

スレッド ネットワーク名を設定します。

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

詳細
パラメータ
[in] aInstance
OpenThread インスタンスへのポインタ。
[in] aNetworkName
スレッド ネットワーク名へのポインタ。
戻り値
OT_ERROR_NONE
スレッド ネットワーク名を設定しました。
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 で入手可能なソースコードから作成されています。詳細やドキュメントについては、リソースをご覧ください。