全般
このモジュールには、Thread のすべてのロールに対応する関数が含まれています。
概要
ネットワーク データ パブリッシャーは、ネットワーク データをモニタリングしてエントリを追加または削除するかどうか、またはいつ削除するかを管理することで、スレッド ネットワーク データ内の類似するサービスおよび/またはプレフィックス(メッシュ上のプレフィックスまたは外部ルート)エントリの数を制限するメカニズムを提供します。
このモジュールのすべての関数で OPENTHREAD_CONFIG_NETDATA_PUBLISHER_ENABLE
を有効にする必要があります。
Typedef |
|
---|---|
otBorderRouterConfig
|
typedefstruct otBorderRouterConfig
ボーダー ルーターの構成を表します。 |
otDetachGracefullyCallback)(void *aContext)
|
typedefvoid(*
このコールバックは、接続解除プロセスが完了したことをアプリケーションに通知します。 |
otExternalRouteConfig
|
typedefstruct otExternalRouteConfig
外部ルートの構成を表します。 |
otIpCounters
|
typedefstruct otIpCounters
IP レベルのカウンタを表します。 |
otLeaderData
|
typedefstruct otLeaderData
スレッド リーダー データを表します。 |
otLinkModeConfig
|
typedefstruct otLinkModeConfig
MLE リンクモード構成を表します。 |
otLowpanContextInfo
|
typedefstruct otLowpanContextInfo
ネットワーク データのプレフィックスに関連付けられた 6LoWPAN コンテキスト ID 情報を表します。 |
otMleCounters
|
typedefstruct otMleCounters
スレッド MLE カウンタを表します。 |
otNeighborInfoIterator
|
typedefint16_t
近傍テーブルを反復処理するために使用されます。 |
otNetDataDnsSrpServicePublisherCallback)(otNetDataPublisherEvent aEvent, void *aContext)
|
typedefvoid(*
ポインタの種類は、「DNS/SRP サービス」エントリが Thread ネットワーク データに対して追加または削除されたときの通知に使用するコールバックを定義します。 |
otNetDataPrefixPublisherCallback)(otNetDataPublisherEvent aEvent, const otIp6Prefix *aPrefix, void *aContext)
|
typedefvoid(*
ポインタの種類は、プレフィックス(メッシュまたは外部ルート)のエントリが Thread ネットワーク データに追加またはスレッド ネットワーク データから削除されたときに通知するコールバックを定義します。 |
otNetDataPublisherEvent
|
typedef パブリッシャーのコールバックからレポートされたイベントを表します。 |
otNetworkDataIterator
|
typedefuint32_t
ネットワーク データ情報を反復処理するために使用します。 |
otNetworkDiagChildEntry
|
typedefstruct otNetworkDiagChildEntry
ネットワーク診断の子テーブル エントリを表します。 |
otNetworkDiagConnectivity
|
typedefstruct otNetworkDiagConnectivity
ネットワーク診断接続の値を表します。 |
otNetworkDiagIterator
|
typedefuint16_t
ネットワーク診断 TLV の反復処理に使用されます。 |
otNetworkDiagMacCounters
|
typedefstruct otNetworkDiagMacCounters
ネットワーク診断 Mac カウンタの値を表します。 |
otNetworkDiagMleCounters
|
typedefstruct otNetworkDiagMleCounters
ネットワーク診断 MLE カウンタの値を表します。 |
otNetworkDiagRoute
|
typedefstruct otNetworkDiagRoute
ネットワーク診断ルートの TLV 値を表します。 |
otNetworkDiagRouteData
|
typedefstruct otNetworkDiagRouteData
ネットワーク診断ルートデータを表します。 |
otNetworkDiagTlv
|
typedefstruct otNetworkDiagTlv
ネットワーク診断 TLV を表します。 |
otReceiveDiagnosticGetCallback)(otError aError, otMessage *aMessage, const otMessageInfo *aMessageInfo, void *aContext)
|
typedefvoid(*
Network Diagnostic Get のレスポンスを受信すると、ポインタが呼び出されます。 |
otRoutePreference
|
typedefenum otRoutePreference
|
otServerConfig
|
typedefstruct otServerConfig
サーバー構成を表します。 |
otServiceConfig
|
typedefstruct otServiceConfig
Service の構成を表します。 |
otThreadAnycastLocatorCallback)(void *aContext, otError aError, const otIp6Address *aMeshLocalAddress, uint16_t aRloc16)
|
typedefvoid(*
ポインタ型は、 otThreadLocateAnycastDestination() リクエストの結果を通知するコールバックを定義します。 |
otThreadDiscoveryRequestCallback)(const otThreadDiscoveryRequestInfo *aInfo, void *aContext)
|
typedefvoid(*
ポインタは、MLE 検出リクエスト メッセージを受信するたびに呼び出されます。 |
otThreadDiscoveryRequestInfo
|
typedefstruct otThreadDiscoveryRequestInfo
スレッド検出リクエストのデータを表します。 |
otThreadParentResponseCallback)(otThreadParentResponseInfo *aInfo, void *aContext)
|
typedefvoid(*
ポインタは、MLE 親応答メッセージを受信するたびに呼び出されます。 |
otThreadParentResponseInfo
|
typedefstruct 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)
|
パーティションのスレッド ネットワーク データの完全版または安定したコピーを提供します。
|
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)
|
パーティションのネットワーク データから、次の 6LoWPAN コンテキスト ID の情報を取得します。
|
otNetDataGetNextOnMeshPrefix(otInstance *aInstance, otNetworkDataIterator *aIterator, otBorderRouterConfig *aConfig)
|
パーティションのネットワーク データの次の On Mesh プレフィックスを取得します。
|
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
現在公開されているプレフィックス エントリ(メッシュ上または外部ルート)が 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)
|
Thread ネットワーク データに外部ルート プレフィックスを公開するようリクエストします。
|
otNetDataPublishOnMeshPrefix(otInstance *aInstance, const otBorderRouterConfig *aConfig)
|
スレッド ネットワーク データでメッシュ上のプレフィックスを公開するようリクエストします。
|
otNetDataReplacePublishedExternalRoute(otInstance *aInstance, const otIp6Prefix *aPrefix, const otExternalRouteConfig *aConfig)
|
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)
|
ステアリング データに Joiner が含まれているかどうかを確認します。
|
otNetDataSteeringDataCheckJoinerWithDiscerner(otInstance *aInstance, const struct otJoinerDiscerner *aDiscerner)
|
ステアリング データに、特定の識別値を持つ Joiner が含まれているかどうかを確認します。
|
otNetDataUnpublishDnsSrpService(otInstance *aInstance)
|
void
以前に追加された DNS/SRP(エニーキャストまたはユニキャスト)サービス エントリを Thread ネットワーク データから公開停止します。
|
otNetDataUnpublishPrefix(otInstance *aInstance, const otIp6Prefix *aPrefix)
|
以前に公開されたオンメッシュまたは外部ルート プレフィックスを非公開にします。
|
otThreadBecomeChild(otInstance *aInstance)
|
お子様として再度関連付けてみます。
|
otThreadBecomeDetached(otInstance *aInstance)
|
Thread ネットワークから切断します。
|
otThreadDetachGracefully(otInstance *aInstance, otDetachGracefullyCallback aCallback, void *aContext)
|
ネットワーク内の他のノードに通知して(存在する場合)、スレッド プロトコル オペレーションを停止します。
|
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 *
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)
|
スレッド リーダーのデータを取得します。
|
otThreadGetLeaderRloc(otInstance *aInstance, otIp6Address *aLeaderRloc)
|
リーダーの 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)
|
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)
|
Thread ネットワーク キーの
otNetworkKeyRef を取得します。 |
otThreadGetNetworkName(otInstance *aInstance)
|
const char *
Thread ネットワーク名を取得します。
|
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)
|
指定された 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)
|
指定されたエニーキャスト アドレスに最も近い宛先を要求します。
|
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)
|
現在の親に関連付けたまま、子がより適切な親を検索するプロセスを開始します。
|
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 拡張 PAN ID を設定します。
|
otThreadSetFixedDuaInterfaceIdentifier(otInstance *aInstance, const otIp6InterfaceIdentifier *aIid)
|
スレッド ドメイン ユニキャスト アドレスに手動で指定されたインターフェース識別子を設定またはクリアします。
|
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)
|
Thread ネットワーク キーを設定します。
|
otThreadSetNetworkKeyRef(otInstance *aInstance, otNetworkKeyRef aKeyRef)
|
Thread ネットワーク キーを
otNetworkKeyRef として設定します。 |
otThreadSetNetworkName(otInstance *aInstance, const char *aNetworkName)
|
Thread ネットワーク名を設定します。
|
otThreadSetVendorModel(otInstance *aInstance, const char *aVendorModel)
|
ベンダーのモデル文字列を設定します。
|
otThreadSetVendorName(otInstance *aInstance, const char *aVendorName)
|
ベンダー名の文字列を設定します。
|
otThreadSetVendorSwVersion(otInstance *aInstance, const char *aVendorSwVersion)
|
ベンダーのソフトウェア バージョン文字列を設定します。
|
構造体 |
|
---|---|
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
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
otDetachGracefullyCallback
void(* otDetachGracefullyCallback)(void *aContext)
このコールバックは、接続解除プロセスが完了したことをアプリケーションに通知します。
詳細 | |||
---|---|---|---|
パラメータ |
|
otLowpanContextInfo
struct otLowpanContextInfo otLowpanContextInfo
ネットワーク データのプレフィックスに関連付けられた 6LoWPAN コンテキスト ID 情報を表します。
otNeighborInfoIterator
int16_t otNeighborInfoIterator
近傍テーブルを反復処理するために使用されます。
otNetDataDnsSrpServicePublisherCallback
void(* otNetDataDnsSrpServicePublisherCallback)(otNetDataPublisherEvent aEvent, void *aContext)
ポインタの種類は、「DNS/SRP サービス」エントリが Thread ネットワーク データに対して追加または削除されたときの通知に使用するコールバックを定義します。
削除時は、Publisher
によってエントリが削除されたかどうか(たとえば、ネットワーク データにすでに同様のエントリが多すぎる場合など)、またはエントリを公開停止するための明示的な呼び出し(otNetDataUnpublishDnsSrpService()
の呼び出し)に関係なく、コールバックが呼び出されます。
詳細 | |||||
---|---|---|---|---|---|
パラメータ |
|
otNetDataPrefixPublisherCallback
void(* otNetDataPrefixPublisherCallback)(otNetDataPublisherEvent aEvent, const otIp6Prefix *aPrefix, void *aContext)
ポインタの種類は、プレフィックス(メッシュまたは外部ルート)のエントリが Thread ネットワーク データに追加またはスレッド ネットワーク データから削除されたときに通知するコールバックを定義します。
削除時は、Publisher
によってエントリが削除されたかどうかに関係なく(たとえば、ネットワーク データにすでに同様のエントリが多すぎる場合など)、またはエントリを公開するための明示的な呼び出しによって、コールバックが呼び出されます。
詳細 | |||||||
---|---|---|---|---|---|---|---|
パラメータ |
|
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 カウンタの値を表します。
otReceiveDiagnosticGetCallback
void(* otReceiveDiagnosticGetCallback)(otError aError, otMessage *aMessage, const otMessageInfo *aMessageInfo, void *aContext)
Network Diagnostic Get のレスポンスを受信すると、ポインタが呼び出されます。
詳細 | |||||||||
---|---|---|---|---|---|---|---|---|---|
パラメータ |
|
otRoutePreference
enum otRoutePreference otRoutePreference
otExternalRouteConfig
と otBorderRouterConfig
で mPreference
に有効な値を定義します。
otThreadAnycastLocatorCallback
void(* otThreadAnycastLocatorCallback)(void *aContext, otError aError, const otIp6Address *aMeshLocalAddress, uint16_t aRloc16)
ポインタ型は、otThreadLocateAnycastDestination()
リクエストの結果を通知するコールバックを定義します。
詳細 | |||||||||
---|---|---|---|---|---|---|---|---|---|
パラメータ |
|
otThreadDiscoveryRequestCallback
void(* otThreadDiscoveryRequestCallback)(const otThreadDiscoveryRequestInfo *aInfo, void *aContext)
ポインタは、MLE 検出リクエスト メッセージを受信するたびに呼び出されます。
詳細 | |||||
---|---|---|---|---|---|
パラメータ |
|
otThreadDiscoveryRequestInfo
struct otThreadDiscoveryRequestInfo otThreadDiscoveryRequestInfo
スレッド検出リクエストのデータを表します。
otThreadParentResponseCallback
void(* otThreadParentResponseCallback)(otThreadParentResponseInfo *aInfo, void *aContext)
ポインタは、MLE 親応答メッセージを受信するたびに呼び出されます。
otThreadRegisterParentResponseCallback()
で使用されます。
詳細 | |||||
---|---|---|---|---|---|
パラメータ |
|
otThreadParentResponseInfo
struct otThreadParentResponseInfo otThreadParentResponseInfo
MLE の親レスポンス データを表します。
関数
otConvertDurationInSecondsToString
void otConvertDurationInSecondsToString(
uint32_t aDuration,
char *aBuffer,
uint16_t aSize
)
uint32_t
期間(秒単位)を人が読める文字列に変換します。
OPENTHREAD_CONFIG_UPTIME_ENABLE
を有効にする必要があります。
文字列は、時間、分、秒(期間が 1 日未満の場合は
結果の文字列が aSize
文字内の aBuffer
に収まらない場合、文字列は切り捨てられますが、出力される文字列は常に null で終わる文字列になります。
otNeighborInfo
または otChildInfo
構造内の mAge
または mConnectionTime
で使用するためのものです。
詳細 | |||||||
---|---|---|---|---|---|---|---|
パラメータ |
|
otNetDataContainsOmrPrefix
bool otNetDataContainsOmrPrefix(
otInstance *aInstance,
const otIp6Prefix *aPrefix
)
指定されたプレフィックスが有効な OMR プレフィックスとして機能でき、リーダーのネットワーク データにもこのプレフィックスが含まれているかどうかを確認します。
詳細 | |||||
---|---|---|---|---|---|
パラメータ |
|
||||
戻り値 |
aPrefix が有効な OMR プレフィックスであり、リーダーのネットワーク データに OMR プレフィックス aPrefix が含まれているかどうか。 |
otNetDataGet
otError otNetDataGet(
otInstance *aInstance,
bool aStable,
uint8_t *aData,
uint8_t *aDataLength
)
パーティションのスレッド ネットワーク データの完全版または安定したコピーを提供します。
詳細 | |||||||||
---|---|---|---|---|---|---|---|---|---|
パラメータ |
|
||||||||
戻り値 |
|
otNetDataGetCommissioningDataset
void otNetDataGetCommissioningDataset(
otInstance *aInstance,
otCommissioningDataset *aDataset
)
パーティションのネットワーク データからコミッショニング データセットを取得します。
詳細 | |||||
---|---|---|---|---|---|
パラメータ |
|
otNetDataGetLength
uint8_t otNetDataGetLength(
otInstance *aInstance
)
パーティションのスレッド ネットワーク データの現在の長さ(バイト数)を取得します。
詳細 | |||
---|---|---|---|
パラメータ |
|
||
戻り値 |
ネットワーク データの長さ。
|
otNetDataGetMaxLength
uint8_t otNetDataGetMaxLength(
otInstance *aInstance
)
OT スタックの初期化以降、または最後の otNetDataResetMaxLength()
呼び出し以降のスレッド ネットワーク データの観測最大長を取得します。
詳細 | |||
---|---|---|---|
パラメータ |
|
||
戻り値 |
ネットワーク データの最大長(ネットワーク データの長さの最大ウォーターマーク)。
|
otNetDataGetNextLowpanContextInfo
otError otNetDataGetNextLowpanContextInfo(
otInstance *aInstance,
otNetworkDataIterator *aIterator,
otLowpanContextInfo *aContextInfo
)
パーティションのネットワーク データから、次の 6LoWPAN コンテキスト ID の情報を取得します。
詳細 | |||||||
---|---|---|---|---|---|---|---|
パラメータ |
|
||||||
戻り値 |
|
otNetDataGetNextOnMeshPrefix
otError otNetDataGetNextOnMeshPrefix(
otInstance *aInstance,
otNetworkDataIterator *aIterator,
otBorderRouterConfig *aConfig
)
パーティションのネットワーク データの次の On Mesh プレフィックスを取得します。
詳細 | |||||||
---|---|---|---|---|---|---|---|
パラメータ |
|
||||||
戻り値 |
|
otNetDataGetNextRoute
otError otNetDataGetNextRoute(
otInstance *aInstance,
otNetworkDataIterator *aIterator,
otExternalRouteConfig *aConfig
)
パーティションのネットワーク データで次の外部ルートを取得します。
詳細 | |||||||
---|---|---|---|---|---|---|---|
パラメータ |
|
||||||
戻り値 |
|
otNetDataGetNextService
otError otNetDataGetNextService(
otInstance *aInstance,
otNetworkDataIterator *aIterator,
otServiceConfig *aConfig
)
パーティションのネットワーク データで次のサービスを取得します。
詳細 | |||||||
---|---|---|---|---|---|---|---|
パラメータ |
|
||||||
戻り値 |
|
otNetDataGetStableVersion
uint8_t otNetDataGetStableVersion(
otInstance *aInstance
)
安定したネットワーク データ バージョンを取得します。
詳細 | |||
---|---|---|---|
パラメータ |
|
||
戻り値 |
ネットワークのデータ安定バージョン
|
otNetDataGetVersion
uint8_t otNetDataGetVersion(
otInstance *aInstance
)
ネットワーク データ バージョンを取得します。
詳細 | |||
---|---|---|---|
パラメータ |
|
||
戻り値 |
ネットワーク データ バージョン。
|
otNetDataIsDnsSrpServiceAdded
bool otNetDataIsDnsSrpServiceAdded(
otInstance *aInstance
)
現在「DNS/SRP サービス」エントリが Thread ネットワーク データに追加されているかどうかを示します。
OPENTHREAD_CONFIG_TMF_NETDATA_SERVICE_ENABLE
機能を有効にする必要があります。
詳細 | |||||
---|---|---|---|---|---|
パラメータ |
|
||||
戻り値 |
|
otNetDataIsPrefixAdded
bool otNetDataIsPrefixAdded(
otInstance *aInstance,
const otIp6Prefix *aPrefix
)
現在公開されているプレフィックス エントリ(メッシュ上または外部ルート)が Thread ネットワーク データに追加されているかどうかを示します。
OPENTHREAD_CONFIG_BORDER_ROUTER_ENABLE
機能を有効にする必要があります。
詳細 | |||||
---|---|---|---|---|---|
パラメータ |
|
||||
戻り値 |
|
otNetDataPublishDnsSrpServiceAnycast
void otNetDataPublishDnsSrpServiceAnycast(
otInstance *aInstance,
uint8_t aSequenceNUmber
)
「DNS/SRP サービス エニーキャスト アドレス」を Thread ネットワーク データで公開するようリクエストします。
OPENTHREAD_CONFIG_TMF_NETDATA_SERVICE_ENABLE
機能を有効にする必要があります。
この関数を呼び出すと、前の otNetDataPublishDnsSrpService{Type}()
関数の呼び出しで公開されていた「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
機能を有効にする必要があります。
この関数を呼び出すと、前の otNetDataPublishDnsSrpService{Type}()
関数の呼び出しで公開されていた「DNS/SRP サービス」のエントリが削除され、置き換えられます。
サービス TLV データにアドレスとポートの情報を含めることで「DNS/SRP サービス ユニキャスト アドレス」を公開します。
詳細 | |||||||
---|---|---|---|---|---|---|---|
パラメータ |
|
otNetDataPublishDnsSrpServiceUnicastMeshLocalEid
void otNetDataPublishDnsSrpServiceUnicastMeshLocalEid(
otInstance *aInstance,
uint16_t aPort
)
「DNS/SRP Service Unicast Address」を Thread ネットワーク データで公開するようリクエストします。
OPENTHREAD_CONFIG_TMF_NETDATA_SERVICE_ENABLE
機能を有効にする必要があります。
この関数を呼び出すと、前の otNetDataPublishDnsSrpService{Type}()
関数の呼び出しで公開されていた「DNS/SRP サービス」のエントリが削除され、置き換えられます。
公開アドレスを指定してサービス TLV データに情報を含める otNetDataPublishDnsSrpServiceUnicast()
とは異なり、この関数はデバイスのメッシュローカル EID を使用し、サーバー TLV データに情報を含めます。
詳細 | |||||
---|---|---|---|---|---|
パラメータ |
|
otNetDataPublishExternalRoute
otError otNetDataPublishExternalRoute(
otInstance *aInstance,
const otExternalRouteConfig *aConfig
)
Thread ネットワーク データに外部ルート プレフィックスを公開するようリクエストします。
OPENTHREAD_CONFIG_BORDER_ROUTER_ENABLE
機能を有効にする必要があります。
安定したエントリ(aConfig.mStable
は TRUE でなければなりません)。
このメソッドのその後の呼び出しにより、同じ接頭辞の以前のリクエストが置き換えられます。特に、新しい呼び出しでフラグ(優先レベルなど)を変更するだけで、すでにネットワーク データにプレフィックスが追加されている場合、フラグの変更はすぐにネットワーク データに反映されます。これにより、ネットワーク データの既存のエントリが突然削除されることがなくなります。優先レベルが変更されると、同じかそれ以上の優先で同じ接頭辞を公開している他のノードが他にも存在すると判断された後、そのエントリがネットワーク データから削除される可能性があります。
詳細 | |||||||
---|---|---|---|---|---|---|---|
パラメータ |
|
||||||
戻り値 |
|
otNetDataPublishOnMeshPrefix
otError otNetDataPublishOnMeshPrefix(
otInstance *aInstance,
const otBorderRouterConfig *aConfig
)
スレッド ネットワーク データでメッシュ上のプレフィックスを公開するようリクエストします。
OPENTHREAD_CONFIG_BORDER_ROUTER_ENABLE
機能を有効にする必要があります。
安定したエントリ(aConfig.mStable
は TRUE でなければなりません)。
このメソッドのその後の呼び出しにより、同じ接頭辞の以前のリクエストが置き換えられます。特に、新しい呼び出しでフラグ(優先レベルなど)を変更するだけで、すでにネットワーク データにプレフィックスが追加されている場合、フラグの変更はすぐにネットワーク データに反映されます。これにより、ネットワーク データの既存のエントリが突然削除されることがなくなります。優先レベルが変更されると、同じかそれ以上の優先で同じ接頭辞を公開している他のノードが他にも存在すると判断された後、そのエントリがネットワーク データから削除される可能性があります。
詳細 | |||||||
---|---|---|---|---|---|---|---|
パラメータ |
|
||||||
戻り値 |
|
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
接頭辞に置き換えられますが、すぐには追加されません。代わりに、ネットワーク データに公開するプロセスを開始します(ネットワーク データをモニタリングして、ネットワーク データに存在する類似の接頭辞の数に応じて、接頭辞を追加するタイミングや追加の有無を判断します)。
詳細 | |||||||
---|---|---|---|---|---|---|---|
パラメータ |
|
||||||
戻り値 |
|
otNetDataResetMaxLength
void otNetDataResetMaxLength(
otInstance *aInstance
)
Thread ネットワーク データのトラッキングされている最大長をリセットします。
詳細 | |||
---|---|---|---|
パラメータ |
|
otNetDataGetMaxLength
otNetDataSetDnsSrpServicePublisherCallback
void otNetDataSetDnsSrpServicePublisherCallback(
otInstance *aInstance,
otNetDataDnsSrpServicePublisherCallback aCallback,
void *aContext
)
公開された「DNS/SRP サービス」が実際に Thread ネットワーク データに追加または Thread ネットワーク データから削除されたときに通知するためのコールバックを設定します。
この関数を次の呼び出しを行うと、以前に設定したコールバック関数がすべて置き換えられます。
OPENTHREAD_CONFIG_TMF_NETDATA_SERVICE_ENABLE
機能を有効にする必要があります。
詳細 | |||||||
---|---|---|---|---|---|---|---|
パラメータ |
|
otNetDataSetPrefixPublisherCallback
void otNetDataSetPrefixPublisherCallback(
otInstance *aInstance,
otNetDataPrefixPublisherCallback aCallback,
void *aContext
)
公開されたプレフィックス エントリが Thread ネットワーク データに対して実際に追加または削除されたときに通知するコールバックを設定します。
この関数を次の呼び出しを行うと、以前に設定したコールバック関数がすべて置き換えられます。
OPENTHREAD_CONFIG_BORDER_ROUTER_ENABLE
機能を有効にする必要があります。
詳細 | |||||||
---|---|---|---|---|---|---|---|
パラメータ |
|
otNetDataSteeringDataCheckJoiner
otError otNetDataSteeringDataCheckJoiner(
otInstance *aInstance,
const otExtAddress *aEui64
)
ステアリング データに Joiner が含まれているかどうかを確認します。
詳細 | |||||||
---|---|---|---|---|---|---|---|
パラメータ |
|
||||||
戻り値 |
|
otNetDataSteeringDataCheckJoinerWithDiscerner
otError otNetDataSteeringDataCheckJoinerWithDiscerner(
otInstance *aInstance,
const struct otJoinerDiscerner *aDiscerner
)
ステアリング データに、特定の識別値を持つ Joiner が含まれているかどうかを確認します。
詳細 | |||||||
---|---|---|---|---|---|---|---|
パラメータ |
|
||||||
戻り値 |
|
otNetDataUnpublishDnsSrpService
void otNetDataUnpublishDnsSrpService(
otInstance *aInstance
)
以前に追加された DNS/SRP(エニーキャストまたはユニキャスト)サービス エントリを Thread ネットワーク データから公開停止します。
OPENTHREAD_CONFIG_TMF_NETDATA_SERVICE_ENABLE
を有効にする必要があります。
詳細 | |||
---|---|---|---|
パラメータ |
|
otNetDataUnpublishPrefix
otError otNetDataUnpublishPrefix(
otInstance *aInstance,
const otIp6Prefix *aPrefix
)
以前に公開されたオンメッシュまたは外部ルート プレフィックスを非公開にします。
OPENTHREAD_CONFIG_BORDER_ROUTER_ENABLE
を有効にする必要があります。
詳細 | |||||
---|---|---|---|---|---|
パラメータ |
|
||||
戻り値 |
|
otThreadBecomeChild
otError otThreadBecomeChild(
otInstance *aInstance
)
お子様として再度関連付けてみます。
詳細 | |||||
---|---|---|---|---|---|
パラメータ |
|
||||
戻り値 |
|
otThreadBecomeDetached
otError otThreadBecomeDetached(
otInstance *aInstance
)
Thread ネットワークから切断します。
詳細 | |||||
---|---|---|---|---|---|
パラメータ |
|
||||
戻り値 |
|
otThreadDetachGracefully
otError otThreadDetachGracefully(
otInstance *aInstance,
otDetachGracefullyCallback aCallback,
void *aContext
)
ネットワーク内の他のノードに通知して(存在する場合)、スレッド プロトコル オペレーションを停止します。
ルーターの場合は Address Release を送信し、子の場合は、子タイムアウトを 0 に設定します。
詳細 | |||||||
---|---|---|---|---|---|---|---|
パラメータ |
|
||||||
戻り値 |
|
otThreadDeviceRoleToString
const char * otThreadDeviceRoleToString(
otDeviceRole aRole
)
デバイスロールを人が読める文字列に変換します。
詳細 | |||
---|---|---|---|
パラメータ |
|
||
戻り値 |
aRole を表す文字列。 |
otThreadDiscover
otError otThreadDiscover(
otInstance *aInstance,
uint32_t aScanChannels,
uint16_t aPanId,
bool aJoiner,
bool aEnableEui64Filtering,
otHandleActiveScanResult aCallback,
void *aCallbackContext
)
スレッド検出スキャンを開始します。
詳細 | |||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
パラメータ |
|
||||||||||||||
戻り値 |
|
otThreadGetChildTimeout
uint32_t otThreadGetChildTimeout(
otInstance *aInstance
)
子ロールで操作する際に使用されるスレッドの子タイムアウト(秒単位)を取得します。
詳細 | |||
---|---|---|---|
パラメータ |
|
||
戻り値 |
スレッドの子タイムアウト値(秒)。
|
otThreadSetChildTimeout
otThreadGetDeviceRole
otDeviceRole otThreadGetDeviceRole(
otInstance *aInstance
)
デバイスのロールを取得します。
詳細 | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
パラメータ |
|
||||||||||
戻り値 |
|
otThreadGetDomainName
const char * otThreadGetDomainName(
otInstance *aInstance
)
Thread ドメイン名を取得します。
詳細 | |||
---|---|---|---|
パラメータ |
|
||
戻り値 |
スレッドのドメイン名へのポインタ。
|
otThreadSetDomainName
otThreadGetExtendedPanId
const otExtendedPanId * otThreadGetExtendedPanId(
otInstance *aInstance
)
IEEE 802.15.4 拡張 PAN ID を取得します。
詳細 | |||
---|---|---|---|
パラメータ |
|
||
戻り値 |
IEEE 802.15.4 拡張 PAN ID へのポインタ。
|
otThreadSetExtendedPanId
otThreadGetFixedDuaInterfaceIdentifier
const otIp6InterfaceIdentifier * otThreadGetFixedDuaInterfaceIdentifier(
otInstance *aInstance
)
スレッド ドメインのユニキャスト アドレスに手動で指定されたインターフェース ID を取得します。
OPENTHREAD_CONFIG_DUA_ENABLE
が有効な場合に利用可能です。
詳細 | |||
---|---|---|---|
パラメータ |
|
||
戻り値 |
手動で設定されたインターフェース ID へのポインタ。設定されていない場合は NULL。
|
otThreadSetFixedDuaInterfaceIdentifier
otThreadGetIp6Counters
const otIpCounters * otThreadGetIp6Counters(
otInstance *aInstance
)
IPv6 カウンタを取得します。
詳細 | |||
---|---|---|---|
パラメータ |
|
||
戻り値 |
IPv6 カウンタへのポインタ。
|
otThreadGetKeySequenceCounter
uint32_t otThreadGetKeySequenceCounter(
otInstance *aInstance
)
thrKeySequenceCounter を取得します。
詳細 | |||
---|---|---|---|
パラメータ |
|
||
戻り値 |
thrKeySequenceCounter 値。
|
otThreadSetKeySequenceCounter
otThreadGetKeySwitchGuardTime
uint32_t otThreadGetKeySwitchGuardTime(
otInstance *aInstance
)
thrKeySwitchGuardTime(時間単位)を取得します。
詳細 | |||
---|---|---|---|
パラメータ |
|
||
戻り値 |
thrKeySwitchGuardTime 値(時間単位)。
|
otThreadSetKeySwitchGuardTime
otThreadGetLeaderData
otError otThreadGetLeaderData(
otInstance *aInstance,
otLeaderData *aLeaderData
)
スレッド リーダーのデータを取得します。
詳細 | |||||
---|---|---|---|---|---|
パラメータ |
|
||||
戻り値 |
|
otThreadGetLeaderRloc
otError otThreadGetLeaderRloc(
otInstance *aInstance,
otIp6Address *aLeaderRloc
)
リーダーの RLOC へのポインタを返します。
詳細 | |||||||
---|---|---|---|---|---|---|---|
パラメータ |
|
||||||
戻り値 |
|
otThreadGetLeaderRouterId
uint8_t otThreadGetLeaderRouterId(
otInstance *aInstance
)
リーダーのルーター ID を取得します。
詳細 | |||
---|---|---|---|
パラメータ |
|
||
戻り値 |
リーダーのルーター ID。
|
otThreadGetLeaderWeight
uint8_t otThreadGetLeaderWeight(
otInstance *aInstance
)
リーダーの体重をゲットしましょう。
詳細 | |||
---|---|---|---|
パラメータ |
|
||
戻り値 |
リーダーの体重。
|
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 に設定
詳細 | |||
---|---|---|---|
パラメータ |
|
||
戻り値 |
スレッドリンクローカル全スレッドノードのマルチキャスト アドレスへのポインタ。
|
otThreadGetLinkLocalIp6Address
const otIp6Address * otThreadGetLinkLocalIp6Address(
otInstance *aInstance
)
Thread のリンクローカル IPv6 アドレスを取得します。
スレッドリンクのローカル アドレスは、インターフェース識別子として IEEE802.15.4 拡張アドレスを使用して導出されます。
詳細 | |||
---|---|---|---|
パラメータ |
|
||
戻り値 |
スレッドのリンクローカル IPv6 アドレスへのポインタ。
|
otThreadGetLinkMode
otLinkModeConfig otThreadGetLinkMode(
otInstance *aInstance
)
MLE リンクモードの構成を取得します。
詳細 | |||
---|---|---|---|
パラメータ |
|
||
戻り値 |
MLE リンクモードの構成。
|
otThreadSetLinkMode
otThreadGetMaxTimeInQueue
uint32_t otThreadGetMaxTimeInQueue(
otInstance *aInstance
)
TX キュー内のメッセージの最大キュー内時間を取得します。
OPENTHREAD_CONFIG_TX_QUEUE_STATISTICS_ENABLE
が必要です。
キュー内の時間は直接送信についてのみ追跡され、メッセージが送信キューに追加されてから、送信のために MAC レイヤに渡すか破棄されるまでの期間として測定されます。
収集された統計情報は、otThreadResetTimeInQueueStat()
を呼び出してリセットできます。
詳細 | |||
---|---|---|---|
パラメータ |
|
||
戻り値 |
現在までの TX キュー内のすべてのメッセージの最大キュー内時間(ミリ秒)。
|
otThreadGetMeshLocalEid
const otIp6Address * otThreadGetMeshLocalEid(
otInstance *aInstance
)
メッシュ ローカル EID アドレスを取得します。
詳細 | |||
---|---|---|---|
パラメータ |
|
||
戻り値 |
メッシュ ローカル EID アドレスへのポインタ。
|
otThreadGetMeshLocalPrefix
const otMeshLocalPrefix * otThreadGetMeshLocalPrefix(
otInstance *aInstance
)
メッシュ ローカル プレフィックスへのポインタを返します。
詳細 | |||
---|---|---|---|
パラメータ |
|
||
戻り値 |
メッシュ ローカル プレフィックスへのポインタ。
|
otThreadGetMleCounters
const otMleCounters * otThreadGetMleCounters(
otInstance *aInstance
)
Thread MLE カウンタを取得します。
詳細 | |||
---|---|---|---|
パラメータ |
|
||
戻り値 |
スレッド MLE カウンタへのポインタ。
|
otThreadGetNetworkKey
void otThreadGetNetworkKey(
otInstance *aInstance,
otNetworkKey *aNetworkKey
)
Thread ネットワーク キーを取得します。
詳細 | |||||
---|---|---|---|---|---|
パラメータ |
|
otThreadSetNetworkKey
otThreadGetNetworkKeyRef
otNetworkKeyRef otThreadGetNetworkKeyRef(
otInstance *aInstance
)
Thread ネットワーク キーの otNetworkKeyRef
を取得します。
ビルド時の機能 OPENTHREAD_CONFIG_PLATFORM_KEY_REFERENCES_ENABLE
を有効にする必要があります。
詳細 | |||
---|---|---|---|
パラメータ |
|
||
戻り値 |
メモリに保存されている Thread ネットワーク キーへの参照。
|
otThreadSetNetworkKeyRef
otThreadGetNetworkName
const char * otThreadGetNetworkName(
otInstance *aInstance
)
Thread ネットワーク名を取得します。
詳細 | |||
---|---|---|---|
パラメータ |
|
||
戻り値 |
スレッド ネットワーク名へのポインタ。
|
otThreadSetNetworkName
otThreadGetNextDiagnosticTlv
otError otThreadGetNextDiagnosticTlv(
const otMessage *aMessage,
otNetworkDiagIterator *aIterator,
otNetworkDiagTlv *aNetworkDiagTlv
)
メッセージの次のネットワーク診断 TLV を取得します。
OPENTHREAD_CONFIG_TMF_NETDIAG_CLIENT_ENABLE
が必要です。
この関数の後続の呼び出しは、現在の戻り値が OT_ERROR_NONE の場合にのみ許可されます。
詳細 | |||||||
---|---|---|---|---|---|---|---|
パラメータ |
|
||||||
戻り値 |
|
otThreadGetNextNeighborInfo
otError otThreadGetNextNeighborInfo(
otInstance *aInstance,
otNeighborInfoIterator *aIterator,
otNeighborInfo *aInfo
)
次のネイバー情報を取得します。
ネイバー テーブルのエントリを通過するために使用されます。
詳細 | |||||||
---|---|---|---|---|---|---|---|
パラメータ |
|
||||||
戻り値 |
|
otThreadGetParentAverageRssi
otError otThreadGetParentAverageRssi(
otInstance *aInstance,
int8_t *aParentRssi
)
この関数は、スレッドの親の平均 RSSI を取得します。
詳細 | |||||
---|---|---|---|---|---|
パラメータ |
|
otThreadGetParentInfo
otError otThreadGetParentInfo(
otInstance *aInstance,
otRouterInfo *aParentInfo
)
この関数は、親として Thread Router の診断情報を取得します。
詳細 | |||||
---|---|---|---|---|---|
パラメータ |
|
otThreadGetParentLastRssi
otError otThreadGetParentLastRssi(
otInstance *aInstance,
int8_t *aLastRssi
)
この関数は、スレッドの親から最後のパケットの RSSI を取得します。
詳細 | |||||||
---|---|---|---|---|---|---|---|
パラメータ |
|
||||||
戻り値 |
|
otThreadGetPartitionId
uint32_t otThreadGetPartitionId(
otInstance *aInstance
)
パーティション ID を取得します。
詳細 | |||
---|---|---|---|
パラメータ |
|
||
戻り値 |
パーティション ID。
|
otThreadGetRealmLocalAllThreadNodesMulticastAddress
const otIp6Address * otThreadGetRealmLocalAllThreadNodesMulticastAddress(
otInstance *aInstance
)
スレッド レルムローカルのすべてのスレッドノードのマルチキャスト アドレスを取得します。
このアドレスは、レルムローカルのユニキャスト プレフィックスベースのマルチキャスト アドレス [RFC 3306] で、
- flgs を 3 に設定(P = 1、T = 1)
- スカップを 3 に設定
- プレンを 64 に設定
- ネットワーク プレフィックスがメッシュ ローカル プレフィックスに設定されている
- グループ ID を 1 に設定
詳細 | |||
---|---|---|---|
パラメータ |
|
||
戻り値 |
スレッド レルムローカル全スレッドノードのマルチキャスト アドレスへのポインタ。
|
otThreadGetRloc
const otIp6Address * otThreadGetRloc(
otInstance *aInstance
)
スレッド ルーティング ロケータ(RLOC)アドレスを取得します。
詳細 | |||
---|---|---|---|
パラメータ |
|
||
戻り値 |
スレッド ルーティング ロケータ(RLOC)アドレスへのポインタ。
|
otThreadGetRloc16
uint16_t otThreadGetRloc16(
otInstance *aInstance
)
RLOC16 を入手します。
詳細 | |||
---|---|---|---|
パラメータ |
|
||
戻り値 |
RLOC16.
|
otThreadGetServiceAloc
otError otThreadGetServiceAloc(
otInstance *aInstance,
uint8_t aServiceId,
otIp6Address *aServiceAloc
)
指定された Service ID のサービス ALOC を取得します。
詳細 | |||||||
---|---|---|---|---|---|---|---|
パラメータ |
|
||||||
戻り値 |
|
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 であってはなりません。
詳細 | |||||||
---|---|---|---|---|---|---|---|
パラメータ |
|
||||||
戻り値 |
収集されたヒストグラム情報を表す
aNumBins エントリの配列へのポインタ。 |
otThreadGetVendorModel
const char * otThreadGetVendorModel(
otInstance *aInstance
)
ベンダーモデル文字列を取得します。
詳細 | |||
---|---|---|---|
パラメータ |
|
||
戻り値 |
ベンダーのモデル文字列。
|
otThreadGetVendorName
const char * otThreadGetVendorName(
otInstance *aInstance
)
ベンダー名の文字列を取得します。
詳細 | |||
---|---|---|---|
パラメータ |
|
||
戻り値 |
ベンダー名の文字列。
|
otThreadGetVendorSwVersion
const char * otThreadGetVendorSwVersion(
otInstance *aInstance
)
ベンダーのソフトウェア バージョン文字列を取得します。
詳細 | |||
---|---|---|---|
パラメータ |
|
||
戻り値 |
ベンダーのソフトウェア バージョンの文字列。
|
otThreadGetVersion
uint16_t otThreadGetVersion(
void
)
Thread プロトコル バージョンを取得します。
詳細 | |
---|---|
戻り値 |
Thread プロトコル バージョン。
|
otThreadIsAnycastLocateInProgress
bool otThreadIsAnycastLocateInProgress(
otInstance *aInstance
)
エニーキャスト ロケーション リクエストが現在進行中かどうかを示します。
OPENTHREAD_CONFIG_TMF_ANYCAST_LOCATOR_ENABLE
が有効な場合にのみ使用できます。
詳細 | |||
---|---|---|---|
パラメータ |
|
||
戻り値 |
エニーキャスト ロケーション リクエストが現在進行中の場合は TRUE、それ以外の場合は FALSE。
|
otThreadIsDiscoverInProgress
bool otThreadIsDiscoverInProgress(
otInstance *aInstance
)
MLE スレッド検出が現在進行中であるかどうかを判断します。
詳細 | |||
---|---|---|---|
パラメータ |
|
otThreadIsSingleton
bool otThreadIsSingleton(
otInstance *aInstance
)
ノードがネットワーク上の唯一のルーターであるかどうかを示します。
詳細 | |||||
---|---|---|---|---|---|
パラメータ |
|
||||
戻り値 |
|
otThreadLocateAnycastDestination
otError otThreadLocateAnycastDestination(
otInstance *aInstance,
const otIp6Address *aAnycastAddress,
otThreadAnycastLocatorCallback aCallback,
void *aContext
)
指定されたエニーキャスト アドレスに最も近い宛先を要求します。
OPENTHREAD_CONFIG_TMF_ANYCAST_LOCATOR_ENABLE
が有効な場合にのみ使用できます。
前のリクエストが進行中の場合、この関数を次回呼び出すと、前のリクエストがキャンセルされ、置き換えられます。
詳細 | |||||||||
---|---|---|---|---|---|---|---|---|---|
パラメータ |
|
||||||||
戻り値 |
|
otThreadRegisterParentResponseCallback
void otThreadRegisterParentResponseCallback(
otInstance *aInstance,
otThreadParentResponseCallback aCallback,
void *aContext
)
MLE 親レスポンス データを受信するコールバックを登録します。
OPENTHREAD_CONFIG_MLE_PARENT_RESPONSE_CALLBACK_API_ENABLE
が必要です。
詳細 | |||||||
---|---|---|---|---|---|---|---|
パラメータ |
|
otThreadResetIp6Counters
void otThreadResetIp6Counters(
otInstance *aInstance
)
IPv6 カウンタをリセットします。
詳細 | |||
---|---|---|---|
パラメータ |
|
otThreadResetMleCounters
void otThreadResetMleCounters(
otInstance *aInstance
)
Thread MLE カウンタをリセットします。
詳細 | |||
---|---|---|---|
パラメータ |
|
otThreadResetTimeInQueueStat
void otThreadResetTimeInQueueStat(
otInstance *aInstance
)
TX キューのキュー内時間統計情報をリセットします。
OPENTHREAD_CONFIG_TX_QUEUE_STATISTICS_ENABLE
が必要です。
詳細 | |||
---|---|---|---|
パラメータ |
|
otThreadSearchForBetterParent
otError otThreadSearchForBetterParent(
otInstance *aInstance
)
現在の親に関連付けたまま、子がより適切な親を検索するプロセスを開始します。
デバイスが子供として接続されている場合に使用する必要があります。
詳細 | |||||
---|---|---|---|---|---|
戻り値 |
|
otThreadSendAddressNotification
void otThreadSendAddressNotification(
otInstance *aInstance,
otIp6Address *aDestination,
otIp6Address *aTarget,
otIp6InterfaceIdentifier *aMlIid
)
Proactive Address Notification(ADDR_NTF.ntf)メッセージを送信します。
OPENTHREAD_CONFIG_REFERENCE_DEVICE_ENABLE
が有効な場合にのみ使用できます。
詳細 | |||||||||
---|---|---|---|---|---|---|---|---|---|
パラメータ |
|
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
が必要です。
詳細 | |||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
パラメータ |
|
||||||||||||
戻り値 |
|
otThreadSendDiagnosticReset
otError otThreadSendDiagnosticReset(
otInstance *aInstance,
const otIp6Address *aDestination,
const uint8_t aTlvTypes[],
uint8_t aCount
)
ネットワーク診断リセット リクエストを送信します。
OPENTHREAD_CONFIG_TMF_NETDIAG_CLIENT_ENABLE
が必要です。
詳細 | |||||||||
---|---|---|---|---|---|---|---|---|---|
パラメータ |
|
||||||||
戻り値 |
|
otThreadSendProactiveBackboneNotification
otError otThreadSendProactiveBackboneNotification(
otInstance *aInstance,
otIp6Address *aTarget,
otIp6InterfaceIdentifier *aMlIid,
uint32_t aTimeSinceLastTransaction
)
バックボーン リンクでプロアクティブ バックボーン通知(PRO_BB.ntf)メッセージを送信します。
OPENTHREAD_CONFIG_REFERENCE_DEVICE_ENABLE
が有効な場合にのみ使用できます。
詳細 | |||||||||
---|---|---|---|---|---|---|---|---|---|
パラメータ |
|
||||||||
戻り値 |
|
otThreadSetChildTimeout
void otThreadSetChildTimeout(
otInstance *aInstance,
uint32_t aTimeout
)
子ロールで操作するときに使用するスレッドの子タイムアウト(秒単位)を設定します。
詳細 | |||||
---|---|---|---|---|---|
パラメータ |
|
otThreadGetChildTimeout
otThreadSetDiscoveryRequestCallback
void otThreadSetDiscoveryRequestCallback(
otInstance *aInstance,
otThreadDiscoveryRequestCallback aCallback,
void *aContext
)
MLE 検出リクエスト データを受信するコールバックを設定します。
詳細 | |||||||
---|---|---|---|---|---|---|---|
パラメータ |
|
otThreadSetDomainName
otError otThreadSetDomainName(
otInstance *aInstance,
const char *aDomainName
)
スレッドのドメイン名を設定します。
Thread プロトコルが無効になっている場合にのみ成功します。
詳細 | |||||
---|---|---|---|---|---|
パラメータ |
|
||||
戻り値 |
|
otThreadGetDomainName
otThreadSetEnabled
otError otThreadSetEnabled(
otInstance *aInstance,
bool aEnabled
)
スレッド プロトコル オペレーションを開始します。
この関数を呼び出すときにインターフェースが動作している必要があります。
aEnabled
を FALSE に設定してこの関数を呼び出すと、otThreadDetachGracefully() によって開始された接続解除の進行中のプロセスが停止し、コールバックが呼び出されます。
詳細 | |||||
---|---|---|---|---|---|
パラメータ |
|
||||
戻り値 |
|
otThreadSetExtendedPanId
otError otThreadSetExtendedPanId(
otInstance *aInstance,
const otExtendedPanId *aExtendedPanId
)
IEEE 802.15.4 拡張 PAN ID を設定します。
詳細 | |||||
---|---|---|---|---|---|
パラメータ |
|
||||
戻り値 |
|
otThreadGetExtendedPanId
otThreadSetFixedDuaInterfaceIdentifier
otError otThreadSetFixedDuaInterfaceIdentifier(
otInstance *aInstance,
const otIp6InterfaceIdentifier *aIid
)
スレッド ドメイン ユニキャスト アドレスに手動で指定されたインターフェース識別子を設定またはクリアします。
OPENTHREAD_CONFIG_DUA_ENABLE
が有効な場合に利用可能です。
詳細 | |||||
---|---|---|---|---|---|
パラメータ |
|
||||
戻り値 |
|
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 など)をアドバタイズし、人手を介さずにこの情報をコミッショナーまたはコミッショナーの候補に利用できるようにするために使用されます。
詳細 | |||||||||
---|---|---|---|---|---|---|---|---|---|
パラメータ |
|
||||||||
戻り値 |
|
otThreadSetKeySequenceCounter
void otThreadSetKeySequenceCounter(
otInstance *aInstance,
uint32_t aKeySequenceCounter
)
thrKeySequenceCounter を設定します。
詳細 | |||||
---|---|---|---|---|---|
パラメータ |
|
otThreadGetKeySequenceCounter
otThreadSetKeySwitchGuardTime
void otThreadSetKeySwitchGuardTime(
otInstance *aInstance,
uint32_t aKeySwitchGuardTime
)
thrKeySwitchGuardTime(時間単位)を設定します。
詳細 | |||||
---|---|---|---|---|---|
パラメータ |
|
otThreadGetKeySwitchGuardTime
otThreadSetLinkMode
otError otThreadSetLinkMode(
otInstance *aInstance,
otLinkModeConfig aConfig
)
MLE リンクモードの構成を設定します。
詳細 | |||||
---|---|---|---|---|---|
パラメータ |
|
||||
戻り値 |
|
otThreadGetLinkMode
otThreadSetMeshLocalPrefix
otError otThreadSetMeshLocalPrefix(
otInstance *aInstance,
const otMeshLocalPrefix *aMeshLocalPrefix
)
メッシュ ローカル プレフィックスを設定します。
Thread プロトコルが無効になっている場合にのみ成功します。この関数の呼び出しが成功すると、不揮発性メモリ内のアクティブなオペレーション データセットと保留中のオペレーション データセットが無効になります。
詳細 | |||||
---|---|---|---|---|---|
パラメータ |
|
||||
戻り値 |
|
otThreadSetNetworkKey
otError otThreadSetNetworkKey(
otInstance *aInstance,
const otNetworkKey *aKey
)
Thread ネットワーク キーを設定します。
Thread プロトコルが無効になっている場合にのみ成功します。この関数の呼び出しが成功すると、不揮発性メモリ内のアクティブなオペレーション データセットと保留中のオペレーション データセットが無効になります。
詳細 | |||||
---|---|---|---|---|---|
パラメータ |
|
||||
戻り値 |
|
otThreadGetNetworkKey
otThreadSetNetworkKeyRef
otError otThreadSetNetworkKeyRef(
otInstance *aInstance,
otNetworkKeyRef aKeyRef
)
Thread ネットワーク キーを otNetworkKeyRef
として設定します。
Thread プロトコルが無効になっている場合にのみ成功します。この関数の呼び出しが成功すると、不揮発性メモリ内のアクティブなオペレーション データセットと保留中のオペレーション データセットが無効になります。
ビルド時の機能 OPENTHREAD_CONFIG_PLATFORM_KEY_REFERENCES_ENABLE
を有効にする必要があります。
詳細 | |||||
---|---|---|---|---|---|
パラメータ |
|
||||
戻り値 |
|
otThreadGetNetworkKeyRef
otThreadSetNetworkName
otError otThreadSetNetworkName(
otInstance *aInstance,
const char *aNetworkName
)
Thread ネットワーク名を設定します。
Thread プロトコルが無効になっている場合にのみ成功します。この関数の呼び出しが成功すると、不揮発性メモリ内のアクティブなオペレーション データセットと保留中のオペレーション データセットが無効になります。
詳細 | |||||
---|---|---|---|---|---|
パラメータ |
|
||||
戻り値 |
|
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
)は含まれません。
詳細 | |||||
---|---|---|---|---|---|
パラメータ |
|
||||
戻り値 |
|
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
)は含まれません。
詳細 | |||||
---|---|---|---|---|---|
パラメータ |
|
||||
戻り値 |
|
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
)は含まれません。
詳細 | |||||
---|---|---|---|---|---|
パラメータ |
|
||||
戻り値 |
|
マクロ
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
サービスデータの最大サイズ(バイト単位)。
関連情報
OpenThread API リファレンスのトピックは、GitHub で入手できるソースコードに由来しています。 詳細について、またはドキュメントへの投稿については、リソースをご覧ください。