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 の循環ストレージを提供します。

Namespace
nl::Weave::TLV::Debug

この名前空間には、Weave の TLV のデバッグとロギングを行うためのタイプとインターフェースが含まれます。
nl::Weave::TLV::Utilities

この名前空間には、Weave の TLV を管理、操作するためのタイプとユーティリティ インターフェースが含まれています。

列挙型

@71

 @71

@73

 @73

@74

 @74
プロパティ
AnonymousTag

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

匿名要素です）。

@75

 @75

TLVCommonProfiles

 TLVCommonProfiles
プロパティ
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。