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

実例

このモジュールには、OpenThreadインスタンスを制御する関数が含まれています。

概要

列挙

anonymous enum {
OT_CHANGED_IP6_ADDRESS_ADDED = 1 << 0,
OT_CHANGED_IP6_ADDRESS_REMOVED = 1 << 1,
OT_CHANGED_THREAD_ROLE = 1 << 2,
OT_CHANGED_THREAD_LL_ADDR = 1 << 3,
OT_CHANGED_THREAD_ML_ADDR = 1 << 4,
OT_CHANGED_THREAD_RLOC_ADDED = 1 << 5,
OT_CHANGED_THREAD_RLOC_REMOVED = 1 << 6,
OT_CHANGED_THREAD_PARTITION_ID = 1 << 7,
OT_CHANGED_THREAD_KEY_SEQUENCE_COUNTER = 1 << 8,
OT_CHANGED_THREAD_NETDATA = 1 << 9,
OT_CHANGED_THREAD_CHILD_ADDED = 1 << 10,
OT_CHANGED_THREAD_CHILD_REMOVED = 1 << 11,
OT_CHANGED_IP6_MULTICAST_SUBSCRIBED = 1 << 12,
OT_CHANGED_IP6_MULTICAST_UNSUBSCRIBED = 1 << 13,
OT_CHANGED_THREAD_CHANNEL = 1 << 14,
OT_CHANGED_THREAD_PANID = 1 << 15,
OT_CHANGED_THREAD_NETWORK_NAME = 1 << 16,
OT_CHANGED_THREAD_EXT_PANID = 1 << 17,
OT_CHANGED_NETWORK_KEY = 1 << 18,
OT_CHANGED_PSKC = 1 << 19,
OT_CHANGED_SECURITY_POLICY = 1 << 20,
OT_CHANGED_CHANNEL_MANAGER_NEW_CHANNEL = 1 << 21,
OT_CHANGED_SUPPORTED_CHANNEL_MASK = 1 << 22,
OT_CHANGED_COMMISSIONER_STATE = 1 << 23,
OT_CHANGED_THREAD_NETIF_STATE = 1 << 24,
OT_CHANGED_THREAD_BACKBONE_ROUTER_STATE = 1 << 25,
OT_CHANGED_THREAD_BACKBONE_ROUTER_LOCAL = 1 << 26,
OT_CHANGED_JOINER_STATE = 1 << 27,
OT_CHANGED_ACTIVE_DATASET = 1 << 28,
OT_CHANGED_PENDING_DATASET = 1 << 29
}
列挙型
この列挙体は、の一部として渡されたフラグを定義otStateChangedCallback

Typedef

otChangedFlags typedef
uint32_t
このタイプは、変更された特定の状態/構成を示すビットフィールドを表します。
otInstance typedef
struct otInstance
この構造は、OpenThreadインスタンス構造を表します。
otStateChangedCallback )(otChangedFlags aFlags, void *aContext) typedef
void(*
この関数ポインタは、OpenThread内の特定の構成または状態の変更を通知するために呼び出されます。

関数

otGetRadioVersionString ( otInstance *aInstance)
const char *
この関数は、OpenThread無線バージョン文字列を取得します。
otGetVersionString (void)
const char *
この関数は、OpenThreadバージョン文字列を取得します。
otInstanceErasePersistentInfo ( otInstance *aInstance)
この関数は、不揮発性メモリに保存されているすべてのOpenThread永続情報(ネットワーク設定)を消去します。
otInstanceFactoryReset ( otInstance *aInstance)
void
このメソッドは、不揮発性メモリに保存されているすべての設定を削除してから、プラットフォームのリセットをトリガーします。
otInstanceFinalize ( otInstance *aInstance)
void
この関数は、OpenThreadライブラリを無効にします。
otInstanceGetUptime ( otInstance *aInstance)
uint64_t
この関数は、現在のインスタンスの稼働時間(ミリ秒単位)を返します。
otInstanceGetUptimeAsString ( otInstance *aInstance, char *aBuffer, uint16_t aSize)
void
この関数は、現在のインスタンスの稼働時間を人間が読める文字列として返します。
otInstanceInit (void *aInstanceBuffer, size_t *aInstanceBufferSize)
この関数は、OpenThreadライブラリを初期化します。
otInstanceInitSingle (void)
この関数は、OpenThreadライブラリの静的な単一インスタンスを初期化します。
otInstanceIsInitialized ( otInstance *aInstance)
bool
この関数は、インスタンスが有効/初期化されているかどうかを示します。
otInstanceReset ( otInstance *aInstance)
void
このメソッドは、プラットフォームのリセットをトリガーします。
otInstanceResetRadioStack ( otInstance *aInstance)
void
このメソッドは、OpenThread無線スタックの内部状態をリセットします。
otRemoveStateChangeCallback ( otInstance *aInstance, otStateChangedCallback aCallback, void *aContext)
void
この関数は、OpenThread内で特定の構成または状態がいつ変更されるかを示すコールバックを削除します。
otSetStateChangedCallback ( otInstance *aInstance, otStateChangedCallback aCallback, void *aContext)
この関数は、OpenThread内で特定の構成または状態がいつ変更されるかを示すコールバックを登録します。

列挙

匿名列挙型

 anonymous enum

この列挙体は、の一部として渡されたフラグを定義otStateChangedCallback

プロパティ
OT_CHANGED_ACTIVE_DATASET

アクティブな運用データセットが変更されました。

OT_CHANGED_CHANNEL_MANAGER_NEW_CHANNEL

ChannelManagerの新しい保留中のスレッドチャネルが変更されました。

OT_CHANGED_COMMISSIONER_STATE

コミッショナーの状態が変更されました。

OT_CHANGED_IP6_ADDRESS_ADDED

IPv6アドレスが追加されました。

OT_CHANGED_IP6_ADDRESS_REMOVED

IPv6アドレスが削除されました。

OT_CHANGED_IP6_MULTICAST_SUBSCRIBED

IPv6マルチキャストアドレスにサブスクライブしました。

OT_CHANGED_IP6_MULTICAST_UNSUBSCRIBED

IPv6マルチキャストアドレスからサブスクライブ解除されました。

OT_CHANGED_JOINER_STATE

ジョイナーの状態が変更されました。

OT_CHANGED_NETWORK_KEY

ネットワークキーが変更されました。

OT_CHANGED_PENDING_DATASET

保留中の運用データセットが変更されました。

OT_CHANGED_PSKC

PSKcが変更されました。

OT_CHANGED_SECURITY_POLICY

セキュリティポリシーが変更されました。

OT_CHANGED_SUPPORTED_CHANNEL_MASK

サポートされているチャネルマスクが変更されました。

OT_CHANGED_THREAD_BACKBONE_ROUTER_LOCAL

ローカルバックボーンルーターの構成が変更されました。

OT_CHANGED_THREAD_BACKBONE_ROUTER_STATE

バックボーンルーターの状態が変更されました。

OT_CHANGED_THREAD_CHANNEL

スレッドネットワークチャネルが変更されました。

OT_CHANGED_THREAD_CHILD_ADDED

子供が追加されました。

OT_CHANGED_THREAD_CHILD_REMOVED

子供が削除されました。

OT_CHANGED_THREAD_EXT_PANID

スレッドネットワークの拡張PANIDが変更されました。

OT_CHANGED_THREAD_KEY_SEQUENCE_COUNTER

スレッドキーシーケンスが変更されました。

OT_CHANGED_THREAD_LL_ADDR

リンクローカルアドレスが変更されました。

OT_CHANGED_THREAD_ML_ADDR

メッシュローカルアドレスが変更されました。

OT_CHANGED_THREAD_NETDATA

スレッドネットワークデータが変更されました。

OT_CHANGED_THREAD_NETIF_STATE

スレッドネットワークインターフェイスの状態が変更されました。

OT_CHANGED_THREAD_NETWORK_NAME

スレッドネットワーク名が変更されました。

OT_CHANGED_THREAD_PANID

スレッドネットワークのPANIDが変更されました。

OT_CHANGED_THREAD_PARTITION_ID

パーティションIDが変更されました。

OT_CHANGED_THREAD_RLOC_ADDED

RLOCが追加されました。

OT_CHANGED_THREAD_RLOC_REMOVED

RLOCは削除されました。

OT_CHANGED_THREAD_ROLE

役割(無効、デタッチ、子、ルーター、リーダー)が変更されました。

Typedef

otChangedFlags

uint32_t otChangedFlags

このタイプは、変更された特定の状態/構成を示すビットフィールドを表します。

参照してくださいOT_CHANGED_*定義を。

otInstance

struct otInstance otInstance

この構造は、OpenThreadインスタンス構造を表します。

otStateChangedCallback

void(* otStateChangedCallback)(otChangedFlags aFlags, void *aContext)

この関数ポインタは、OpenThread内の特定の構成または状態の変更を通知するために呼び出されます。

詳細
パラメーター
[in] aFlags
変更された特定の状態を示すビットフィールド。参照してくださいOT_CHANGED_*定義を。
[in] aContext
アプリケーション固有のコンテキストへのポインタ。

関数

otGetRadioVersionString

const char * otGetRadioVersionString(
  otInstance *aInstance
)

この関数は、OpenThread無線バージョン文字列を取得します。

詳細
パラメーター
[in] aInstance
OpenThreadインスタンスへのポインタ。
戻り値
OpenThread無線バージョンへのポインタ。

otGetVersionString

const char * otGetVersionString(
  void
)

この関数は、OpenThreadバージョン文字列を取得します。

詳細
戻り値
OpenThreadバージョンへのポインタ。

otInstanceErasePersistentInfo

otError otInstanceErasePersistentInfo(
  otInstance *aInstance
)

この関数は、不揮発性メモリに保存されているすべてのOpenThread永続情報(ネットワーク設定)を消去します。

消去は、デバイスがにある場合にのみ成功するとdisabled状態/役割。

詳細
パラメーター
[in] aInstance
OpenThreadインスタンスへのポインタ。
戻り値
OT_ERROR_NONE
すべての永続的な情報/状態が正常に消去されました。
OT_ERROR_INVALID_STATE
デバイスはしていないdisabled状態/役割。

otInstanceFactoryReset

void otInstanceFactoryReset(
  otInstance *aInstance
)

このメソッドは、不揮発性メモリに保存されているすべての設定を削除してから、プラットフォームのリセットをトリガーします。

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

otInstanceFinalize

void otInstanceFinalize(
  otInstance *aInstance
)

この関数は、OpenThreadライブラリを無効にします。

OpenThreadが使用されなくなったら、この関数を呼び出します。

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

otInstanceGetUptime

uint64_t otInstanceGetUptime(
  otInstance *aInstance
)

この関数は、現在のインスタンスの稼働時間(ミリ秒単位)を返します。

この関数は、必要とOPENTHREAD_CONFIG_UPTIME_ENABLE有効にします。

稼働時間は、OpenThreadインスタンスが初期化されてからのミリ秒数として示されます。

詳細
パラメーター
[in] aInstance
OpenThreadインスタンスへのポインタ。
戻り値
稼働時間(ミリ秒数)。

otInstanceGetUptimeAsString

void otInstanceGetUptimeAsString(
  otInstance *aInstance,
  char *aBuffer,
  uint16_t aSize
)

この関数は、現在のインスタンスの稼働時間を人間が読める文字列として返します。

この関数は、必要とOPENTHREAD_CONFIG_UPTIME_ENABLE有効にします。

文字列は「」の形式に従います。 「時間、分、秒、ミリ秒(稼働時間が1日より短い場合)または」

NS。 "(1日より長い場合)。

結果の文字列が中に入らない場合aBuffer (その内aSize文字)、文字列が切り捨てられますが、出力された文字列は常にヌルで終了です。

詳細
パラメーター
[in] aInstance
OpenThreadインスタンスへのポインタ。
[out] aBuffer
文字列を出力するためのchar配列へのポインタ。
[in] aSize
サイズaBuffer (バイト単位)。使用することをお勧めOT_UPTIME_STRING_SIZE

otInstanceInit

otInstance * otInstanceInit(
  void *aInstanceBuffer,
  size_t *aInstanceBufferSize
)

この関数は、OpenThreadライブラリを初期化します。

この関数は、OpenThreadを初期化し、後続のOpenThreadAPI呼び出しに備えます。この関数は、OpenThreadを他に呼び出す前に呼び出す必要があります。

この機能は使用可能であり、複数のOpenThreadインスタンスのサポートが有効になっている場合にのみ使用できます。

詳細
パラメーター
[in] aInstanceBuffer
otInstance構造体の割り当てに使用するOpenThreadのバッファー。
[in,out] aInstanceBufferSize
入力時、aInstanceBufferのサイズ。出力時に、otInstanceに十分なスペースがない場合、otInstanceに必要なバイト数。
戻り値
新しいOpenThreadインスタンスへのポインタ。
参照:
otInstanceFinalize

otInstanceInitSingle

otInstance * otInstanceInitSingle(
  void
)

この関数は、OpenThreadライブラリの静的な単一インスタンスを初期化します。

この関数は、OpenThreadを初期化し、後続のOpenThreadAPI呼び出しのために準備します。この関数は、OpenThreadを他に呼び出す前に呼び出す必要があります。

この関数は使用可能であり、複数のOpenThreadインスタンスのサポートが無効になっている場合にのみ使用できます。

詳細
戻り値
単一のOpenThreadインスタンスへのポインタ。

otInstanceIsInitialized

bool otInstanceIsInitialized(
  otInstance *aInstance
)

この関数は、インスタンスが有効/初期化されているかどうかを示します。

それはいずれかを使用して取得され、初期化されている場合インスタンスが有効であると考えられるotInstanceInitSingle()単一インスタンスの場合)又はotInstanceInit() (マルチインスタンス場合)。以降の呼び出しotInstanceFinalize()初期化されていないと考えられるべきインスタンスを引き起こします。

詳細
パラメーター
[in] aInstance
OpenThreadインスタンスへのポインタ。
戻り値
指定されたインスタンスが有効/初期化されている場合はTRUE、それ以外の場合はFALSE。

otInstanceReset

void otInstanceReset(
  otInstance *aInstance
)

このメソッドは、プラットフォームのリセットをトリガーします。

リセットプロセスにより、すべてのOpenThread状態/情報(揮発性メモリに保存されている)が確実に消去されます。注意otPlatformReset不揮発性メモリに保存された任意の永続的な状態/情報を消去されません。

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

otInstanceResetRadioStack

void otInstanceResetRadioStack(
  otInstance *aInstance
)

このメソッドは、OpenThread無線スタックの内部状態をリセットします。

コールバックと構成は保持されます。

このAPIは、ラジオの下でのみ使用可能です(ビルドをOPENTHREAD_RADIO = 1 )。

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

otRemoveStateChangeCallback

void otRemoveStateChangeCallback(
  otInstance *aInstance,
  otStateChangedCallback aCallback,
  void *aContext
)

この関数は、OpenThread内で特定の構成または状態がいつ変更されるかを示すコールバックを削除します。

詳細
パラメーター
[in] aInstance
OpenThreadインスタンスへのポインタ。
[in] aCallback
特定の構成または状態の変更で呼び出される関数へのポインター。
[in] aContext
アプリケーション固有のコンテキストへのポインタ。

otSetStateChangedCallback

otError otSetStateChangedCallback(
  otInstance *aInstance,
  otStateChangedCallback aCallback,
  void *aContext
)

この関数は、OpenThread内で特定の構成または状態がいつ変更されるかを示すコールバックを登録します。

詳細
パラメーター
[in] aInstance
OpenThreadインスタンスへのポインタ。
[in] aCallback
特定の構成または状態の変更で呼び出される関数へのポインター。
[in] aContext
アプリケーション固有のコンテキストへのポインタ。
戻り値
OT_ERROR_NONE
コールバックのリストにコールバックを追加しました。
OT_ERROR_ALREADY
コールバックはすでに登録されています。
OT_ERROR_NO_BUFS
リソースの制約により、コールバックを追加できませんでした。

マクロ

OT_UPTIME_STRING_SIZE

 OT_UPTIME_STRING_SIZE 24

稼働時間の文字列表現に推奨されるサイズ。