nl::Weave::Profiles::SoftwareUpdate

Cet espace de noms inclut toutes les interfaces de Weave pour le profil Weave Software Update, qui inclut le protocole correspondant du même nom.

Résumé

Énumérations

@309{
  kMsgType_ImageAnnounce = 0,
  kMsgType_ImageQuery = 1,
  kMsgType_ImageQueryResponse = 2,
  kMsgType_DownloadNotify = 3,
  kMsgType_NotifyResponse = 4,
  kMsgType_UpdateNotify = 5,
  kMsgType_ImageQueryStatus = 6
}
énum
@310{
  kStatus_NoUpdateAvailable = 0x0001,
  kStatus_UpdateFailed = 0x0010,
  kStatus_InvalidInstructions = 0x0050,
  kStatus_DownloadFailed = 0x0051,
  kStatus_IntegrityCheckFailed = 0x0052,
  kStatus_Abort = 0x0053,
  kStatus_Retry = 0x0091
}
énum
@311{
  kFlag_PackageSpecPresent = 1,
  kFlag_LocaleSpecPresent = 2,
  kFlag_TargetNodeIdPresent = 4
}
énum
Indicateurs de contrôle pour le champ de contrôle du cadre ImageQuery.
@312 énum
Masques de bits pour le champ des options de mise à jour facultatif du ImageQueryResponse.
@313 énum
Décalages de décalage pour le champ des options de mise à jour facultatif du ImageQueryResponse.
@314{
  kIntegrityType_SHA160 = 0,
  kIntegrityType_SHA256 = 1,
  kIntegrityType_SHA512 = 2,
  kIntegrityType_Last = 3
}
énum
@315 énum
Longueurs, en octets, des chaînes d'octets de spécification d'intégrité.
@316{
  kUpdateScheme_HTTP = 0,
  kUpdateScheme_HTTPS = 1,
  kUpdateScheme_SFTP = 2,
  kUpdateScheme_BDX = 3,
  kUpdateScheme_Last = 4
}
énum
@317 énum
Tags d'éléments de données pour le profil SoftwareUpdate
UpdateCondition{
  IfUnmatched,
  IfLater,
  Unconditionally,
  OnOptIn
}
énum
Conditions régissant la règle de mise à jour.
UpdatePriority{
  Normal,
  Critical
}
énum
Mettez à jour les priorités.

Fonctions

integrityLength(uint8_t aType)
int
Méthode d'assistance mappant les valeurs IntegrityTypes sur les longueurs des hachages de ce type.

Classes

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

Interface pour le délégué WeaveImageAnnounceServer.

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

Classe décrivant le message ImageAnnounce.

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

Classe permettant de créer et de décoder des messages de requête d'image.

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

Une classe permettant de créer et de décoder les messages de réponse à une requête d'image.

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

Classe auxiliaire contenant le type d'intégrité et le hachage réel de l'image de mise à jour logicielle.

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

Classe auxiliaire permettant de contenir une liste de types d'intégrité dans la requête d'image.

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

Classe auxiliaire représentant une spécification de produit.

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

Classe auxiliaire permettant de contenir une liste de schémas de mise à jour dans le cadre de la requête d'image.

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

Serveur écoutant les annonces d'images Weave.

Énumérations

@309

 @309

SoftwareUpdate.

Propriétés
kMsgType_DownloadNotify

Message facultatif envoyé par le client au serveur pour informer le serveur de l'état du téléchargement.

Sa charge utile est de type nl::Weave::Profiles::StatusReporting::StatusReport avec les informations d'état supplémentaires extraites de SoftwareUpdateStatusCodes.

kMsgType_ImageAnnounce

Message non sollicité facultatif, utilisé par le serveur pour annoncer la disponibilité d'une mise à jour logicielle.

Le message ne comporte aucune charge utile.

kMsgType_ImageQuery

Message de requête envoyé par le client au serveur.

Son format est défini avec la classe ImageQuery.

kMsgType_ImageQueryResponse

Message généré en réponse à un message de requête d'image réussi.

Son format est défini par la classe ImageQueryResponse.

kMsgType_ImageQueryStatus

Message généré en réponse à un message d'échec de la requête d'image.

Sa charge utile est de type nl::Weave::Profiles::StatusReporting::StatusReport avec les informations d'état supplémentaires extraites de SoftwareUpdateStatusCodes.

kMsgType_NotifyResponse

Message généré en réponse au message de notification de téléchargement.

Sa charge utile est de type nl::Weave::Profiles::StatusReporting::StatusReport avec les informations d'état supplémentaires extraites de SoftwareUpdateStatusCodes.

kMsgType_UpdateNotify

Message facultatif envoyé par le client au serveur pour communiquer l'état final de la mise à jour.

Sa charge utile est de type nl::Weave::Profiles::StatusReporting::StatusReport avec les informations d'état supplémentaires extraites de SoftwareUpdateStatusCodes. Comme le message est censé être généré après une mise à jour effective, il est envoyé sur un nouveau ExchangeContext et est traité comme un message non sollicité sur le serveur.

@310

 @310

Codes d'état SoftwareUpdate spécifiques au profil.

Propriétés
kStatus_Abort

serveur => client, indique que le client doit renoncer, car le serveur n'a plus d'options.

kStatus_DownloadFailed

client => indique l'échec d'une tentative de téléchargement.

kStatus_IntegrityCheckFailed

client => indique qu'une image a été téléchargée, mais que le contrôle d'intégrité suivant a échoué.

kStatus_InvalidInstructions

client => indique que le client n'a pas pu télécharger d'image, car les instructions de téléchargement contenues dans ImageQueryResponse sont

URI, schéma de mise à jour, condition de mise à jour, format incorrect ou incohérent.

kStatus_NoUpdateAvailable

serveur => client, indique qu'une requête d'image a été reçue et comprise et que le serveur ne dispose d'aucune mise à jour pour le client pour le moment.

kStatus_Retry

serveur => client, indique qu'il doit envoyer une autre requête d'image et relancer/continuer la mise à jour

kStatus_UpdateFailed

client => indique que la tentative d'installation d'une image spécifiée par le serveur a échoué.

@311

 @311

Indicateurs de contrôle pour le champ de contrôle du cadre ImageQuery.

Propriétés
kFlag_LocaleSpecPresent

La spécification des paramètres régionaux est présente dans ImageQuery.

kFlag_PackageSpecPresent

La spécification du package est présente dans ImageQuery.

kFlag_TargetNodeIdPresent

L'ID du nœud cible est présent dans ImageQuery.

@312

 @312

Masques de bits pour le champ des options de mise à jour facultatif du ImageQueryResponse.

@313

 @313

Décalages de décalage pour le champ des options de mise à jour facultatif du ImageQueryResponse.

@314

 @314

Types d'intégrité compatibles avec le profil SoftwareUpdate.

Le cadre de requête d'image contient des informations sur les vérifications d'intégrité prises en charge par le client, tandis que la réponse à la requête d'image contient un type d'intégrité et une valeur pour l'image que le client est invité à télécharger et à installer. Voici les types pris en charge :

Propriétés
kIntegrityType_Last

Nombre d'éléments valides dans l'énumération.

kIntegrityType_SHA160

Hachage sécurisé 160 bits (SHA-1) requis.

kIntegrityType_SHA256

Hachage sécurisé 256 bits (SHA-2)

kIntegrityType_SHA512

Hachage sécurisé (SHA-2) 512 bits.

@315

 @315

Longueurs, en octets, des chaînes d'octets de spécification d'intégrité.

@316

 @316

Schémas de mise à jour compatibles avec le profil SofwareUpdate.

Comme pour les types d'intégrité pris en charge, la requête d'image contient des informations sur les schémas de mise à jour, c'est-à-dire les protocoles de téléchargement acceptés par le client, et la réponse contient une valeur indiquant le schéma de mise à jour à utiliser pour télécharger les images. Les schémas pris en charge sont les suivants:

Propriétés
kUpdateScheme_BDX

Le transfert de données Weave Bulk doit être utilisé comme protocole de téléchargement.

kUpdateScheme_HTTP

HTTP doit être utilisé comme protocole de téléchargement.

kUpdateScheme_HTTPS

HTTPS doit être utilisé comme protocole de téléchargement.

kUpdateScheme_Last

Nombre d'éléments valides dans l'énumération.

kUpdateScheme_SFTP

SFTP doit être utilisé comme protocole de téléchargement.

@317

 @317

Tags d'éléments de données pour le profil SoftwareUpdate

UpdateCondition

 UpdateCondition

Conditions régissant la règle de mise à jour.

Propriétés
IfLater

Téléchargez et installez l'image si la spécification de version dans le cadre de réponse est postérieure à la version du logiciel actuellement installée.

IfUnmatched

Téléchargez et installez l'image si la spécification de version dans le cadre de réponse ne correspond pas à la version du logiciel actuellement installée.

OnOptIn

télécharger et installer l'image sur un déclencheur fourni par un utilisateur du site.

Unconditionally

Téléchargez et installez l'image, quelle que soit la version logicielle en cours d'exécution.

UpdatePriority

 UpdatePriority

Mettez à jour les priorités.

Propriétés
Critical

La mise à jour doit être exécutée immédiatement.

Normal

La mise à jour peut être effectuée à la discrétion du client.

Fonctions

integrityLength

int integrityLength(
  uint8_t aType
)

Méthode d'assistance mappant les valeurs IntegrityTypes sur les longueurs des hachages de ce type.

Détails
Paramètres
[in] aType
Une valeur IntegrityTypes
Renvoie
Longueur du hachage du type de hachage fourni.