nl::Weave::Profiles::SoftwareUpdate::ImageQueryResponse

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

כיתה לתמיכה ביצירה ובפענוח של הודעות תשובה לשאילתות תמונה.

סיכום

הודעת התגובה של שאילתת התמונה נראית כך:

אורך שם השדה
משתנה URI
משתנה מפרט הגרסה
משתנה מפרט תקינות
בייט אחד עדכון סכימה
בייט אחד אפשרויות עדכון
זה הפורמט של שדה האפשרויות לעדכון (אופציונלי):

מקדח משמעות
0..2 עדכון העדיפות
3..4 עדכון המצב
5 סטטוס הדוח. כשהיא מוגדרת, הלקוח יתבקש ליצור את ההודעות האופציונליות DownloadNotify ו-UpdateNotify.
5..7 בוצעה הזמנה
התגובה לשאילתת התמונה נשלחת רק במקרה שבו שאילתת התמונה עובדה בהצלחה ומפיקה תמונה להורדה. בהודעה מפורטים הוראות להורדה עבור הצומת שבו נשלחה השאילתה. שימו לב שבמקרים שבהם השרת לא מצליח לעבד את שאילתת התמונה, הוא ייצור סטטוס של שאילתת תמונה.

בנייה
ImageQueryResponse()
בנאי ברירת המחדל של ImageQueryResponse.

מאפיינים ציבוריים
integritySpec
שדה שמכיל את פרטי התקינות (סוג התקינות וגיבוב) של התמונה של עדכון התוכנה.
reportStatus
bool
בקשה ליידע את השרת לגבי התקדמות עדכון התוכנה באמצעות ההודעות האופציונליות DownloadNotify ו-UpdateNotify.
updateCondition
הוראות לגבי התנאים שבהם צריך להמשיך בעדכון התוכנה.
updatePriority
הוראות שמנחים את המכשיר מתי לבצע את עדכון התוכנה.
updateScheme
uint8_t
סכימת העדכון שתשמש להורדת התמונה של עדכון התוכנה.
uri
מחרוזת UTF-8 באורך משתנה שמכילה את המיקום של תמונת התוכנה.
versionSpec
מחרוזת UTF-8 באורך משתנה שמכילה זיהוי גרסת תוכנה ספציפי לספק.

פונקציות ציבוריות
init(ReferencedString &, ReferencedString &, IntegritySpec &, uint8_t, UpdatePriority, UpdateCondition, bool)
מאתחלים במפורש את האובייקט ImageQueryResponse עם הערכים שסופקו.
operator==(const ImageQueryResponse &) const
bool
אופרטור שוויון.
pack(PacketBuffer *)
יוצרים סדרה של ImageQueryResponse ל-PacketBuffer שסופק.
print(void)
void

פונקציות סטטיות ציבוריות
parse(PacketBuffer *, ImageQueryResponse &)
פעולת deserialize את הודעת התגובה לשאילתת התמונה שסופקה ב-packetBuffer ל-ImageQueryResponse שסופקה.

מאפיינים ציבוריים

integritySpec

IntegritySpec integritySpec

שדה שמכיל את פרטי התקינות (סוג התקינות וגיבוב) של התמונה של עדכון התוכנה.

reportStatus

bool reportStatus

בקשה ליידע את השרת לגבי התקדמות עדכון התוכנה באמצעות ההודעות האופציונליות DownloadNotify ו-UpdateNotify.

updateCondition

UpdateCondition updateCondition

הוראות לגבי התנאים שבהם צריך להמשיך בעדכון התוכנה.

updatePriority

UpdatePriority updatePriority

הוראות שמנחים את המכשיר מתי לבצע את עדכון התוכנה.

updateScheme

uint8_t updateScheme

סכימת העדכון שתשמש להורדת התמונה של עדכון התוכנה.

הערך שלו נלקח מ-UpdateSchemes.

URI

ReferencedString uri

מחרוזת UTF-8 באורך משתנה שמכילה את המיקום של תמונת התוכנה.

התוכן של המחרוזת הזו חייב להתאים למפרט RFC 3986. עבור סכמות עדכון שמתאימות לפרוטוקול אינטרנט מוגדר היטב (HTTP, HTTPS, SFTP), רכיב הסכמה של ה-URI חייב להתאים לקידוד כתובת ה-URL הקנונית עבור סכימת הפרוטוקול הזו. אורך המחרוזת לא יכול להיות ארוך מ-65565, והמחרוזת חייבת להתאים בתוך הודעת Weave אחת, והיא עשויה להיות כפופה למגבלות MTU.

versionSpec

ReferencedString versionSpec

מחרוזת UTF-8 באורך משתנה שמכילה זיהוי גרסת תוכנה ספציפי לספק.

אורך המחרוזת לא יכול לחרוג מ-256 בייטים.

פונקציות ציבוריות

ImageQueryResponse

 ImageQueryResponse()

בנאי ברירת המחדל של ImageQueryResponse.

אפשר לאכלס את ImageQueryResponse באמצעות השיטה init() או על ידי פעולת deserialing של האובייקט מהודעה.

להתחיל

WEAVE_ERROR init(
  ReferencedString &,
  ReferencedString &,
  IntegritySpec &,
  uint8_t,
  UpdatePriority,
  UpdateCondition,
  bool
)

מאתחלים במפורש את האובייקט ImageQueryResponse עם הערכים שסופקו.

פרטים
פרמטרים
[in] aUri
ה-URI שבו נמצאת תמונת הקושחה החדשה.
[in] aVersion
מחרוזת הגרסה של התמונה הזו.
[in] aIntegrity
מפרט התקינות התואם לתמונה החדשה.
[in] aScheme
סכימת העדכון לשימוש בהורדה.
[in] aPriority
עדיפות העדכון שמשויכת לעדכון הזה.
[in] aCondition
התנאי שלפיו יתבצע העדכון.
[in] aReportStatus
אם True מבקש מהלקוח לדווח אחרי ההורדה והעדכון, אחרת הלקוח לא ידווח.
החזרות
WEAVE_NO_ERROR ללא תנאי.

אופרטור==

bool operator==(
  const ImageQueryResponse &
) const

אופרטור שוויון.

פרטים
פרמטרים
another
תגובת ImageQueryResponse לבדיקה מול ImageQueryResponse
החזרות
True אם כל השדות בשני האובייקטים שווים, false אם לא

חבילה

WEAVE_ERROR pack(
  PacketBuffer *
)

יוצרים סדרה של ImageQueryResponse ל-PacketBuffer שסופק.

פרטים
פרמטרים
[in] aBuffer
מאגר מאגר נתונים זמני שאליו יקובצו תגובת השאילתה
מוחזר ערכים
WEAVE_NO_ERROR
הצלחה.
WEAVE_ERROR_BUFFER_TOO_SMALL
אם ה-ImageQueryResponse גדול מדי ולא מתאים למאגר הנתונים הזמני.

הדפסה

void print(
  void
)

פונקציות סטטיות ציבוריות

לנתח

WEAVE_ERROR parse(
  PacketBuffer *,
  ImageQueryResponse &
)

פעולת deserialize את הודעת התגובה לשאילתת התמונה שסופקה ב-packetBuffer ל-ImageQueryResponse שסופקה.

פרטים
פרמטרים
[in] aBuffer
מצביע על חבילה שממנה אפשר לנתח את שאילתת התמונה
[in] aResponse
אובייקט שבו יש להציב את התוצאה
החזרות
WEAVE_NO_ERRORבהצלחה
החזרות
WEAVE_ERROR_BUFFER_TOO_CUSTOM אם ההודעה הייתה קטנה מדי ולא יכולה להכיל את כל השדות של ImageQuery
החזרות
WEAVE_ERROR_INVALID_INTEGRITY_TYPE אם סוג התקינות שצוין אינו אחד מהערכים שצוינו ב-IntegrityTypes