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

 ActionType

當有可用的軟體更新時,應用程式可以選擇下列其中一個動作做為 SoftwareUpdateAvailable API 事件回呼的一部分。

預設動作將設為 kAction_Now。

屬性
kAction_ApplicationManaged

允許應用程式管理軟體更新的其餘階段,例如下載、映像檔完整性驗證及安裝。

軟體更新管理員狀態機器將進入 ApplicationManaged 狀態。排定的軟體更新檢查 (如果啟用) 會暫停,直到應用程式呼叫 Abort 或 ImageInstallComplete API。

kAction_DownloadLater

開始時暫停下載。

已排定的軟體更新檢查 (如果啟用) 將會暫停。狀態機器將維持「下載」狀態。準備就緒後,應用程式可以呼叫 Resume Download API 繼續下載,或呼叫 取消 以取消。

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
)

CheckNow

WEAVE_ERROR CheckNow(
  void
)

GetState

State GetState(
  void
)

ImageInstallComplete

WEAVE_ERROR ImageInstallComplete(
  WEAVE_ERROR aError
)

IsInProgress

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

 SoftwareUpdateManager()=default

SoftwareUpdateManager

 SoftwareUpdateManager(
  const SoftwareUpdateManager &
)=delete

SoftwareUpdateManager

 SoftwareUpdateManager(
  const SoftwareUpdateManager &&
)=delete

運算子=

SoftwareUpdateManager & operator=(
  const SoftwareUpdateManager &
)=delete

~SoftwareUpdateManager

 ~SoftwareUpdateManager()=default