nl:: Weave:: DeviceLayer:: SoftwareUpdateManager
Resumo
Herança
Subclasses conhecidas:nl::Weave::DeviceLayer::SoftwareUpdateManagerImpl
nl::Weave::DeviceLayer::SoftwareUpdateManagerImpl
nl::Weave::DeviceLayer::SoftwareUpdateManagerImpl
Tipos públicos |
|
---|---|
ActionType{
|
tipo enumerado Quando uma atualização de software está disponível, o aplicativo pode escolher uma das seguintes ações como parte do retorno de chamada de evento da API SoftwareUpdateAvailable. |
EventCallback)(void *apAppState, EventType aEvent, const InEventParam &aInParam, OutEventParam &aOutParam)
|
typedefvoid(*
|
EventType{
|
tipo enumerado Eventos da API gerados pelo objeto SoftwareUpdateManager . |
RetryPolicyCallback)(void *aAppState, RetryParam &aRetryParam, uint32_t &aOutIntervalMsec)
|
typedefvoid(*
|
State
|
tipo enumerado |
Aulas de amizade |
|
---|---|
Internal::GenericPlatformManagerImpl
|
friend class
|
Funções públicas |
|
---|---|
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
|
Funções estáticas públicas |
|
---|---|
DefaultEventHandler(void *apAppState, EventType aEvent, const InEventParam & aInParam, OutEventParam & aOutParam)
|
void
|
Funções protegidas |
|
---|---|
SoftwareUpdateManager()=default
|
|
SoftwareUpdateManager(const SoftwareUpdateManager &)=delete
|
|
SoftwareUpdateManager(const SoftwareUpdateManager &&)=delete
|
|
operator=(const SoftwareUpdateManager &)=delete
|
|
~SoftwareUpdateManager()=default
|
|
Estruturas |
|
---|---|
nl:: |
Sindicatos |
|
---|---|
nl:: |
|
nl:: |
Tipos públicos
Tipo de ação
ActionType
Quando uma atualização de software está disponível, o aplicativo pode escolher uma das seguintes ações como parte do retorno de chamada de evento da API SoftwareUpdateAvailable.
A ação padrão será definida como kAction_Now.
Propriedades | |
---|---|
kAction_ApplicationManaged
|
Permite que o app gerencie o restante das fases de atualização de software, como download, validação de integridade da imagem e instalação. A máquina de estado do gerenciador de atualizações de software passará para o estado ApplicationManaged. As verificações de atualização de software programadas (se ativadas) serão suspensas até que o app chame a API Abort ou ImageInstallComplete. |
kAction_DownloadLater
|
Pausar o download ao iniciar. As verificações de atualização de software programadas (se ativadas) serão suspensas. A máquina de estado permanecerá no estado de download. Quando estiver tudo pronto, o aplicativo poderá chamar a API de download do currículo para prosseguir com o download ou chamar o cancelamento para cancelar. |
kAction_DownloadNow
|
Inicie o download imediatamente. Um callback de evento da API kEvent_FetchPartialImageInfo será gerado logo depois. |
kAction_Ignore
|
Ignore o download completamente. Um retorno de chamada de evento de API kEvent_finish será gerado com o erro WEAVE_DEVICE_ERROR_SOFTWARE_UPDATE_CANCELLED se essa opção for selecionada e a lógica de nova tentativa não será invocada. |
Callback de evento
void(* EventCallback)(void *apAppState, EventType aEvent, const InEventParam &aInParam, OutEventParam &aOutParam)
EventType
EventType
Eventos da API gerados pelo objeto SoftwareUpdateManager
.
Propriedades | |
---|---|
kEvent_ComputeImageIntegrity
|
Calcular um valor de verificação de integridade da imagem. Solicita que o aplicativo calcule um valor de verificação de integridade sobre a imagem salva. Gerado após a conclusão do download. |
kEvent_DefaultCheck
|
Verifique o comportamento padrão de manipulação de eventos. Usado para verificar o gerenciamento correto de eventos padrão no aplicativo. Os aplicativos NÃO podem manipular este evento. |
kEvent_FetchPartialImageInfo
|
Busca informações de estado permanente para uma imagem parcialmente transferida. Oferece uma oportunidade para o aplicativo divulgar informações de uma imagem parcial salva anteriormente, para que o download possa continuar a partir do ponto em que foi interrompido pela última vez. O URI da atualização de software disponível é fornecido como um parâmetro de entrada que o aplicativo pode usar para comparar se a imagem que está sendo transferida por download é igual à imagem parcial. Espera-se que o aplicativo retorne o tamanho da imagem parcial no parâmetro de saída PartialImageLenInBytes. O aplicativo pode definir o valor de PartialImageLenInBytes como 0 para indicar que não existe nenhuma imagem parcial ou que o URI da imagem parcial não corresponde. O aplicativo pode ignorar esse evento passando-o para o manipulador de eventos padrão. Se isso for feito, o sistema sempre fará o download de toda a imagem do firmware disponível. |
kEvent_Finished
|
Processo de atualização de software concluído. Gerado quando uma verificação de atualização de software é concluída com ou sem erros. Os parâmetros incluídos nesse evento fornecem o motivo da falha se a tentativa foi concluída devido a uma falha. |
kEvent_PrepareImageStorage
|
Prepare-se para armazenar uma nova imagem. Solicita que o aplicativo execute as etapas necessárias para preparar o armazenamento local para o download de uma nova imagem de firmware. O app pode usar isso, por exemplo, para apagar páginas em Flash. O evento PrepareImageStorage é gerado apenas no caso em que uma nova imagem de firmware está sendo transferida por download. Quando um download interrompido é retomado, PrepareImageStorage não é gerado. O aplicativo precisa sinalizar a conclusão da operação de preparação chamando o método O aplicativo pode ignorar o evento PrepareImageStorage passando-o para o manipulador de eventos padrão. Se isso for feito, o sistema irá automaticamente para o estado de download da imagem. Para oferecer suporte à retomada de um download interrompido, o aplicativo deve manter o URI da imagem (fornecido como um parâmetro de evento) e usá-lo ao processar eventos FetchPartialImageInfo subsequentes. |
kEvent_PrepareQuery
|
Prepare a mensagem ImageQuery. Gerado quando uma verificação de atualização de software é acionada. Permite que o app forneça informações relacionadas ao produto para a mensagem SofwareUpdate:ImageQuery. |
kEvent_PrepareQuery_Metadata
|
Preparar metadados para a solicitação ImageQuery. Oferece uma oportunidade para o aplicativo anexar metadados adicionais à mensagem SofwareUpdate:ImageQuery, se necessário. Gerado quando a implementação está pronta para receber metadados do aplicativo. |
kEvent_QueryPrepareFailed
|
Erro ao preparar uma solicitação de ImageQuery. Gerado quando a implementação encontra um erro durante a preparação para enviar uma consulta de atualização de software. |
kEvent_QuerySent
|
A solicitação de ImageQuery foi enviada. Evento informativo para sinalizar que uma mensagem SofwareUpdate:ImageQuery foi enviada. |
kEvent_ReadyToInstall
|
A imagem está pronta para ser instalada. Evento informativo para sinalizar que a imagem está pronta para ser instalada. Gerado quando uma imagem é aprovada na verificação de integridade. |
kEvent_ResetPartialImageInfo
|
Redefine o estado da imagem parcialmente transferida. Solicita que o aplicativo esqueça o estado persistido associado a uma imagem salva. Um evento ResetPartialImageInfo é gerado sempre que uma imagem baixada falha em sua verificação de integridade. Depois que um evento "ResetPartialImageInfo" tiver sido processado, os eventos "FetchPartialImageInfo" seguintes devem indicar que nenhuma imagem parcial está disponível. Observe que, ao processar o evento ResetPartialImageInfo, o aplicativo NÃO é obrigado a limpar os dados da imagem, apenas as informações de estado associadas à imagem (ou seja, o URI e o comprimento parcial da imagem). Se o aplicativo não oferece suporte à retomada de download da imagem, ele pode ignorar esse evento passando-o para o manipulador de eventos padrão. |
kEvent_SoftwareUpdateAvailable
|
Atualização do software disponível. Gerado quando um SofwareUpdate:ImageQueryResponse é recebido em resposta a uma consulta contendo informações da atualização disponível. |
kEvent_StartImageDownload
|
O download da imagem começou. Evento informativo para sinalizar o início de uma transação de download de imagem. |
kEvent_StartInstallImage
|
Iniciar a instalação da imagem. Solicita que o aplicativo seja o processo de instalação de uma imagem de firmware salva. |
kEvent_StoreImageBlock
|
Armazene um bloco de dados de imagem. Gerado sempre que um bloco de dados é recebido do servidor de download de arquivos. Os parâmetros incluídos neste evento fornecem os dados e o tamanho deles. Para oferecer suporte à retomada de um download interrompido, o aplicativo deve manter uma contagem permanente do número total de bytes de imagem armazenados e usar esse valor ao processar eventos FetchPartialImageInfo subsequentes. |
RepeatPolicyCallback
void(* RetryPolicyCallback)(void *aAppState, RetryParam &aRetryParam, uint32_t &aOutIntervalMsec)
Estado
State
Aulas de amizade
Interno::GenericPlatformManagerImpl
friend class Internal::GenericPlatformManagerImpl
Funções públicas
Cancelar
WEAVE_ERROR Abort( void )
Verificar agora
WEAVE_ERROR CheckNow( void )
GetState (link em inglês)
State GetState( void )
ImageInstallComplete
WEAVE_ERROR ImageInstallComplete( WEAVE_ERROR aError )
Em andamento
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 )
SetRepeatPolicyCallback
void SetRetryPolicyCallback( const RetryPolicyCallback aRetryPolicyCallback )
Funções estáticas públicas
Gerenciador de eventos padrão
void DefaultEventHandler( void *apAppState, EventType aEvent, const InEventParam & aInParam, OutEventParam & aOutParam )
Funções protegidas
SoftwareUpdateManager.
SoftwareUpdateManager()=default
SoftwareUpdateManager.
SoftwareUpdateManager( const SoftwareUpdateManager & )=delete
SoftwareUpdateManager.
SoftwareUpdateManager( const SoftwareUpdateManager && )=delete
operador=
SoftwareUpdateManager & operator=( const SoftwareUpdateManager & )=delete
~SoftwareUpdateManager
~SoftwareUpdateManager()=default