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

このページは Cloud Translation API によって翻訳されました。

nl::Weave::TLV

Weave TLV 形式でエンコードされたデータを操作するための定義

概要

Weave の TLV は、単純な構造化データ用の一般化されたエンコード方式です。一般的に使用されている JSON シリアル化形式と多くのプロパティが共通していますが、転送速度はかなりコンパクトです。

列挙型
`@71`	enum
`@73`	enum
`@74{ AnonymousTag = kSpecialTagMarker \| 0x00000000FFFFFFFFULL }`	enum
`@75`	enum
`TLVCommonProfiles{ kProfileIdNotSpecified = 0xFFFFFFFF }`	enum
`TLVElementType`	enum
`TLVFieldSize`	enum
`TLVTagControl`	enum
`TLVTagFields`	enum
`TLVType`	enum TLV 要素の型を識別する列挙型。

変数
`kWeaveTLVCopyChunkSize = 16`	`const size_t` リーダーオブジェクトからライターに TLV 要素をコピーします。
`sTagSizes = { 0, 1, 2, 4, 2, 4, 6, 8 }[]`	`const uint8_t`

関数
`CommonTag(uint32_t tagNum)`	`uint64_t` 共通のプロファイル TLV タグの API 表現を生成します。
`ContextTag(uint8_t tagNum)`	`uint64_t` コンテキスト固有の TLV タグの API 表現を生成します。
`GetTLVFieldSize(uint8_t type)`	`TLVFieldSize`
`IsContextTag(uint64_t tag)`	`bool` 指定されたタグがコンテキスト固有のタグの場合、true を返します。
`IsProfileTag(uint64_t tag)`	`bool` 指定されたタグがプロファイル固有のタグである場合は true を返します。
`IsSpecialTag(uint64_t tag)`	`bool`
`IsValidTLVType(uint8_t type)`	`bool` 指定された TLV 型が有効な場合、true を返します。
`ProfileIdFromTag(uint64_t tag)`	`uint32_t` TLV タグからプロファイル ID を返します。
`ProfileNumFromTag(uint64_t tag)`	`uint16_t` TLV タグからプロファイル番号を返します。
`ProfileTag(uint32_t profileId, uint32_t tagNum)`	`uint64_t` プロファイル ID とタグ番号から、プロファイル固有の TLV タグの API 表現を生成します。
`ProfileTag(uint16_t vendorId, uint16_t profileNum, uint32_t tagNum)`	`uint64_t` ベンダー ID、プロファイル番号、タグ番号から、プロファイル固有の TLV タグの API 表現を生成します。
`TLVFieldSizeToBytes(TLVFieldSize fieldSize)`	`uint8_t`
`TLVTypeHasLength(uint8_t type)`	`bool` 指定された TLV 型が関連する長さフィールドの存在を暗黙的に示唆している場合、true を返します。
`TLVTypeHasValue(uint8_t type)`	`bool` 指定された TLV 型が関連する値フィールドが存在することを示唆している場合、true を返します。
`TLVTypeIsContainer(uint8_t type)`	`bool` 指定された TLV 型がコンテナの場合、true を返します。
`TLVTypeIsString(uint8_t type)`	`bool` 指定された TLV 型が UTF8 またはバイト文字列の場合、true を返します。
`TagNumFromTag(uint64_t tag)`	`uint32_t` TLV タグからタグ番号を返します。
`VendorIdFromTag(uint64_t tag)`	`uint16_t` TLV タグからベンダー ID を返します。

クラス
nl::Weave::TLV::CircularTLVReader
nl::Weave::TLV::CircularTLVWriter
nl::Weave::TLV::TLVReader	Weave TLV 形式でエンコードされたデータ用のメモリ効率の高いパーサーを提供します。
nl::Weave::TLV::TLVUpdater	TLV エンコードの要素を編集、追加、削除するための統合されたリーダー / ライターインターフェースを提供します。
nl::Weave::TLV::TLVWriter	Weave TLV 形式でデータを書き込むためのメモリ効率の高いエンコーダを提供します。
nl::Weave::TLV::WeaveCircularTLVBuffer	WeaveCircularTLVBuffer は、nl::Weave::TLV::TLVWriter と nl::Weave::TLVTLVReader に循環型ストレージを提供します。

名前空間
nl::Weave::TLV::Debug	この名前空間には、Weave TLV のデバッグとロギングのためのタイプとインターフェースが含まれています。
nl::Weave::TLV::Utilities	この名前空間には、Weave TLV の管理と操作のためのタイプとユーティリティインターフェースが含まれています。

列挙型

@71

@71

@73

@73

@74

@74

プロパティ

プロパティ
`AnonymousTag`	タグのない TLV 要素を示す値（例: 匿名要素です）。

AnonymousTag

タグのない TLV 要素を示す値（例:

匿名要素です）。

@75

@75

TLVCommonProfiles

 TLVCommonProfiles

プロパティ

プロパティ
`kProfileIdNotSpecified`	変数またはメンバーにプロファイル ID が存在しないことを示すために使用されます。これは基本的に、WeaveProfiles.h で定義されている kWeaveProfile_NotSpecified と同じです

kProfileIdNotSpecified

変数またはメンバーにプロファイル ID が存在しないことを示すために使用されます。

これは基本的に、WeaveProfiles.h で定義されている kWeaveProfile_NotSpecified と同じです

TLVElementType

 TLVElementType

TLVFieldSize

 TLVFieldSize

TLVTagControl

 TLVTagControl

TLVTagFields

 TLVTagFields

TLVType

 TLVType

TLV 要素の型を識別する列挙型。

変数

kWeaveTLVCopyChunkSize

const size_t kWeaveTLVCopyChunkSize = 16

リーダーオブジェクトからライターに TLV 要素をコピーします。

CopyElement() メソッドは、型と値が TLVReader オブジェクトから取得された新しい TLV 要素をエンコードします。このメソッドが呼び出されると、指定されたリーダーオブジェクトがソースの TLV 要素上に配置されることが期待されます。新たにエンコードされた要素の型と内容は入力コンテナと同じになりますが、タグは指定された引数に設定されます。指定された要素が TLV コンテナ（構造、配列、パス）の場合、コンテナのコンテンツ全体がコピーされます。

詳細

パラメータ

`[in] tag`	コンテナでエンコードする TLV タグ。コンテナをタグなしでエンコードする必要がある場合は `AnonymousTag`。タグ値は、タグ定義関数の ProfileTag()、ContextTag()、CommonTag() のいずれかを使用して作成する必要があります。
`[in] reader`	型と値をコピーする必要がある、事前にエンコードされた TLV 要素を識別する TLVReader オブジェクトへの参照。

戻り値

`WEAVE_NO_ERROR`	メソッドが成功した場合。
`WEAVE_ERROR_INCORRECT_STATE`	指定されたリーダーが要素上に配置されていない場合。
`WEAVE_ERROR_TLV_CONTAINER_OPEN`	コンテナライターが現在の書き込みで開かれていて、まだ閉じていない場合。
`WEAVE_ERROR_TLV_UNDERRUN`	提供されたリーダーに関連付けられている基となる TLV エンコードが途中で終了した場合。
`WEAVE_ERROR_INVALID_TLV_ELEMENT`	指定されたリーダーで、無効またはサポートされていない TLV 要素タイプが検出された場合。
`WEAVE_ERROR_INVALID_TLV_TAG`	指定されたリーダーが無効なコンテキストで TLV タグを検出した場合、または指定されたタグが無効であるか、新しいコンテナが書き込まれているコンテキストで不適切である場合。
`WEAVE_ERROR_BUFFER_TOO_SMALL`	値の書き込みが、書き込みの初期化時に指定された最大バイト数の上限を超える場合。
`WEAVE_ERROR_NO_MEMORY`	メモリ不足が原因で出力バッファの割り当てに失敗した場合。
`other`	構成された GetNewBuffer() 関数または FinalizeBuffer() 関数、またはリーダーオブジェクトに関連付けられた GetNextBuffer() 関数から返される、その他の Weave またはプラットフォーム固有のエラー。

sTagSizes

const uint8_t sTagSizes[] = { 0, 1, 2, 4, 2, 4, 6, 8 }

関数

CommonTag

uint64_t CommonTag(
  uint32_t tagNum
)

共通のプロファイル TLV タグの API 表現を生成します。

詳細

パラメータ

[in] tagNum

タグに割り当てられている共通のプロファイルタグ番号。

戻り値

タグを表す 64 ビットの整数。

ContextTag

uint64_t ContextTag(
  uint8_t tagNum
)

コンテキスト固有の TLV タグの API 表現を生成します。

詳細

パラメータ

[in] tagNum

タグに割り当てられたコンテキスト固有のタグ番号。

戻り値

タグを表す 64 ビットの整数。

GetTLVFieldSize

TLVFieldSize GetTLVFieldSize(
  uint8_t type
)

IsContextTag

bool IsContextTag(
  uint64_t tag
)

指定されたタグがコンテキスト固有のタグの場合、true を返します。

IsProfileTag

bool IsProfileTag(
  uint64_t tag
)

指定されたタグがプロファイル固有のタグである場合は true を返します。

IsSpecialTag

bool IsSpecialTag(
  uint64_t tag
)

IsValidTLVType

bool IsValidTLVType(
  uint8_t type
)

指定された TLV 型が有効な場合、true を返します。

詳細
戻り値	指定された TLV タイプが有効な場合は `true`。それ以外の場合は `false` になります。

ProfileIdFromTag

uint32_t ProfileIdFromTag(
  uint64_t tag
)

TLV タグからプロファイル ID を返します。

詳細

パラメータ

[in] tag

プロファイル固有の TLV タグの API 表現。

戻り値

プロファイル ID。

ProfileNumFromTag

uint16_t ProfileNumFromTag(
  uint64_t tag
)

TLV タグからプロファイル番号を返します。

詳細

パラメータ

[in] tag

プロファイル固有の TLV タグの API 表現。

戻り値

関連付けられているプロファイル番号。

ProfileTag

uint64_t ProfileTag(
  uint32_t profileId,
  uint32_t tagNum
)

プロファイル ID とタグ番号から、プロファイル固有の TLV タグの API 表現を生成します。

詳細

パラメータ

`[in] profileId`	タグが定義されているプロファイルの ID。
`[in] tagNum`	タグに割り当てられているプロファイル固有のタグ番号。

戻り値

タグを表す 64 ビットの整数。

ProfileTag

uint64_t ProfileTag(
  uint16_t vendorId,
  uint16_t profileNum,
  uint32_t tagNum
)

ベンダー ID、プロファイル番号、タグ番号から、プロファイル固有の TLV タグの API 表現を生成します。

詳細

パラメータ

`[in] vendorId`	タグを定義したベンダーの ID。
`[in] profileNum`	タグが定義されているプロファイルのベンダー割り当て番号。
`[in] tagNum`	タグに割り当てられているプロファイル固有のタグ番号。

戻り値

タグを表す 64 ビットの整数。

TLVFieldSizeToBytes

uint8_t TLVFieldSizeToBytes(
  TLVFieldSize fieldSize
)

TLVTypeHasLength

bool TLVTypeHasLength(
  uint8_t type
)

指定された TLV 型が関連する長さフィールドの存在を暗黙的に示唆している場合、true を返します。

詳細
戻り値	指定された TLV 型が関連する長さフィールドの存在を示唆する場合は `true`。それ以外の場合は `false` になります。

TLVTypeHasValue

bool TLVTypeHasValue(
  uint8_t type
)

指定された TLV 型が関連する値フィールドが存在することを示唆している場合、true を返します。

詳細
戻り値	指定された TLV 型が関連する値フィールドが存在することを示唆する場合は `true`。それ以外の場合は `false` になります。

TLVTypeIsContainer

bool TLVTypeIsContainer(
  uint8_t type
)

指定された TLV 型がコンテナの場合、true を返します。

詳細
戻り値	指定された TLV タイプがコンテナの場合は `true`。それ以外の場合は `false` になります。

TLVTypeIsString

bool TLVTypeIsString(
  uint8_t type
)

指定された TLV 型が UTF8 またはバイト文字列の場合、true を返します。

詳細
戻り値	指定された TLV 型が UTF8 またはバイト文字列の場合は `true`。それ以外の場合は `false` になります。

TagNumFromTag

uint32_t TagNumFromTag(
  uint64_t tag
)

TLV タグからタグ番号を返します。

詳細

パラメータ

[in] tag

プロファイル固有またはコンテキスト固有の TLV タグの API 表現。

戻り値

関連付けられているタグ番号。

関連情報:
IsProfileTag()、IsContextTag()

VendorIdFromTag

uint16_t VendorIdFromTag(
  uint64_t tag
)

TLV タグからベンダー ID を返します。

詳細

パラメータ

[in] tag

プロファイル固有の TLV タグの API 表現。

戻り値

関連付けられているベンダー ID。

nl::Weave::TLV

概要

列挙型

変数

関数

クラス

名前空間

列挙型

@71

@73

@74

@75

TLVCommonProfiles

TLVElementType

TLVFieldSize

TLVTagControl

TLVTagFields

TLVType

変数

kWeaveTLVCopyChunkSize

sTagSizes

関数

CommonTag

ContextTag

GetTLVFieldSize

IsContextTag

IsProfileTag

IsSpecialTag

IsValidTLVType

ProfileIdFromTag

ProfileNumFromTag

ProfileTag

ProfileTag

TLVFieldSizeToBytes

TLVTypeHasLength

TLVTypeHasValue

TLVTypeIsContainer

TLVTypeIsString

TagNumFromTag

VendorIdFromTag