le_update_interface.h

Go to the documentation of this file.

/*
 * ====================== WARNING ======================
 *
 * THE CONTENTS OF THIS FILE HAVE BEEN AUTO-GENERATED.
 * DO NOT MODIFY IN ANY WAY.
 *
 * ====================== WARNING ======================
 */

#ifndef LE_UPDATE_INTERFACE_H_INCLUDE_GUARD
#define LE_UPDATE_INTERFACE_H_INCLUDE_GUARD


#include "legato.h"

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
void le_update_ConnectService
(
    void
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
void le_update_DisconnectService
(
    void
);


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
typedef struct le_update_Handle* le_update_HandleRef_t;


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
#define LE_UPDATE_ID_STR_LEN 64


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
typedef enum
{
    LE_UPDATE_CMD_INSTALL,

    LE_UPDATE_CMD_REMOVE
}
le_update_Command_t;


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
typedef enum
{
    LE_UPDATE_APP,

    LE_UPDATE_FIRMWARE
}
le_update_ItemType_t;


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
typedef enum
{
    LE_UPDATE_STATE_NEW,

    LE_UPDATE_STATE_UNPACKING,

    LE_UPDATE_STATE_APPLYING,

    LE_UPDATE_STATE_SUCCESS,

    LE_UPDATE_STATE_FAILED
}
le_update_State_t;


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
typedef enum
{
    LE_UPDATE_ERR_NONE,

    LE_UPDATE_ERR_BAD_MANIFEST,

    LE_UPDATE_ERR_IO_ERROR,

    LE_UPDATE_ERR_INTERNAL_ERROR,

    LE_UPDATE_ERR_OUT_OF_MEMORY,

    LE_UPDATE_ERR_VERSION_MISMATCH,

    LE_UPDATE_ERR_WRONG_TARGET
}
le_update_ErrorCode_t;


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
typedef struct le_update_ProgressHandler* le_update_ProgressHandlerRef_t;


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
typedef void (*le_update_ProgressHandlerFunc_t)
(
    le_update_State_t updateState,
    uint percentDone,
    void* contextPtr
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_update_HandleRef_t le_update_Create
(
    int fileDesc
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t le_update_Start
(
    le_update_HandleRef_t handle
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
void le_update_Delete
(
    le_update_HandleRef_t handle
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_update_ErrorCode_t le_update_GetErrorCode
(
    le_update_HandleRef_t handle
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_update_ProgressHandlerRef_t le_update_AddProgressHandler
(
    le_update_HandleRef_t handle,

    le_update_ProgressHandlerFunc_t handlerPtr,

    void* contextPtr
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
void le_update_RemoveProgressHandler
(
    le_update_ProgressHandlerRef_t addHandlerRef
);


#endif // LE_UPDATE_INTERFACE_H_INCLUDE_GUARD