nl::Weave::Profiles::SoftwareUpdate

Ruang nama ini mencakup semua antarmuka di dalam profil Weave untuk profil Pembaruan Perangkat Lunak Weave, yang menyertakan protokol yang sesuai dengan nama yang sama.

Ringkasan

Enumerasi

@309{
  kMsgType_ImageAnnounce = 0,
  kMsgType_ImageQuery = 1,
  kMsgType_ImageQueryResponse = 2,
  kMsgType_DownloadNotify = 3,
  kMsgType_NotifyResponse = 4,
  kMsgType_UpdateNotify = 5,
  kMsgType_ImageQueryStatus = 6
}
enum
Jenis pesan SoftwareUpdate.
@310{
  kStatus_NoUpdateAvailable = 0x0001,
  kStatus_UpdateFailed = 0x0010,
  kStatus_InvalidInstructions = 0x0050,
  kStatus_DownloadFailed = 0x0051,
  kStatus_IntegrityCheckFailed = 0x0052,
  kStatus_Abort = 0x0053,
  kStatus_Retry = 0x0091
}
enum
@311{
  kFlag_PackageSpecPresent = 1,
  kFlag_LocaleSpecPresent = 2,
  kFlag_TargetNodeIdPresent = 4
}
enum
Flag kontrol untuk kolom kontrol frame ImageQuery.
@312 enum
Bitmask untuk kolom opsi update opsional ImageQueryResponse.
@313 enum
Shift offset untuk kolom opsi update opsional ImageQueryResponse.
@314{
  kIntegrityType_SHA160 = 0,
  kIntegrityType_SHA256 = 1,
  kIntegrityType_SHA512 = 2,
  kIntegrityType_Last = 3
}
enum
@315 enum
Panjang, dalam byte, untuk string byte spesifikasi integritas.
@316{
  kUpdateScheme_HTTP = 0,
  kUpdateScheme_HTTPS = 1,
  kUpdateScheme_SFTP = 2,
  kUpdateScheme_BDX = 3,
  kUpdateScheme_Last = 4
}
enum
@317 enum
Tag Elemen Data untuk Profil SoftwareUpdate.
UpdateCondition{
  IfUnmatched,
  IfLater,
  Unconditionally,
  OnOptIn
}
enum
Ketentuan yang mengatur kebijakan update.
UpdatePriority{
  Normal,
  Critical
}
enum
Memperbarui prioritas.

Fungsi

integrityLength(uint8_t aType)
int
Metode dukungan yang memetakan nilai IntegrityTypes ke panjang hash jenis tersebut.

Class

nl::Weave::Profiles::SoftwareUpdate::IWeaveImageAnnounceServerDelegate

Antarmuka untuk delegasi WeaveImageAnnounceServer.

nl::Weave::Profiles::SoftwareUpdate::ImageAnnounce

Class yang menjelaskan pesan ImageAnnounce.

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

Class untuk mendukung pembuatan dan decoding pesan kueri gambar.

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

Class untuk mendukung pembuatan dan decoding pesan respons kueri gambar.

nl::Weave::Profiles::SoftwareUpdate::IntegritySpec

Class tambahan yang menyimpan jenis integritas dan hash sebenarnya dari image update software.

nl::Weave::Profiles::SoftwareUpdate::IntegrityTypeList

Class tambahan untuk menyimpan daftar jenis integritas sebagai bagian dari kueri gambar.

nl::Weave::Profiles::SoftwareUpdate::ProductSpec

Class tambahan yang mewakili spesifikasi produk.

nl::Weave::Profiles::SoftwareUpdate::UpdateSchemeList

Class tambahan untuk menyimpan daftar skema update sebagai bagian dari kueri gambar.

nl::Weave::Profiles::SoftwareUpdate::WeaveImageAnnounceServer

Server yang memproses pengumuman gambar Weave.

Enumerasi

@309

 @309

Jenis pesan SoftwareUpdate.

Properti
kMsgType_DownloadNotify

Pesan opsional dari klien ke server yang digunakan untuk memberi tahu server tentang status unduhan.

Payloadnya adalah nl::Weave::Profiles::StatusReporting::StatusReport dengan info status tambahan yang diambil dari SoftwareUpdateStatusCodes.

kMsgType_ImageAnnounce

Pesan opsional yang tidak diminta, yang digunakan oleh server untuk mengumumkan ketersediaan update software.

Pesan tidak membawa payload.

kMsgType_ImageQuery

Pesan kueri yang dikirim oleh klien ke server.

Formatnya ditentukan dengan class ImageQuery.

kMsgType_ImageQueryResponse

Pesan yang dibuat sebagai respons atas pesan kueri gambar yang berhasil.

Formatnya ditentukan oleh class ImageQueryResponse.

kMsgType_ImageQueryStatus

Pesan yang dibuat sebagai respons terhadap pesan kueri gambar yang gagal.

Payloadnya adalah nl::Weave::Profiles::StatusReporting::StatusReport dengan info status tambahan yang diambil dari SoftwareUpdateStatusCodes.

kMsgType_NotifyResponse

Pesan yang dibuat sebagai respons terhadap pesan notifikasi download.

Payloadnya adalah nl::Weave::Profiles::StatusReporting::StatusReport dengan info status tambahan yang diambil dari SoftwareUpdateStatusCodes.

kMsgType_UpdateNotify

Pesan opsional dari klien ke server yang digunakan untuk mengomunikasikan status akhir update.

Payloadnya adalah nl::Weave::Profiles::StatusReporting::StatusReport dengan info status tambahan yang diambil dari SoftwareUpdateStatusCodes. Karena pesan diharapkan akan dibuat setelah update aktual, pesan dikirim di ExchangeContext baru dan diperlakukan sebagai pesan yang tidak diminta di server.

@310

 @310

Kode status khusus profil SoftwareUpdate.

Properti
kStatus_Abort

server => client, menunjukkan bahwa klien harus menyerah karena server kehabisan opsi.

kStatus_DownloadFailed

client => server, menunjukkan bahwa percobaan unduhan gagal.

kStatus_IntegrityCheckFailed

client => server, menunjukkan bahwa image telah didownload namun gagal dalam pemeriksaan integritas berikutnya.

kStatus_InvalidInstructions

client => server, menunjukkan bahwa klien tidak dapat mendownload gambar karena petunjuk download yang terdapat dalam ImageQueryResponse, yaitu

URI, skema update, kondisi update, berformat buruk atau tidak konsisten.

kStatus_NoUpdateAvailable

server => client, menunjukkan bahwa kueri gambar telah diterima dan dipahami dan bahwa server tidak memiliki pembaruan untuk klien saat ini.

kStatus_Retry

server => client, menunjukkan bahwa klien harus mengirimkan kueri gambar lain dan memulai ulang/melanjutkan update

kStatus_UpdateFailed

client => server, menunjukkan bahwa upaya menginstal image yang ditetapkan oleh server telah gagal.

@311

 @311

Flag kontrol untuk kolom kontrol frame ImageQuery.

Properti
kFlag_LocaleSpecPresent

Spesifikasi Locale ada di ImageQuery.

kFlag_PackageSpecPresent

Spesifikasi paket ada di ImageQuery.

kFlag_TargetNodeIdPresent

ID node target ada di ImageQuery.

@312

 @312

Bitmask untuk kolom opsi update opsional ImageQueryResponse.

@313

 @313

Shift offset untuk kolom opsi update opsional ImageQueryResponse.

@314

 @314

Jenis integritas yang didukung oleh profil SoftwareUpdate.

Bingkai kueri gambar berisi informasi tentang pemeriksaan integritas mana yang didukung klien dan respons kueri gambar berisi jenis dan nilai integritas untuk image yang diminta untuk didownload dan diinstal klien. Jenis yang didukung adalah:

Properti
kIntegrityType_Last

Jumlah elemen yang valid dalam enumerasi.

kIntegrityType_SHA160

160-bit Secure Hash, (SHA-1), diperlukan.

kIntegrityType_SHA256

Secure Hash (SHA-2) 256-bit.

kIntegrityType_SHA512

512-bit, Secure Hash (SHA-2).

@315

 @315

Panjang, dalam byte, untuk string byte spesifikasi integritas.

@316

 @316

Skema update yang didukung oleh profil SofwareUpdate.

Demikian pula dengan jenis integritas yang didukung, kueri image berisi informasi tentang skema update mana, yaitu protokol download, yang didukung klien, dan respons berisi nilai untuk menunjukkan skema update yang akan digunakan dalam mendownload gambar. Skema yang didukung adalah:

Properti
kUpdateScheme_BDX

Transfer data Massal Weave harus digunakan sebagai protokol download.

kUpdateScheme_HTTP

HTTP harus digunakan sebagai protokol download.

kUpdateScheme_HTTPS

HTTPS harus digunakan sebagai protokol download.

kUpdateScheme_Last

Jumlah elemen yang valid dalam enumerasi.

kUpdateScheme_SFTP

SFTP akan digunakan sebagai protokol download.

@317

 @317

Tag Elemen Data untuk Profil SoftwareUpdate.

UpdateCondition

 UpdateCondition

Ketentuan yang mengatur kebijakan update.

Properti
IfLater

Download dan instal image jika spesifikasi versi dalam frame respons lebih baru dari versi software yang saat ini terinstal.

IfUnmatched

Download dan instal image jika spesifikasi versi dalam frame respons tidak sesuai dengan versi software yang saat ini terinstal.

OnOptIn

mengunduh dan menginstal gambar pada beberapa pemicu yang disediakan oleh pengguna di situs.

Unconditionally

Download dan instal image, terlepas dari versi software yang sedang berjalan.

UpdatePriority

 UpdatePriority

Memperbarui prioritas.

Properti
Critical

Pembaruan harus segera dijalankan.

Normal

Pembaruan dapat dijalankan sesuai pertimbangan klien.

Fungsi

integrityLength

int integrityLength(
  uint8_t aType
)

Metode dukungan yang memetakan nilai IntegrityTypes ke panjang hash jenis tersebut.

Detail
Parameter
[in] aType
Hasil
Panjang hash jenis hash yang disediakan.