1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
|
/*
* oma-dm-agent
* Copyright (c) 2012 Samsung Electronics Co., Ltd.
*
* Licensed under the Apache License, Version 2.0 (the License);
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
#ifndef FW_DOWNLOADER_H_
#define FW_DOWNLOADER_H_
/*dm-agent*/
#include "common/dm_error.h"
#include "dm-engine/dl-manager/dd_object.h"
typedef enum {
EXIST_PARTIAL_FILE = 1,
EXIST_COMPLETED_FILE,
NOT_EXIST_FILE
} DOWNLOAD_FILE_STATUS;
typedef struct {
int current_data_size;
int total_data_size;
char *file_path;
} Data_Resume_Infomation;
/**
* @par Description: API to get object information from dd_server_uri
*
*
* @par Purpose:
* @par Typical use case:
* @par par Method of function operation:
* @par Important notes:
* @param[in] dd_server_uri dd server uri
* @param[out] download_descriptor download_descriptor
* @param[out] dd_object_information dd object information
*
* @return DM_OK
* DM_ERROR
*
* @par Errors:
*
* @pre None.
* @post
* @see
* @remarks None.
*
* @par Sample Code:
* @code
* @endcode
*/
DM_ERROR get_object_information(char *dd_server_uri, int *file_size, Download_Descriptor ** download_descriptor, DM_ERROR * download_status);
/**
* @par Description: API to check file resume
*
*
* @par Purpose:
* @par Typical use case:
* @par par Method of function operation:
* @par Important notes:
* @param[in] checked_download_folder folder path
* @param[in] download_descriptor download_descriptor
* @param[out] file_status file status
*
* @return DM_OK
* DM_ERROR
*
* @par Errors:
*
* @pre None.
* @post
* @see
* @remarks None.
*
* @par Sample Code:
* @code
* @endcode
*/
DM_ERROR check_file_resume(const char *checked_download_folder, DOWNLOAD_FILE_STATUS * file_status, Download_Descriptor * download_descriptor, Data_Resume_Infomation ** data_resume_info);
/**
* @par Description: API to download object for object path
*
*
* @par Purpose:
* @par Typical use case:
* @par par Method of function operation:
* @par Important notes:
* @param[in] download_folder downloaded folder path
* @parma[in] config wifi config
* @param[in] download_descriptor download_descriptor
* @param[out] object_downloaded_path downloaded file path
*
*
* @return DM_OK
* DM_ERROR
*
* @par Errors:
*
* @pre None.
* @post
* @see
* @remarks None.
*
* @par Sample Code:
* @code
* @endcode
*/
DM_ERROR download_object(const char *download_folder, char **object_downloaded_path, Data_Resume_Infomation * data_resume_info, int config, Download_Descriptor * download_descriptor, DM_ERROR * downoad_status);
/**
* @par Description: API to send download status to server
*
*
* @par Purpose:
* @par Typical use case:
* @par par Method of function operation:
* @par Important notes:
* @param[in] download_status DM_ERROR
* @param[in] download_descriptor download_descriptor
*
* @return DM_OK
* DM_ERROR
*
* @par Errors:
*
* @pre None.
* @post
* @see
* @remarks None.
*
* @par Sample Code:
* @code
* @endcode
*/
DM_ERROR send_donwload_status(DM_ERROR download_status, Download_Descriptor * download_descriptor);
/**
* @par Description: API to free download descriptor
*
*
* @par Purpose:
* @par Typical use case:
* @par par Method of function operation:
* @par Important notes:
* @param[in] download_descriptor download_descriptor
*
* @return
*
* @par Errors:
*
* @pre None.
* @post
* @see
* @remarks None.
*
* @par Sample Code:
* @code
* @endcode
*/
void free_Download_Descriptor(Download_Descriptor ** download_descriptor);
#endif /* FW_DOWNLOADER_H_ */
|
