nl::Weave::Profiles::SoftwareUpdate::ImageQuery

#include <src/lib/profiles/software-update/SoftwareUpdateProfile.h>

支援建立及解碼圖片查詢訊息的類別。

摘要

圖片查詢頁框的線路形式如下

長 欄位名稱
1 位元組 影格控制
6 個位元組 產品規格
變數 版本規格
2..4 個位元組 完整性類型清單
2..5 個位元組 更新配置清單
變數 語言代碼規格 (選用)
8 個位元組 目標節點 ID
變數 供應商專屬資料 (選用)
其中，頁框控制欄位的 位元欄位如下所示：

位元 意義
0 號 1 - 有供應商專屬資料，0 - 不存在
1 1 - 提供了語言代碼規格，0 - 不存在
2 1 - 有目標節點 ID，0 - 不存在
3.7 已預約
ImageQuery 的結構與傳輸中表示法稍有不同。具體來說，版本和語言代碼都是以空值結束的 c 字串 (而不是 (長度、字元) 組合)，且兩個選用項目都以可為空值指標表示，因此沒有要檢查的獨立布林值。

建構函式和解構函式
ImageQuery()
ImageQuery 的預設建構函式。

公開屬性
integrityTypes
裝置支援的完整性類型。
localeSpec
這個可變長度的 UTF-8 字串，內含進行圖片查詢的裝置作用中的 POSIX 語言代碼。
packageSpec
包含供應商專用套件規格字串的可變長度 UTF-8 字串。
productSpec
產品規格說明建立圖片查詢的裝置。
targetNodeId
uint64_t
查詢目標裝置的節點 ID (選用)。
theMetaData
供應商專屬資料欄位的長度不一，而且會佔用 Weave 訊息酬載的剩餘部分，超過上述欄位。
updateSchemes
更新裝置支援的配置 (下載通訊協定)。
version
可變長度的 UTF-8 字串，其中包含查詢的供應商指定裝置軟體版本。

公用函式
init(ProductSpec & aProductSpec, ReferencedString & aVersion, IntegrityTypeList & aTypeList, UpdateSchemeList & aSchemeList, ReferencedString *aPackage, ReferencedString *aLocale, uint64_t aTargetNodeId, ReferencedTLVData *aMetaData)
使用提供的值明確初始化 ImageQuery 物件。
operator==(const ImageQuery &) const
bool
等號運算子。
pack(PacketBuffer *)
將基礎 ImageQuery 序列化到提供的 PacketBuffer。
print(void)
void

公開的靜態函式
parse(PacketBuffer *, ImageQuery &)
將 PacketBuffer 中提供的圖片查詢訊息反序列化至提供的 ImageQuery。

公開屬性

integrityTypes

IntegrityTypeList integrityTypes

裝置支援的完整性類型。

localeSpec

ReferencedString localeSpec

這個可變長度的 UTF-8 字串，內含進行圖片查詢的裝置作用中的 POSIX 語言代碼。

字串內容必須符合 ISO/IEC 15897 中的 POSIX 語言代碼 ID 格式，例如「en_AU.UTF-8」代表澳洲英文。

packageSpec

ReferencedString packageSpec

包含供應商專用套件規格字串的可變長度 UTF-8 字串。

欄位內容描述軟體映像檔所需的容器類型，例如「rpm」、「deb」、「tgz」、「elf」等 (注意：通訊協定的 Nest 實作項目中未使用這個欄位)

productSpec

ProductSpec productSpec

產品規格說明建立圖片查詢的裝置。

targetNodeId

uint64_t targetNodeId

查詢目標裝置的節點 ID (選用)。

目標節點 ID 為選填欄位。如果未指定，則查詢的目標節點 ID 就是隱含圖片查詢訊息來源的節點。

目標節點 ID 欄位通常會在做為「IMAGE QUERY」訊息來源的節點以其他節點做為軟體更新 Proxy 時使用。

theMetaData

ReferencedTLVData theMetaData

供應商專屬資料欄位的長度不一，而且會佔用 Weave 訊息酬載的剩餘部分，超過上述欄位。

這個欄位會針對查詢查詢的裝置，將供應商專屬資訊編碼。供應商專屬的資料欄位為選填。如果有，欄位會使用匿名 TLV 編碼結構。這個結構中呈現的代碼必須是完整的設定檔專屬代碼。

updateSchemes

UpdateSchemeList updateSchemes

更新裝置支援的配置 (下載通訊協定)。

version

ReferencedString version

可變長度的 UTF-8 字串，其中包含查詢的供應商指定裝置軟體版本。

長度不得超過 32 個字元。

公用函式

ImageQuery

 ImageQuery()

ImageQuery 的預設建構函式。

您可以呼叫 init() 或者將訊息中的物件取消序列化，藉此填入 ImageQuery。

init

WEAVE_ERROR init(
  ProductSpec & aProductSpec,
  ReferencedString & aVersion,
  IntegrityTypeList & aTypeList,
  UpdateSchemeList & aSchemeList,
  ReferencedString *aPackage,
  ReferencedString *aLocale,
  uint64_t aTargetNodeId,
  ReferencedTLVData *aMetaData
)

使用提供的值明確初始化 ImageQuery 物件。

詳細說明
參數
[in] aProductSpec
產品規格。
[in] aVersion
目前安裝的軟體版本。
[in] aTypeList
用戶端支援的完整性類型。
[in] aSchemeList
用戶端支援的更新配置。
[in] aPackage
用戶端支援的選用套件規格。
[in] aLocale
用戶端要求的選用語言代碼規格。
[in] aTargetNodeId
選用的目標節點 ID。
[in] aMetaData
選用的 TLV 編碼供應商資料 blob。
傳回
WEAVE_NO_ERROR (無條件限制)。

運算子==

bool operator==(
  const ImageQuery &
) const

等號運算子。

詳細說明
參數
another
用來檢查此 ImageQuery 的 ImageQuery
傳回
如果兩個物件中的所有欄位都相同，則傳回 true，否則傳回 false

包

WEAVE_ERROR pack(
  PacketBuffer *
)

將基礎 ImageQuery 序列化到提供的 PacketBuffer。

詳細說明
參數
[in] aBuffer
要將查詢封裝到其中的封包緩衝區
傳回值
WEAVE_NO_ERROR
成功時
WEAVE_ERROR_BUFFER_TOO_SMALL
如果 ImageQuery 過大，無法容納提供的緩衝區。

顯示

void print(
  void
)

公開的靜態函式

parse

WEAVE_ERROR parse(
  PacketBuffer *,
  ImageQuery &
)

將 PacketBuffer 中提供的圖片查詢訊息反序列化至提供的 ImageQuery。

詳細說明
參數
[in] aBuffer
要剖析圖片查詢的來源封包指標
[in] aQuery
用於放置結果的物件
傳回
WEAVE_NO_ERROR 成功後
傳回
WEAVE_ERROR_BUFFER_TOO_SMALL 如果訊息太小，無法納入 ImageQuery 的所有欄位
傳回
WEAVE_ERROR_INVALID_LIST_LENGTH 如果訊息包含的 IntegrityTypeList 或 UpdateSchemeList 過長