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

nl ::織り方::プロファイル:: NetworkProvisioning :: NetworkInfo

#include <src/lib/profiles/network-provisioning/NetworkInfo.h>

介して通信ペイロードシリアライズおよびデシリアライズするためのユーティリティクラスNetworkProvisioningのプロファイルは:それが検出および構成ネットワークへの情報の関連をカプセル化します。

概要

このクラスは、ネットワークプロビジョニング情報の中間ストレージ(情報の最終ストアとネットワークペイロードの中間)に依存し、動的メモリ管理を使用して、結果のオブジェクトに柔軟なランタイムを提供します。そのため、このクラスは最も制約のある環境には適していませんが、より大規模なシステムで使用できます。

コンストラクタとデストラクタ

NetworkInfo ()
~NetworkInfo ()

パブリックタイプ

@210列挙型
@211列挙型

パブリック属性

Hidden
bool
ネットワークが隠されているかどうか。
NetworkId
int64_t
デバイスによってネットワークに割り当てられたネットワーク ID。指定されていない場合は -1。
NetworkType
ネットワークのタイプ。
ThreadChannel
uint8_t
スレッドネットワークが動作する現在のチャネル(現在は[11..26])、またはkThreadChannel_NotSpecified。
ThreadExtendedPANId
uint8_t *
スレッド拡張PANID。
ThreadNetworkKey
uint8_t *
スレッドマスターネットワークキー、または指定されていない場合はNULL。
ThreadNetworkName
char *
スレッドネットワークの名前。指定されていない場合はNULL。
ThreadPANId
uint32_t
16ビットのスレッドPANID、またはkThreadPANId_NotSpecified。
ThreadPSKc
uint8_t *
コミッショナーの事前共有キーをスレッド化します。指定されていない場合はNULLです。
WiFiKey
uint8_t *
WiFiキー、または指定されていない場合はNULL。
WiFiKeyLen
uint32_t
WiFiキーのバイト単位の長さ。
WiFiMode
WiFiネットワークの動作モード。
WiFiRole
WiFiネットワーク上のデバイスが果たす役割。
WiFiSSID
char *
WiFi SSID、または指定されていない場合はNULL。
WiFiSecurityType
WiFiセキュリティタイプ。
WirelessSignalStrength
int16_t
ネットワークの信号強度、または使用できない/適用できない場合はINT16_MIN。

公の行事

Clear (void)
void
この内のすべての値をデフォルトと解放するためにリセットNetworkInfoのオブジェクト。
CopyTo ( NetworkInfo & dest)
この内容に置き換えNetworkInfoの議論の内容の深いコピーを持つオブジェクト。
Decode (nl::Weave::TLV::TLVReader & reader)
このコンテンツのデシリアライズNetworkInfoのそのオブジェクトからTLVの表現を。
Encode (nl::Weave::TLV::TLVWriter & writer, uint8_t encodeFlags) const
このコンテンツのシリアル化NetworkInfoのそのにオブジェクトをTLVを表現。
MergeTo ( NetworkInfo & dest)
この内容マージNetworkInfoの議論の内容の深いコピーを持つオブジェクト。

パブリック静的関数

DecodeList (nl::Weave::TLV::TLVReader & reader, uint16_t & elemCount, NetworkInfo *& elemArray)
リストデシリアライズNetworkInfoのそのから要素TLVの表現を。
EncodeList (nl::Weave::TLV::TLVWriter & writer, uint16_t elemCount, const NetworkInfo *elemArray, uint8_t encodeFlags)
アレイシリアライズNetworkInfoは、その中にオブジェクトのTLV表現。
EncodeList (nl::Weave::TLV::TLVWriter & writer, uint16_t arrayLen, const NetworkInfo *elemArray, :: nl::Weave::Profiles::NetworkProvisioning::NetworkType networkType, uint8_t encodeFlags, uint16_t & encodedElemCount)
アレイシリアライズNetworkInfoは、その中にオブジェクトTLVの特定タイプのネットワークのみを選択する表現。

パブリックタイプ

@ 210

 @210

@ 211

 @211

パブリック属性

隠し

bool Hidden

ネットワークが隠されているかどうか。

NetworkId

int64_t NetworkId

デバイスによってネットワークに割り当てられたネットワークID。指定されていない場合は-1。

ネットワーク型

::nl::Weave::Profiles::NetworkProvisioning::NetworkType NetworkType

ネットワークのタイプ。

ThreadChannel

uint8_t ThreadChannel

スレッドネットワークが動作する現在のチャネル(現在は[11..26])、またはkThreadChannel_NotSpecified。

ThreadExtendedPANId

uint8_t * ThreadExtendedPANId

スレッド拡張PANID。

これは、クラスによって所有される、動的に割り当てられた 8 オクテックの配列です。呼び出す任意の条件で破壊されたClear()対象に。

ThreadNetworkKey

uint8_t * ThreadNetworkKey

スレッドマスターネットワークキー、または指定されていない場合はNULL。

これは、呼び出し任意の状態に破壊されたクラスが所有する任意のオクテットの動的に割り当てられた配列であり、 Clear()対象に。

ThreadNetworkName

char * ThreadNetworkName

スレッドネットワークの名前。指定されていない場合はNULL。

これは、クラスが所有する、NULで終了し、動的に割り当てられたC文字列です。呼び出す任意の条件で破壊されたClear()対象に。

ThreadPANId

uint32_t ThreadPANId

16ビットのスレッドPANID、またはkThreadPANId_NotSpecified。

ThreadPSKc

uint8_t * ThreadPSKc

コミッショナーの事前共有キーをスレッド化します。指定されていない場合はNULLです。

これは、呼び出し任意の状態に破壊されたクラスが所有する任意のオクテットの動的に割り当てられた配列であり、 Clear()対象に。

WiFiKey

uint8_t * WiFiKey

WiFi キー、または指定されていない場合は NULL。

それによって指定された長さを持つクラスが所有する任意のオクテットの動的に割り当てられた配列であるWiFiKeyLen 。呼び出す任意の条件で破壊されたClear()対象に。

WiFiKeyLen

uint32_t WiFiKeyLen

WiFi キーの長さ (バイト単位)。

WiFiモード

::nl::Weave::Profiles::NetworkProvisioning::WiFiMode WiFiMode

WiFiネットワークの動作モード。

WiFiロール

::nl::Weave::Profiles::NetworkProvisioning::WiFiRole WiFiRole

WiFi ネットワーク上でデバイスが果たす役割。

WiFiSSID

char * WiFiSSID

WiFi SSID、または指定されていない場合はNULL。

これは、クラスが所有する、NULで終了し、動的に割り当てられたC文字列です。呼び出す任意の条件で破壊されたClear()対象に。

WiFiSecurityType

::nl::Weave::Profiles::NetworkProvisioning::WiFiSecurityType WiFiSecurityType

WiFiセキュリティタイプ。

WirelessSignalStrength

int16_t WirelessSignalStrength

ネットワークの信号強度、または使用できない/適用できない場合はINT16_MIN。

公の行事

晴れ

void Clear(
  void
)

この内のすべての値をデフォルトと解放するためにリセットNetworkInfoのオブジェクト。

CopyTo

WEAVE_ERROR CopyTo(
  NetworkInfo & dest
)

この内容に置き換えNetworkInfoの議論の内容の深いコピーを持つオブジェクト。

詳細
パラメーター
[in] dest
NetworkInfoの情報を含むオブジェクトは、このオブジェクトにコピーします。
戻り値
WEAVE_NO_ERROR
成功したとき。
WEAVE_ERROR_NOT_IMPLEMENTED
プラットフォームがmallocまたはfreeをサポートしていない場合。
WEAVE_ERROR_NO_MEMORY
メモリ割り当ての失敗について。

デコード

WEAVE_ERROR Decode(
  nl::Weave::TLV::TLVReader & reader
)

このコンテンツのデシリアライズNetworkInfoのそのオブジェクトからTLVの表現を。

詳細
パラメーター
[in] reader
ネットワーク情報を含む構造要素に配置されたTLVReader。
戻り値
WEAVE_NO_ERROR成功した場合、プロファイルをプロビジョニングネットワークに準拠していない任意の要素にWEAVE_ERROR_INVALID_TLV_ELEMENT、の任意のTLV要素の誤った解読にリーダエラー。

エンコード

WEAVE_ERROR Encode(
  nl::Weave::TLV::TLVWriter & writer,
  uint8_t encodeFlags
) const 

このコンテンツのシリアル化NetworkInfoのそのにオブジェクトをTLVを表現。

詳細
パラメーター
[in] writer
オブジェクトがシリアル化される場所に配置されたTLVWriter。この関数は、このオブジェクトが要素の配列の一部である場合はこのオブジェクトの匿名タグを発行し、スタンドアロン要素として発行される場合はkTag_NetworkInformationのプロファイルタグを発行します。
[in] encodeFlags
資格情報かどうかを制御するフラグNetworkInfoをシリアル化する必要があります。
戻り値
WEAVE_NO_ERROR成功した場合、プロファイルをプロビジョニングネットワークに準拠していない任意の要素にWEAVE_ERROR_INVALID_TLV_ELEMENT、の任意のTLV要素の誤った解読にリーダエラー。

MergeTo

WEAVE_ERROR MergeTo(
  NetworkInfo & dest
)

この内容マージNetworkInfoの議論の内容の深いコピーを持つオブジェクト。

引数オブジェクトのデフォルト以外の値はすべて、このオブジェクトの値を置き換えます。

詳細
パラメーター
[in] dest
NetworkInfoの情報を含むオブジェクトは、このオブジェクトにコピーします。
戻り値
WEAVE_NO_ERROR
成功したとき。
WEAVE_ERROR_NOT_IMPLEMENTED
プラットフォームがmallocまたはfreeをサポートしていない場合。
WEAVE_ERROR_NO_MEMORY
メモリ割り当ての失敗について。

NetworkInfo

 NetworkInfo()

〜NetworkInfo

 ~NetworkInfo()

パブリック静的関数

DecodeList

WEAVE_ERROR DecodeList(
  nl::Weave::TLV::TLVReader & reader,
  uint16_t & elemCount,
  NetworkInfo *& elemArray
)

リストデシリアライズNetworkInfoのそのから要素TLVの表現を。

詳細
パラメーター
[in] reader
アレイの開始位置に配置されたTLVReader。正常に戻ると、ライターは配列の終わりの後に配置されます。
[in,out] elemCount
入力時に、TLVReaderから逆シリアル化する要素の最大数。出力時に、ストリームから実際に逆シリアル化された要素の数。
[in,out] elemArray
配列への参照NetworkInfoのデシリアライズ含むであろう要素NetworkInfoのオブジェクトを。配列がNULLの場合、以下の関数によって内部的に割り当てられます。それ以外の場合、外部に割り当てられた配列には少なくともelemCountオブジェクトが含まれていると見なされます。
戻り値
WEAVE_NO_ERROR
成功したとき。
WEAVE_ERROR_NOT_IMPLEMENTED
動的メモリ管理をサポートしていないプラットフォーム。
other
エラーが返されたからDecode()関数。

EncodeList

WEAVE_ERROR EncodeList(
  nl::Weave::TLV::TLVWriter & writer,
  uint16_t elemCount,
  const NetworkInfo *elemArray,
  uint8_t encodeFlags
)

アレイシリアライズNetworkInfoは、その中にオブジェクトのTLV表現。

配列は、匿名の要素になりますTLVを表現。

詳細
パラメーター
[in] writer
適切に配置されたTLVWriter
[in] elemCount
内の要素の数elemArray
[in] elemArray
アレイNetworkInfoをシリアル化するオブジェクト。
[in] encodeFlags
資格情報かどうかを制御するフラグNetworkInfoをシリアル化する必要があります。
戻り値
WEAVE_NO_ERROR
成功したとき。
Other
エラーが返されたからEncode()関数。

EncodeList

WEAVE_ERROR EncodeList(
  nl::Weave::TLV::TLVWriter & writer,
  uint16_t arrayLen,
  const NetworkInfo *elemArray,
  ::nl::Weave::Profiles::NetworkProvisioning::NetworkType networkType,
  uint8_t encodeFlags,
  uint16_t & encodedElemCount
)

アレイシリアライズNetworkInfoは、その中にオブジェクトTLVの特定タイプのネットワークのみを選択する表現。

詳細
パラメーター
[in] writer
適切に配置されたTLVWriter
[in] arrayLen
内の要素の数elemArray
[in] elemArray
アレイNetworkInfoをシリアル化するオブジェクト。
[in] networkType
種類NetworkInfoはシリアライズするオブジェクト
[in] encodeFlags
資格情報かどうかを制御するフラグNetworkInfoをシリアル化する必要があります。
[out] encodedElemCount
実際にシリアル化された要素の数。
戻り値
WEAVE_NO_ERROR
成功したとき。
Other
エラーが返されたからEncode()関数。