vmhttps.h
12.7 KB
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
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
/*****************************************************************************
* Copyright Statement:
* --------------------
* This software is protected by Copyright and the information contained
* herein is confidential. The software may not be copied and the information
* contained herein may not be used or disclosed except with the written
* permission of MediaTek Inc. (C) 2005
*
* BY OPENING THIS FILE, BUYER HEREBY UNEQUIVOCALLY ACKNOWLEDGES AND AGREES
* THAT THE SOFTWARE/FIRMWARE AND ITS DOCUMENTATIONS ("MEDIATEK SOFTWARE")
* RECEIVED FROM MEDIATEK AND/OR ITS REPRESENTATIVES ARE PROVIDED TO BUYER ON
* AN "AS-IS" BASIS ONLY. MEDIATEK EXPRESSLY DISCLAIMS ANY AND ALL WARRANTIES,
* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE IMPLIED WARRANTIES OF
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE OR NONINFRINGEMENT.
* NEITHER DOES MEDIATEK PROVIDE ANY WARRANTY WHATSOEVER WITH RESPECT TO THE
* SOFTWARE OF ANY THIRD PARTY WHICH MAY BE USED BY, INCORPORATED IN, OR
* SUPPLIED WITH THE MEDIATEK SOFTWARE, AND BUYER AGREES TO LOOK ONLY TO SUCH
* THIRD PARTY FOR ANY WARRANTY CLAIM RELATING THERETO. MEDIATEK SHALL ALSO
* NOT BE RESPONSIBLE FOR ANY MEDIATEK SOFTWARE RELEASES MADE TO BUYER'S
* SPECIFICATION OR TO CONFORM TO A PARTICULAR STANDARD OR OPEN FORUM.
*
* BUYER'S SOLE AND EXCLUSIVE REMEDY AND MEDIATEK'S ENTIRE AND CUMULATIVE
* LIABILITY WITH RESPECT TO THE MEDIATEK SOFTWARE RELEASED HEREUNDER WILL BE,
* AT MEDIATEK'S OPTION, TO REVISE OR REPLACE THE MEDIATEK SOFTWARE AT ISSUE,
* OR REFUND ANY SOFTWARE LICENSE FEES OR SERVICE CHARGE PAID BY BUYER TO
* MEDIATEK FOR SUCH MEDIATEK SOFTWARE AT ISSUE.
*
* THE TRANSACTION CONTEMPLATED HEREUNDER SHALL BE CONSTRUED IN ACCORDANCE
* WITH THE LAWS OF THE STATE OF CALIFORNIA, USA, EXCLUDING ITS CONFLICT OF
* LAWS PRINCIPLES. ANY DISPUTES, CONTROVERSIES OR CLAIMS ARISING THEREOF AND
* RELATED THERETO SHALL BE SETTLED BY ARBITRATION IN SAN FRANCISCO, CA, UNDER
* THE RULES OF THE INTERNATIONAL CHAMBER OF COMMERCE (ICC).
*
*****************************************************************************/
/*****************************************************************************
*
* Filename:
* ---------
* SampleAppAgent.h
*
* Project:
* --------
* MAUI
*
* Description:
* ------------
* Adaptation for http/https services
*
* Author:
* -------
* -------
*
*============================================================================
* HISTORY
* Below this line, this part is controlled by PVCS VM. DO NOT MODIFY!!
*------------------------------------------------------------------------------
* removed!
* removed!
* removed!
*
* removed!
* removed!
* removed!
*
* removed!
* removed!
* removed!
*
* removed!
* removed!
* removed!
*
* removed!
* removed!
* removed!
*
* removed!
* removed!
* removed!
*
* removed!
* removed!
* removed!
*
* removed!
* removed!
* removed!
*
* removed!
* removed!
* removed!
*
*
*
*------------------------------------------------------------------------------
* Upper this line, this part is controlled by PVCS VM. DO NOT MODIFY!!
*============================================================================
****************************************************************************/
#ifndef VMHTTPS_H
#define VMHTTPS_H
#include "mmi_features.h"
#include "vmswitch.h"
#if defined(__MRE_SAL_WPS__)
#include "kal_non_specific_general_types.h"
#include "vmhttps_sdk.h"
/*************************************************************************
* Backup
************************************************************************/
void mre_https_init(void);
/*****************************************************************************
* FUNCTION
* mre_https_register_wps_cntxt_and_callback
* DESCRIPTION
* The application should(mandatory) register these wps context and callback function before requesting
* WPS for any service
* CALLS
*
* PARAMETERS
* src_mod_id [IN]
* RETURNS
* void
*****************************************************************************/
VMUINT8 mre_https_register_wps_cntxt_and_callback(
mre_wps_send_set_channel_rsp_cb set_channel_rsp_cb,
mre_wps_unset_channel_rsp_cb unset_channel_cb,
mre_wps_send_release_all_req_rsp_cb release_all_req_cb,
mre_wps_send_wps_termination_ind_cb terminal_ind_cb,
mre_wps_send_http_rsp_cb http_rsp_cb,
mre_wps_send_read_content_rsp_cb read_content_rsp_cb,
mre_wps_send_cancel_rsp_cb cancel_rsp_cb,
mre_wps_send_status_query_rsp_cb status_query_rsp_cb);
/*****************************************************************************
* FUNCTION
* mre_https_send_set_channel_req
*
* DESCRIPTION
* Configure a dedicated channel for HTTP/WSP requests. An channel can be
* configured to use proxy while use_proxy is true. When use_proxy is true,
* prx_ip, prx_port, username, and password will be used to communicate with
* proxy server, thus prx_ip must not be 0.0.0.0 and if prx_port value 0
* means use default proxy port 8080. When the conn_type is
* WPS_CONN_TYPE_WSP_CO or WPS_CONN_TYPE_WSP_CL, then use_proxy is true
* default. However, if application simply wants to use current activated
* setting used in WAP, then just set use_default as true and ignore all
* other parameters.
* Static_header (if necessary) must be filled in
* WAP_PROF_CONN_TYPE_WSP_CO and the first WSP request of some dedicated
* channel with connection type WSP_CONN_TYPE_WSP_CL. If application doesn't
* specify static_header, then WPS will use the value currently used by WAP.
*
* PARAMETERS
* src_mod_id [IN]
*
* RETURNS
* void
*****************************************************************************/
VMUINT8 mre_https_send_set_channel_req(
VMUINT16 req_id, /* Request ID */
VMUINT8 use_proxy, /* Use proxy or not */
VMUINT8 prx_ip[4], /* Proxy IP address */
VMUINT16 prx_port, /* Proxy port number. 0 means default proxy 8080. */
VMUINT8 *username, /* Username for the proxy. Only ASCII is allowed and NULL terminated. */
VMUINT8 username_len, /*length should not exceed 40 character excluding NULL character*/
VMUINT8 *password, /* Username for the proxy. Only ASCII is allowed and NULL terminated. */
VMUINT8 password_len, /*length should not exceed 40 character excluding NULL character*/
VMUINT8 *server_auth_username, /* Username for the origin server. Only ASCII is allowed and NULL terminated. */
VMUINT8 server_auth_username_len, /*length should not exceed 128 character excluding NULL character*/
VMUINT8 *server_auth_password, /* Password for the origin server. Only ASCII is allowed and NULL terminated. */
VMUINT8 server_auth_password_len, /*length should not exceed 40 character excluding NULL character*/
VMUINT32 static_header_len, /* The length of static header */
VMUINT8 *static_header /* static header */ );
/*****************************************************************************
* FUNCTION
* mre_https_send_unset_channel_req
* DESCRIPTION
* Remove a configured channel identified by channel ID.
* CALLS
*
* PARAMETERS
* src_mod_id [IN]
* unset_channel_req [?]
* RETURNS
* void
*****************************************************************************/
VMUINT8 mre_https_send_unset_channel_req(VMUINT8 channel_id );
/*****************************************************************************
* FUNCTION
* mre_https_send_req
* DESCRIPTION
* Send Http/https URL request
* CALLS
*
* PARAMETERS
channel_id, [IN] Channel ID
request_id, [IN] Request ID
method, [IN] HTTP Method Constant
option, [IN] HTTP request options
reply_type, [IN] Reply type (wps_data_type_enum)
The file path used to store replied content when reply_type is specified
as WPS_DATA_TYPE_FILE, WPS_DATA_TYPE_FILE_NO_PROG_IND or
WPS_DATA_TYPE_FILE_RESUME.
Max. buffer size that reading side suggests when reply_type is specified
as WPS_DATA_TYPE_BUFFER.
reply_segment_len, [IN]
request_url_len, [IN] The request URL length
*request_url, [IN] The request URL
request_header_len [IN] The request header length
*request_header, [IN] The request header
The post segment buffer length when post_type is specified as
WPS_DATA_TYPE_BUFFER. It is mandatory is method is POST/PUT and post_type
is WPS_DATA_TYPE_BUFFER.
post_segment_len, [IN]
*post_segment [IN]
* RETURNS
* void
*****************************************************************************/
VMUINT8 mre_https_send_req(
VMUINT8 channel_id, /* Channel ID */
VMUINT16 request_id, /* Request ID */
VMUINT8 method, /* HTTP Method Constant */
VMUINT32 option, /* HTTP request options */
VMUINT8 reply_type, /* Reply type (wps_data_type_enum) */
VMUINT32 reply_segment_len,
VMUINT32 request_url_len, /* The request URL length */
VMUINT8 *request_url, /* The request URL */
VMUINT32 request_header_len, /* The request header length */
VMUINT8 *request_header, /* The request header */
VMUINT32 post_segment_len,
VMUINT8 *post_segment );
/*****************************************************************************
* FUNCTION
* mre_https_send_read_content_req
* DESCRIPTION
* this function is to send request to continue to read HTTP/WSP reply content.
* CALLS
*
* PARAMETERS
* src_mod_id [IN]
* read_content_req [?]
* RETURNS
* void
*****************************************************************************/
VMUINT8 mre_https_send_read_content_req(
VMUINT8 channel_id, /* Channel ID */
VMUINT16 request_id,/* Request ID */
VMUINT8 seq_num, /* Sequence number (for debug purpose) */
/* The suggested segment data length of replied data in the peer buffer of
response. 0 means use reply_segment_len in MSG_ID_WPS_HTTP_REQ or
read_segment_length in previous request. */
VMUINT32 read_segnemtn_len);
/*****************************************************************************
* FUNCTION
* mre_https_send_cancel_req
* DESCRIPTION
* this function is to send a request to cancel an incomplete WSP/HTTP request.
* CALLS
*
* PARAMETERS
* src_mod_id [IN]
* cancel_req [?]
* RETURNS
* void
*****************************************************************************/
VMUINT8 mre_https_send_cancel_req(
VMUINT8 channel_id,
VMUINT16 request_id );
#else /* __MRE_SAL_WPS__ */
#define vm_https_is_supported NULL
#define vm_https_register_wps_cntxt_and_callback NULL
#define vm_https_send_set_channel_req NULL
#define vm_https_send_unset_channel_req NULL
#define vm_https_send_req NULL
#define vm_https_send_read_content_req NULL
#define vm_https_send_cancel_req NULL
#define mre_https_init NULL
#define mre_https_register_wps_cntxt_and_callback NULL
#define mre_https_send_set_channel_req NULL
#define mre_https_send_unset_channel_req NULL
#define mre_https_send_req NULL
#define mre_https_send_read_content_req NULL
#define mre_https_send_cancel_req NULL
#define vm_https_send_req_ext NULL
#define vm_https_send_post_content_res NULL
#endif /* __MRE_SAL_WPS__ */
#endif /* VMHTTPS_H */