nl::編織::設定檔::軟體更新::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 - 不存在
7.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。

公開屬性

完整性類型

IntegrityTypeList integrityTypes

裝置支援的完整性類型。

語言代碼規格

ReferencedString localeSpec

變數長度 UTF-8 字串，內含發出圖片查詢的裝置所適用的 POSIX 語言代碼。

字串內容必須符合 POSIX 語言代碼 (如 ISO/IEC 15897 中所述)，例如澳洲英文的 en_AU.UTF-8。

套件規格

ReferencedString packageSpec

變數長度 UTF-8 字串，內含供應商專屬的套件規格字串。

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

productSpec

ProductSpec productSpec

說明圖片查詢裝置的裝置規格。

目標節點 ID

uint64_t targetNodeId

查詢執行裝置的裝置的選用節點 ID。

目標節點 ID 為選填欄位。如果沒有這項資訊，查詢的目標節點 ID 會隱含為圖片查詢訊息的來源節點。

「目標節點 ID」欄位通常用於做為 QUERY QUERY 訊息來源的節點，做為其他節點的軟體更新 Proxy。

中繼資料

ReferencedTLVData theMetaData

供應商專用的資料欄位長度不定，會佔用 Weave 訊息酬載的其餘部分，且超出上述欄位。

這個欄位會針對查詢查詢的裝置，編碼供應商特定資訊。供應商專用資料欄位為選填。如果有，這個欄位就會採用匿名的 TLV 編碼結構。此結構中的代碼應為完整的設定檔專屬標記。

updateSchemes

UpdateSchemeList updateSchemes

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

version

ReferencedString version

變數長度 UTF-8 字串，其中包含要進行查詢的裝置的指定裝置軟體版本。

長度不得超過 32 個字元。

公用函式

圖片查詢

 ImageQuery()

ImageQuery 的預設建構函式。

如要填入 ImageQuery，您可以呼叫 init()，或從訊息中反對物件。

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
傳回
如果兩個物件中的所有欄位都相同，則傳回「是」，否則為「否」

包

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 時