nl::Weave::Profiles::SoftwareUpdate

この名前空間には、Weave ソフトウェア アップデート プロファイル用の Weave 内のすべてのインターフェースが含まれます。これには、同じ名前の対応するプロトコルが含まれます。

概要

列挙型

@309{
  kMsgType_ImageAnnounce = 0,
  kMsgType_ImageQuery = 1,
  kMsgType_ImageQueryResponse = 2,
  kMsgType_DownloadNotify = 3,
  kMsgType_NotifyResponse = 4,
  kMsgType_UpdateNotify = 5,
  kMsgType_ImageQueryStatus = 6
}
enum
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
ImageQuery フレームのコントロール フィールドのコントロール フラグ。
@312 enum
ImageQueryResponse のオプションの更新オプション フィールドのビットマスク。
@313 enum
ImageQueryResponse の省略可能な更新オプション フィールドのシフト オフセット。
@314{
  kIntegrityType_SHA160 = 0,
  kIntegrityType_SHA256 = 1,
  kIntegrityType_SHA512 = 2,
  kIntegrityType_Last = 3
}
enum
@315 enum
整合性仕様のバイト文字列の長さ(バイト単位)。
@316{
  kUpdateScheme_HTTP = 0,
  kUpdateScheme_HTTPS = 1,
  kUpdateScheme_SFTP = 2,
  kUpdateScheme_BDX = 3,
  kUpdateScheme_Last = 4
}
enum
@317 enum
SoftwareUpdate プロファイルのデータ要素タグ。
UpdateCondition{
  IfUnmatched,
  IfLater,
  Unconditionally,
  OnOptIn
}
enum
更新ポリシーを規定する条件。
UpdatePriority{
  Normal,
  Critical
}
enum
優先度を更新します。

関数

integrityLength(uint8_t aType)
int
IntegrityTypes の値をその型のハッシュの長さにマッピングするサポート メソッド。

クラス

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

WeaveImageAnnounceServer デリゲートのインターフェース

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

ImageAnnounce メッセージを記述するクラス。

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

画像クエリ メッセージの作成とデコードをサポートするクラス。

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

画像クエリ レスポンス メッセージの作成とデコードをサポートするクラス。

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

ソフトウェア アップデート イメージの整合性タイプと実際のハッシュを保持する補助クラス。

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

画像クエリの一部として完全性型のリストを保持する補助クラス。

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

製品仕様を表す補助クラス。

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

更新スキームのリストを画像クエリの一部として保持する補助クラス。

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

Weave の画像通知をリッスンするサーバー。

列挙型

@309

 @309

SoftwareUpdate メッセージ タイプ。

プロパティ
kMsgType_DownloadNotify

サーバーにダウンロード ステータスを通知するために使用される、クライアントからサーバーに送信されるメッセージ(省略可)。

そのペイロードは、nl::Weave::Profiles::StatusReporting::StatusReport であり、SoftwareUpdateStatusCodes から取得される追加ステータス情報を含みます。

kMsgType_ImageAnnounce

ソフトウェア アップデートが利用可能になったことをサーバーが告知するために使用する、オプションの未承諾メッセージ。

メッセージにペイロードは含まれません。

kMsgType_ImageQuery

クライアントからサーバーに送信されるクエリ メッセージ。

形式は ImageQuery クラスで定義します。

kMsgType_ImageQueryResponse

画像クエリが正常に実行された場合に生成されるメッセージ。

形式は ImageQueryResponse クラスで定義されます。

kMsgType_ImageQueryStatus

失敗した画像クエリ メッセージに応じて生成されたメッセージ。

そのペイロードは、nl::Weave::Profiles::StatusReporting::StatusReport であり、SoftwareUpdateStatusCodes から取得される追加ステータス情報を含みます。

kMsgType_NotifyResponse

ダウンロード通知メッセージに応答して生成されるメッセージ。

そのペイロードは、nl::Weave::Profiles::StatusReporting::StatusReport であり、SoftwareUpdateStatusCodes から取得される追加ステータス情報を含みます。

kMsgType_UpdateNotify

更新の最終ステータスを伝えるために使用される、クライアントからサーバーへのメッセージ(省略可)。

そのペイロードは、nl::Weave::Profiles::StatusReporting::StatusReport であり、SoftwareUpdateStatusCodes から取得される追加ステータス情報を含みます。メッセージは実際の更新後に生成されることが想定されているため、新しい ExchangeContext で送信され、サーバー上では迷惑メールとして扱われます。

@310

 @310

SoftwareUpdate プロファイル固有のステータス コード。

プロパティ
kStatus_Abort

server => client は、サーバーにオプションがないため、クライアントを諦める必要があることを示します。

kStatus_DownloadFailed

client => server は、ダウンロードが失敗したことを示します。

kStatus_IntegrityCheckFailed

client => server は、イメージがダウンロードされたものの、その後の完全性チェックに失敗したことを示します。

kStatus_InvalidInstructions

client => server は、ImageQueryResponse に含まれているダウンロード手順が原因で、クライアントが画像をダウンロードできなかったことを示します。つまり、

URI、更新スキーム、更新条件の形式が不適切であるか、一貫性がありません。

kStatus_NoUpdateAvailable

server => client は、画像クエリが受信されて認識されていることと、現時点ではサーバーでクライアントの更新がないことを示します。

kStatus_Retry

server => client。クライアントが別の画像クエリを送信し、更新を再開/続行する必要があることを示します

kStatus_UpdateFailed

client => server。サーバーで指定されたイメージのインストールが失敗したことを示します。

@311

 @311

ImageQuery フレームのコントロール フィールドのコントロール フラグ。

プロパティ
kFlag_LocaleSpecPresent

ロケールの仕様は ImageQuery 内にあります。

kFlag_PackageSpecPresent

パッケージの仕様は ImageQuery 内にあります。

kFlag_TargetNodeIdPresent

ターゲット ノード ID が ImageQuery に存在する。

@312

 @312

ImageQueryResponse のオプションの更新オプション フィールドのビットマスク。

@313

 @313

ImageQueryResponse の省略可能な更新オプション フィールドのシフト オフセット。

@314

 @314

SoftwareUpdate プロファイルでサポートされている整合性タイプ。

画像クエリ フレームには、クライアントがサポートする整合性チェックに関する情報が含まれ、画像クエリ レスポンスには、クライアントにダウンロードとインストールを指示されている画像の整合性タイプと値が含まれます。指定できるタイプは次のとおりです:

プロパティ
kIntegrityType_Last

列挙型内の有効な要素の数。

kIntegrityType_SHA160

160 ビット セキュア ハッシュ(SHA-1)。必須。

kIntegrityType_SHA256

256 ビット セキュア ハッシュ(SHA-2)。

kIntegrityType_SHA512

512 ビットの Secure Hash(SHA-2)。

@315

 @315

整合性仕様のバイト文字列の長さ(バイト単位)。

@316

 @316

SofwareUpdate プロファイルでサポートされているアップデート スキーム

サポートされている整合性タイプと同様に、画像クエリには、クライアントがサポートする更新スキーム(ダウンロード プロトコル)に関する情報が含まれ、レスポンスには、画像のダウンロードに使用する更新スキームを示す値が含まれます。サポートされているスキームは次のとおりです。

プロパティ
kUpdateScheme_BDX

ダウンロード プロトコルには、Weave Bulk Data Transfer が使用されます。

kUpdateScheme_HTTP

ダウンロード プロトコルには HTTP を使用します。

kUpdateScheme_HTTPS

ダウンロード プロトコルには HTTPS を使用する。

kUpdateScheme_Last

列挙型内の有効な要素の数。

kUpdateScheme_SFTP

ダウンロード プロトコルとして SFTP を使用するものとします。

@317

 @317

SoftwareUpdate プロファイルのデータ要素タグ。

UpdateCondition

 UpdateCondition

更新ポリシーを規定する条件。

プロパティ
IfLater

レスポンス フレームのバージョン指定が現在インストールされているソフトウェア バージョンより新しい場合は、イメージをダウンロードしてインストールします。

IfUnmatched

レスポンス フレームのバージョン仕様が現在インストールされているソフトウェア バージョンと一致しない場合は、イメージをダウンロードしてインストールします。

OnOptIn

オンサイトのユーザーが指定したトリガーでイメージをダウンロードしてインストールする

Unconditionally

現在実行中のソフトウェア バージョンに関係なく、イメージをダウンロードしてインストールします。

UpdatePriority

 UpdatePriority

優先度を更新します。

プロパティ
Critical

更新はすぐに実行する必要があります。

Normal

更新はクライアントの裁量で実施される場合があります。

関数

integrityLength

int integrityLength(
  uint8_t aType
)

IntegrityTypes の値をその型のハッシュの長さにマッピングするサポート メソッド。

詳細
パラメータ
[in] aType
戻り値
指定されたハッシュ型のハッシュの長さ。