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

ジョイナー

このモジュールには、スレッドジョイナーロールの関数が含まれています。

概要

列挙

otJoinerState列挙型
この列挙は、ジョイナー状態を定義します。

Typedef

otJoinerCallback )(otError aError, void *aContext) typedef
void(*
この関数ポインタは、結合操作の完了を通知するために呼び出されます。
otJoinerDiscerner typedef
この構造は、JoinerDiscernerを表します。
otJoinerState typedef
この列挙は、ジョイナー状態を定義します。

関数

otJoinerGetDiscerner ( otInstance *aInstance)
このメソッドはJoinerDiscernerを取得します。
otJoinerGetId ( otInstance *aInstance)
const otExtAddress *
このメソッドはジョイナーIDを取得します。
otJoinerGetState ( otInstance *aInstance)
この関数は、ジョイナー状態を返します。
otJoinerSetDiscerner ( otInstance *aInstance, otJoinerDiscerner *aDiscerner)
このメソッドは、JoinerDiscernerを設定します。
otJoinerStart ( otInstance *aInstance, const char *aPskd, const char *aProvisioningUrl, const char *aVendorName, const char *aVendorModel, const char *aVendorSwVersion, const char *aVendorData, otJoinerCallback aCallback, void *aContext)
この関数は、スレッドジョイナーの役割を有効にします。
otJoinerStop ( otInstance *aInstance)
void
この関数は、スレッドジョイナーの役割を無効にします。

構造体

otJoinerDiscerner

この構造は、JoinerDiscernerを表します。

列挙

otJoinerState

 otJoinerState

この列挙は、ジョイナー状態を定義します。

Typedef

otJoinerCallback

void(* otJoinerCallback)(otError aError, void *aContext)

この関数ポインタは、結合操作の完了を通知するために呼び出されます。

詳細
パラメーター
[in] aError
結合プロセスが成功した場合はOT_ERROR_NONE。セキュリティクレデンシャルが原因で参加プロセスが失敗した場合のOT_ERROR_SECURITY。参加可能なネットワークが検出されなかった場合は、OT_ERROR_NOT_FOUND。応答がタイムアウトした場合はOT_ERROR_RESPONSE_TIMEOUT。
[in] aContext
アプリケーション固有のコンテキストへのポインタ。

otJoinerDiscerner

struct otJoinerDiscerner otJoinerDiscerner

この構造は、JoinerDiscernerを表します。

otJoinerState

enum otJoinerState otJoinerState

この列挙は、ジョイナー状態を定義します。

関数

otJoinerGetDiscerner

const otJoinerDiscerner * otJoinerGetDiscerner(
  otInstance *aInstance
)

このメソッドはJoinerDiscernerを取得します。

詳細
パラメーター
[in] aInstance
OpenThreadインスタンスへのポインタ。
戻り値
JoinerDiscernerへのポインタ。何も設定されていない場合はNULL。

otJoinerGetId

const otExtAddress * otJoinerGetId(
  otInstance *aInstance
)

このメソッドはジョイナーIDを取得します。

Joiner Discernerが設定されていない場合、Joiner IDは、工場で割り当てられたIEEEEUI-64上でSHA-256を計算した結果の最初の64ビットです。それ以外の場合、JoinerIDはJoinerDiscerner値から計算されます。

ジョイナIDは、コミッショニングプロセス中にデバイスのIEEE802.15.4拡張アドレスとしても使用されます。

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

otJoinerGetState

otJoinerState otJoinerGetState(
  otInstance *aInstance
)

この関数は、ジョイナー状態を返します。

詳細
パラメーター
[in] aInstance
OpenThreadインスタンスへのポインタ。
戻り値
OT_JOINER_STATE_IDLE
OT_JOINER_STATE_DISCOVER
OT_JOINER_STATE_CONNECT
OT_JOINER_STATE_CONNECTED
OT_JOINER_STATE_ENTRUST
OT_JOINER_STATE_JOINED

otJoinerSetDiscerner

otError otJoinerSetDiscerner(
  otInstance *aInstance,
  otJoinerDiscerner *aDiscerner
)

このメソッドは、JoinerDiscernerを設定します。

ジョイナーディスクナーは、コミッショニング/ジョインプロセス中に使用されるジョイナーIDを計算するために使用されます。

デフォルトでは(識別機能が提供されていないか、NULLに設定されている場合)、ジョイナーIDは、工場で割り当てられたIEEEEUI-64上でSHA-256を計算した結果の最初の64ビットとして取得されます。これがスレッド仕様で期待される主な動作であることに注意してください。

詳細
パラメーター
[in] aInstance
OpenThreadインスタンスへのポインタ。
[in] aDiscerner
JoinerDiscernerへのポインタ。 NULLの場合、以前に設定された識別機能がクリアされます。
戻り値
OT_ERROR_NONE
JoinerDiscernerが正常に更新されました。
OT_ERROR_INVALID_ARGS
aDiscernerが無効です(指定された長さが有効な範囲内にありません)。
OT_ERROR_INVALID_STATE
進行中の参加プロセスがあるため、JoinerDiscernerを変更できませんでした。

otJoinerStart

otError otJoinerStart(
  otInstance *aInstance,
  const char *aPskd,
  const char *aProvisioningUrl,
  const char *aVendorName,
  const char *aVendorModel,
  const char *aVendorSwVersion,
  const char *aVendorData,
  otJoinerCallback aCallback,
  void *aContext
)

この関数は、スレッドジョイナーの役割を有効にします。

詳細
パラメーター
[in] aInstance
OpenThreadインスタンスへのポインタ。
[in] aPskd
PSKdへのポインタ。
[in] aProvisioningUrl
プロビジョニングURLへのポインタ(NULLの場合があります)。
[in] aVendorName
ベンダー名へのポインター(NULLの場合があります)。
[in] aVendorModel
ベンダーモデルへのポインター(NULLの場合があります)。
[in] aVendorSwVersion
ベンダーSWバージョンへのポインター(NULLの場合があります)。
[in] aVendorData
ベンダーデータへのポインター(NULLの場合があります)。
[in] aCallback
結合操作の完了時に呼び出される関数へのポインター。
[in] aContext
アプリケーション固有のコンテキストへのポインタ。
戻り値
OT_ERROR_NONE
ジョイナーの役割を正常に開始しました。
OT_ERROR_BUSY
以前の試みはまだ進行中です。
OT_ERROR_INVALID_ARGS
aPskdまたはaProvisioningUrlが無効です。
OT_ERROR_INVALID_STATE
IPv6スタックが有効になっていないか、スレッドスタックが完全に有効になっています。

otJoinerStop

void otJoinerStop(
  otInstance *aInstance
)

この関数は、スレッドジョイナーの役割を無効にします。

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

マクロ

OT_JOINER_MAX_DISCERNER_LENGTH

 OT_JOINER_MAX_DISCERNER_LENGTH 64

ジョイナーディスクナーの最大長(ビット単位)。