nl::Weave::DeviceLayer::SoftwareUpdateManager

摘要

继承

直接已知子类：
nl::Weave::DeviceLayer::SoftwareUpdateManagerImpl
nl::Weave::DeviceLayer::SoftwareUpdateManagerImpl
nl::Weave::DeviceLayer::SoftwareUpdateManagerImpl

公共类型
ActionType{
  kAction_Ignore,
  kAction_DownloadNow,
  kAction_DownloadLater,
  kAction_ApplicationManaged
} 		枚举
有可用的软件更新时，应用可以作为 SoftwareUpdateAvailable API 事件回调的一部分选择以下操作之一。
EventCallback)(void *apAppState, EventType aEvent, const InEventParam &aInParam, OutEventParam &aOutParam) typedef
void(*
EventType{
  kEvent_PrepareQuery,
  kEvent_PrepareQuery_Metadata,
  kEvent_QueryPrepareFailed,
  kEvent_QuerySent,
  kEvent_SoftwareUpdateAvailable,
  kEvent_FetchPartialImageInfo,
  kEvent_PrepareImageStorage,
  kEvent_StartImageDownload,
  kEvent_StoreImageBlock,
  kEvent_ComputeImageIntegrity,
  kEvent_ResetPartialImageInfo,
  kEvent_ReadyToInstall,
  kEvent_StartInstallImage,
  kEvent_Finished,
  kEvent_DefaultCheck = 100
} 		枚举
由 SoftwareUpdateManager 对象生成的 API 事件。
RetryPolicyCallback)(void *aAppState, RetryParam &aRetryParam, uint32_t &aOutIntervalMsec) typedef
void(*
State 枚举

朋友课程
Internal::GenericPlatformManagerImpl
friend class

公共函数
Abort(void)
CheckNow(void)
GetState(void)
State
ImageInstallComplete(WEAVE_ERROR aError)
IsInProgress(void)
bool
PrepareImageStorageComplete(WEAVE_ERROR aError)
SetEventCallback(void *const aAppState, const EventCallback aEventCallback)
SetQueryIntervalWindow(uint32_t aMinWaitTimeMs, uint32_t aMaxWaitTimeMs)
SetRetryPolicyCallback(const RetryPolicyCallback aRetryPolicyCallback)
void

公共静态函数
DefaultEventHandler(void *apAppState, EventType aEvent, const InEventParam & aInParam, OutEventParam & aOutParam)
void

受保护的函数
SoftwareUpdateManager()=default
SoftwareUpdateManager(const SoftwareUpdateManager &)=delete
SoftwareUpdateManager(const SoftwareUpdateManager &&)=delete
operator=(const SoftwareUpdateManager &)=delete
~SoftwareUpdateManager()=default

结构体
nl::Weave::DeviceLayer::SoftwareUpdateManager::RetryParam

联合
nl::Weave::DeviceLayer::SoftwareUpdateManager::InEventParam
nl::Weave::DeviceLayer::SoftwareUpdateManager::OutEventParam

公共类型

操作类型

 ActionType

有可用的软件更新时，应用可以作为 SoftwareUpdateAvailable API 事件回调的一部分选择以下操作之一。

默认操作将设置为 kAction_Now。

属性
kAction_ApplicationManaged

允许应用管理软件更新的其他阶段，例如下载、映像完整性验证和安装。

软件更新管理器状态机将切换到 ApplicationManaged 状态。计划的软件更新检查（如果已启用）将被暂停，直到应用调用 Abort 或 ImageInstallComplete API。
kAction_DownloadLater

开始暂停下载。

系统会安排定期执行软件更新检查（如果已启用）。状态机将保持“下载”状态。准备就绪后，应用可以调用继续下载 API 以继续下载，或者调用 Abort 取消。
kAction_DownloadNow

立即开始下载。

之后将立即生成 kEvent_FetchPartialImageInfo API 事件回调。
kAction_Ignore

完全忽略下载。

选择此选项后，将生成 kEvent_Finished API 事件回调，带有错误 WEAVE_DEVICE_ERROR_SOFTWARE_UPDATE_CANCELLED，并且不会调用重试逻辑。

EventCallback

void(* EventCallback)(void *apAppState, EventType aEvent, const InEventParam &aInParam, OutEventParam &aOutParam)

EventType

 EventType

由 SoftwareUpdateManager 对象生成的 API 事件。

属性
kEvent_ComputeImageIntegrity

计算映像完整性检查值。

请求应用针对下载的图片计算完整性检查值。下载完成后生成的文件。
kEvent_DefaultCheck

检查默认事件处理行为。

用于验证应用的默认事件处理是否正确。

应用不得处理此事件。
kEvent_FetchPartialImageInfo

获取部分下载的映像的持久状态信息。

让应用有机会披露之前下载的部分图片的信息，以便从上次停止的位置继续下载。可用软件更新的 URI 作为输入参数提供，应用可使用该参数来比较要下载的图片是否与部分图片相同。

应用应在 PartialImageLenInBytes 输出参数中返回部分图像的长度。应用可以将 PartialImageLenInBytes 的值设置为 0，以指示不存在部分图像或部分图像的 URI 不匹配。

应用可选择忽略此事件，方法是将其传递到默认事件处理程序。这样一来，系统将始终下载所有可用的固件映像。
kEvent_Finished

软件更新流程已完成。

在软件更新检查已完成或无错误时生成。如果事件由于失败而完成，此事件中包含的参数会提供失败原因。
kEvent_PrepareImageStorage

准备存储新映像。

请求应用执行准备本地存储空间以执行下载新固件映像所需的所有步骤。例如，该应用可清空 Flash 页面。

只有在下载新的固件映像时，才会生成 PrepareImageStorage 事件。恢复之前中断的下载时，系统不会生成 PrepareImageStorage。

应用必须通过调用 PrepareImageStorageComplete() 方法来指示准备操作已完成。它可能会在事件回调本身内或稍后执行此操作。如果从 Weave 任务以外的任务调用，调用方必须持有 Weave 堆栈锁定。

应用可以选择忽略 PrepareImageStorage 事件，只需将其传递给默认事件处理程序即可。完成此操作后，系统会自动进入图片下载状态。

为支持恢复中断的下载，应用应保留图片 URI（作为事件参数提供），并在处理后续的 FetchPartialImageInfo 事件时使用。
kEvent_PrepareQuery

准备 ImageQuery 消息。

触发软件更新检查时生成。为应用提供向 SofwareUpdate:ImageQuery 消息提供产品相关信息的机会。
kEvent_PrepareQuery_Metadata

准备 ImageQuery 请求的元数据。

为应用提供机会，以便在 SofwareUpdate:ImageQuery 消息中附加额外的元数据。当实现准备好从应用获取元数据时生成。
kEvent_QueryPrepareFailed

准备 ImageQuery 请求时出错。

当实现在准备发出软件更新查询时遇到错误时生成。
kEvent_QuerySent

ImageQuery 请求已发送。

用于指示已发送 SofwareUpdate:ImageQuery 消息的信息性事件。
kEvent_ReadyToInstall

图片已可安装。

表示图片已可供安装的信息性事件。在图像通过完整性检查后生成。
kEvent_ResetPartialImageInfo

重置部分已下载图片的状态。

请求应用忘记与下载的图片相关联的持久状态。每当下载的图片未通过完整性检查时，系统都会生成 ResetPartialImageInfo 事件。处理完 ResetPartialImageInfo 事件后，后续 FetchPartialImageInfo 事件应指明没有可用的部分图片。

请注意，在处理 ResetPartialImageInfo 事件时，应用不需要清除图片数据本身，只需清除与图片关联的状态信息（即 URI 和部分图片长度）。

如果应用不支持图片下载恢复，可能会通过将该事件传递给默认事件处理程序来忽略此事件。
kEvent_SoftwareUpdateAvailable

有可用的软件更新。

收到包含可用更新信息的查询时，系统收到 SofwareUpdate:ImageQueryResponse 时生成。
kEvent_StartImageDownload

已开始下载图片。

用于指示图片下载交易已开始的信息性事件。
kEvent_StartInstallImage

开始安装映像。

请求应用安装下载的固件映像。
kEvent_StoreImageBlock

存储图片数据块。

从文件下载服务器收到数据块时生成。此事件中包含的参数提供数据和数据长度。

为支持恢复中断的下载，应用应保留已存储的图片字节总数，并在处理后续的 FetchPartialImageInfo 事件时使用此值。

RetryPolicyCallback

void(* RetryPolicyCallback)(void *aAppState, RetryParam &aRetryParam, uint32_t &aOutIntervalMsec)

状态

 State

朋友课程

内部::GenericPlatformManagerImpl

friend class Internal::GenericPlatformManagerImpl

公共函数

取消

WEAVE_ERROR Abort(
  void
)

立即检查

WEAVE_ERROR CheckNow(
  void
)

GetState

State GetState(
  void
)

ImageInstallComplete

WEAVE_ERROR ImageInstallComplete(
  WEAVE_ERROR aError
)

进行中

bool IsInProgress(
  void
)

PrepareImageStorageComplete

WEAVE_ERROR PrepareImageStorageComplete(
  WEAVE_ERROR aError
)

SetEventCallback

WEAVE_ERROR SetEventCallback(
  void *const aAppState,
  const EventCallback aEventCallback
)

SetQueryIntervalWindow

WEAVE_ERROR SetQueryIntervalWindow(
  uint32_t aMinWaitTimeMs,
  uint32_t aMaxWaitTimeMs
)

SetRetryPolicyCallback

void SetRetryPolicyCallback(
  const RetryPolicyCallback aRetryPolicyCallback
)

公共静态函数

DefaultEventHandler 类中的方法

void DefaultEventHandler(
  void *apAppState,
  EventType aEvent,
  const InEventParam & aInParam,
  OutEventParam & aOutParam
)

受保护的函数

软件更新管理器

 SoftwareUpdateManager()=default

软件更新管理器

 SoftwareUpdateManager(
  const SoftwareUpdateManager &
)=delete

软件更新管理器

 SoftwareUpdateManager(
  const SoftwareUpdateManager &&
)=delete

运算符=

SoftwareUpdateManager & operator=(
  const SoftwareUpdateManager &
)=delete

~SoftwareUpdateManager

 ~SoftwareUpdateManager()=default