utilities/downloadmanager/inc/dmcommon.h
author hgs
Fri, 15 Oct 2010 17:30:59 -0400
changeset 16 3c88a81ff781
permissions -rw-r--r--
201041
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
16
hgs
parents:
diff changeset
     1
/**
hgs
parents:
diff changeset
     2
   This file is part of CWRT package **
hgs
parents:
diff changeset
     3
hgs
parents:
diff changeset
     4
   Copyright (C) 2009 Nokia Corporation and/or its subsidiary(-ies). **
hgs
parents:
diff changeset
     5
hgs
parents:
diff changeset
     6
   This program is free software: you can redistribute it and/or modify
hgs
parents:
diff changeset
     7
   it under the terms of the GNU (Lesser) General Public License as 
hgs
parents:
diff changeset
     8
   published by the Free Software Foundation, version 2.1 of the License. 
hgs
parents:
diff changeset
     9
   This program is distributed in the hope that it will be useful, but
hgs
parents:
diff changeset
    10
   WITHOUT ANY WARRANTY; without even the implied warranty of 
hgs
parents:
diff changeset
    11
   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 
hgs
parents:
diff changeset
    12
   (Lesser) General Public License for more details. You should have 
hgs
parents:
diff changeset
    13
   received a copy of the GNU (Lesser) General Public License along 
hgs
parents:
diff changeset
    14
   with this program. If not, see <http://www.gnu.org/licenses/>.
hgs
parents:
diff changeset
    15
*/
hgs
parents:
diff changeset
    16
hgs
parents:
diff changeset
    17
#ifndef DOWNLOAD_COMMON_H_
hgs
parents:
diff changeset
    18
#define DOWNLOAD_COMMON_H_
hgs
parents:
diff changeset
    19
hgs
parents:
diff changeset
    20
#define INVALID_DL_ID 0
hgs
parents:
diff changeset
    21
#define IPC_ERR_START_VALUE -5000
hgs
parents:
diff changeset
    22
hgs
parents:
diff changeset
    23
// download states
hgs
parents:
diff changeset
    24
enum DownloadState
hgs
parents:
diff changeset
    25
{
hgs
parents:
diff changeset
    26
    DlNone = 0,
hgs
parents:
diff changeset
    27
    DlCreated,
hgs
parents:
diff changeset
    28
    DlStarted,
hgs
parents:
diff changeset
    29
    DlInprogress,
hgs
parents:
diff changeset
    30
    DlPaused,
hgs
parents:
diff changeset
    31
    DlCompleted,
hgs
parents:
diff changeset
    32
    DlFailed,
hgs
parents:
diff changeset
    33
    DlCancelled,
hgs
parents:
diff changeset
    34
    DlDescriptorUpdated
hgs
parents:
diff changeset
    35
};
hgs
parents:
diff changeset
    36
hgs
parents:
diff changeset
    37
// download attributes
hgs
parents:
diff changeset
    38
enum DownloadAttribute
hgs
parents:
diff changeset
    39
{
hgs
parents:
diff changeset
    40
    /* general download attributes */
hgs
parents:
diff changeset
    41
    DlDestPath = 0,                  // destination path(set)
hgs
parents:
diff changeset
    42
    DlDownloadedSize,                // downloaded size(get)
hgs
parents:
diff changeset
    43
    DlTotalSize,                     // total size(get)
hgs
parents:
diff changeset
    44
    DlDownloadState,                 // download state(get)
hgs
parents:
diff changeset
    45
    DlFileName,                      // file name(set/get)
hgs
parents:
diff changeset
    46
    DlSourceUrl,                     // source url(get)
hgs
parents:
diff changeset
    47
    DlContentType,                   // content type(get)
hgs
parents:
diff changeset
    48
    DlLastError,                     // last error occured(get)
hgs
parents:
diff changeset
    49
    DlLastErrorString,               // last error string(get)
hgs
parents:
diff changeset
    50
    DlLastPausedSize,                // last download paused size(get)
hgs
parents:
diff changeset
    51
hgs
parents:
diff changeset
    52
    /* OMA Download Attributes */
hgs
parents:
diff changeset
    53
    OMADownloadDescriptorName,       // "name" in OMA dd
hgs
parents:
diff changeset
    54
    OMADownloadDescriptorVersion,    // "version" in OMA dd
hgs
parents:
diff changeset
    55
    OMADownloadDescriptorType,       // "type" in OMA dd
hgs
parents:
diff changeset
    56
    OMADownloadDescriptorSize,       // "size" in OMA dd
hgs
parents:
diff changeset
    57
    OMADownloadDescriptorVendor,     // "vendor" in OMA dd
hgs
parents:
diff changeset
    58
    OMADownloadDescriptorDescription,// "description" in OMA dd
hgs
parents:
diff changeset
    59
    OMADownloadDescriptorNextURL,    // "nextURL" in OMA dd
hgs
parents:
diff changeset
    60
hgs
parents:
diff changeset
    61
    DlDownloadType,                  // download type (get)
hgs
parents:
diff changeset
    62
    DlPriority,                      // download priority(set/get)
hgs
parents:
diff changeset
    63
    DlDownloadScope,                  // download scope i.e normal/background(get)
hgs
parents:
diff changeset
    64
hgs
parents:
diff changeset
    65
    DlStartTime,                      // download start/resumed time in QDateTime (get)
hgs
parents:
diff changeset
    66
    DlEndTime,                        // download end time in QDateTime if successfully completed (get)
hgs
parents:
diff changeset
    67
    DlElapsedTime,                    // time elapsed since the download started/resumed( in secs (get)
hgs
parents:
diff changeset
    68
    DlRemainingTime,                  // remaining time to download in secs(get)
hgs
parents:
diff changeset
    69
    DlSpeed,                          // speed of the download in Bytes/sec(get)
hgs
parents:
diff changeset
    70
    DlPercentage,                     // percentage of download(get)
hgs
parents:
diff changeset
    71
    DlProgressInterval                // KiloBytes at which progress event has to be sent(set/get)
hgs
parents:
diff changeset
    72
};
hgs
parents:
diff changeset
    73
hgs
parents:
diff changeset
    74
// download event attributes
hgs
parents:
diff changeset
    75
enum DownloadEventAttribute
hgs
parents:
diff changeset
    76
{
hgs
parents:
diff changeset
    77
    HeaderReceivedStatusCode = 0
hgs
parents:
diff changeset
    78
};
hgs
parents:
diff changeset
    79
hgs
parents:
diff changeset
    80
// download manager attributes
hgs
parents:
diff changeset
    81
enum DownloadManagerAttribute
hgs
parents:
diff changeset
    82
{
hgs
parents:
diff changeset
    83
    DlMgrDestPath = 0,     // destination path
hgs
parents:
diff changeset
    84
    DlMgrDlCount,          // total number of downloads
hgs
parents:
diff changeset
    85
    DlMgrClientName,       // client name
hgs
parents:
diff changeset
    86
    DlMgrServerError,      // last server error
hgs
parents:
diff changeset
    87
    DlMgrProgressMode,     // quiet/nonquiet
hgs
parents:
diff changeset
    88
    DlMgrPersistantMode    // Active/InActive
hgs
parents:
diff changeset
    89
};
hgs
parents:
diff changeset
    90
hgs
parents:
diff changeset
    91
// download manager event attributes
hgs
parents:
diff changeset
    92
enum DownloadManagerEventAttribute
hgs
parents:
diff changeset
    93
{
hgs
parents:
diff changeset
    94
};
hgs
parents:
diff changeset
    95
hgs
parents:
diff changeset
    96
// event types
hgs
parents:
diff changeset
    97
enum DEventType
hgs
parents:
diff changeset
    98
{
hgs
parents:
diff changeset
    99
    DownloadCreated = 2000,        // atleast one dowload exists - DownloadManager event
hgs
parents:
diff changeset
   100
    DownloadsCleared,              // no more downloads exist - DownloadManager event
hgs
parents:
diff changeset
   101
    ConnectedToServer,             // connected to download manager server
hgs
parents:
diff changeset
   102
    DisconnectedFromServer,        // disconnected from download manager server
hgs
parents:
diff changeset
   103
    ServerError,                   // server error - DownloadManager event
hgs
parents:
diff changeset
   104
    Started,                       // download started - Download event
hgs
parents:
diff changeset
   105
    HeaderReceived,                // download headers recieved - Download event
hgs
parents:
diff changeset
   106
    Progress,                      // download is in progress, bytes recieved - Download event
hgs
parents:
diff changeset
   107
    Completed,                     // download is completed - Download event
hgs
parents:
diff changeset
   108
    Paused,                        // download is paused - Download event
hgs
parents:
diff changeset
   109
    Cancelled,                     // download is cancelled - Download event
hgs
parents:
diff changeset
   110
    Failed,                        // download is failed - Download event
hgs
parents:
diff changeset
   111
    DescriptorUpdated,             // download is restarted - Download event
hgs
parents:
diff changeset
   112
    NetworkLoss,                   // Network is lost - Download event
hgs
parents:
diff changeset
   113
    Error,                         // error occurred during download - Download event
hgs
parents:
diff changeset
   114
    OMADownloadDescriptorReady,    // OMA DD recieved and ready to be displayed - Download event
hgs
parents:
diff changeset
   115
    WMDRMLicenseAcquiring          // License acquisition in progress for wmdrm
hgs
parents:
diff changeset
   116
};
hgs
parents:
diff changeset
   117
hgs
parents:
diff changeset
   118
// download manager type
hgs
parents:
diff changeset
   119
enum DownloadType
hgs
parents:
diff changeset
   120
{
hgs
parents:
diff changeset
   121
    Parallel = 0,
hgs
parents:
diff changeset
   122
    Sequential
hgs
parents:
diff changeset
   123
};
hgs
parents:
diff changeset
   124
hgs
parents:
diff changeset
   125
// Sequential Download Priority
hgs
parents:
diff changeset
   126
enum DownloadPriority
hgs
parents:
diff changeset
   127
{
hgs
parents:
diff changeset
   128
    High = 0,
hgs
parents:
diff changeset
   129
    Low
hgs
parents:
diff changeset
   130
};
hgs
parents:
diff changeset
   131
hgs
parents:
diff changeset
   132
// Download scope
hgs
parents:
diff changeset
   133
enum DownloadScope
hgs
parents:
diff changeset
   134
{
hgs
parents:
diff changeset
   135
    Normal = 0,
hgs
parents:
diff changeset
   136
    Background
hgs
parents:
diff changeset
   137
};
hgs
parents:
diff changeset
   138
hgs
parents:
diff changeset
   139
enum DownloadMgrProgressMode
hgs
parents:
diff changeset
   140
{
hgs
parents:
diff changeset
   141
    Quiet = 0,
hgs
parents:
diff changeset
   142
    NonQuiet
hgs
parents:
diff changeset
   143
};
hgs
parents:
diff changeset
   144
hgs
parents:
diff changeset
   145
enum DownloadMgrPersistantMode
hgs
parents:
diff changeset
   146
{
hgs
parents:
diff changeset
   147
    Active = 0,
hgs
parents:
diff changeset
   148
    InActive
hgs
parents:
diff changeset
   149
};
hgs
parents:
diff changeset
   150
hgs
parents:
diff changeset
   151
#endif /*DOWNLOAD_COMMON_H_ */