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
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
|
/*
* 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 SA_SESSION_H_
#define SA_SESSION_H_
/*dm-agent*/
#include "common/dm_error.h"
#include "serviceadapter/sa_define.h"
/**
* @par Description: API to create Session structure
* This API can be used to create Session structure
*
* @par Purpose:
* @par Typical use case:
* @par Method of function operation:
* @par Important notes:
* @param[in] enum type, protocol version(VERSION_UNKNOWN, VERSION_10, VERSION_11, VERSION_12);
* @param[in] enum type, protocol type(PROTOCOL_TYPE_UNKNOWN , PROTOCOL_TYPE_DM)
* @param[in] string type, server id
* @param[in] string type, client id
* @param[in] string type, session id
* @param[in] string type, source uri(server ip)
* @param[in] string type, target uri(client identifer)
* @param[out] Session structure
*
* @return DM_OK on success
* DM_ERROR on fail
*
* @par Errors:
*
* @pre None.
* @post
* @see
* @remarks None.
*
* @par Sample Code:
* @code
* @endcode
*/
DM_ERROR create_syncml_session(ProtocolVersion protocolVersion, ProtocolType protocolType, char *server_id, char *client_id, char *pSession_id, char *sourceUrl, char *targetUrl, Session ** pSession);
/**
* @par Description: API to free Session structure
*
*
* @par Purpose:
* @par Typical use case:
* @par Method of function operation:
* @par Important notes:
* @param[in] Session structure
*
* @return
*
*
* @par Errors:
*
* @pre None.
* @post
* @see
* @remarks None.
*
* @par Sample Code:
* @code
* @endcode
*/
void free_session(Session * session);
/**
* @par Description: API to receivce header
*
*
* @par Purpose:
* @par Typical use case:
* @par Method of function operation:
* @par Important notes:
* @param[in] Session structure
* @param[in] syncml header structure
*
* @return DM_OK on success
* DM_ERROR on fail
*
* @par Errors:
*
* @pre None.
* @post
* @see
* @remarks None.
*
* @par Sample Code:
* @code
* @endcode
*/
DM_ERROR receive_header(Session * session, SyncHdr * header);
/**
* @par Description: API to receivce header
*
*
* @par Purpose:
* @par Typical use case:
* @par Method of function operation:
* @par Important notes:
* @param[in] Session structure
* @param[in] receive status list
* @return DM_OK on success
* DM_ERROR on fail
*
* @par Errors:
*
* @pre None.
* @post
* @see
* @remarks None.
*
* @par Sample Code:
* @code
* @endcode
*/
DM_ERROR receive_statuses(Session * session, GList * receiveStatus);
/**
* @par Description: API to receivce command
*
*
* @par Purpose:
* @par Typical use case:
* @par Method of function operation:
* @par Important notes:
* @param[in] Session structure
* @param[in] receive command list
*
* @return DM_OK on success
* DM_ERROR on fail
*
* @par Errors:
*
* @pre None.
* @post
* @see
* @remarks None.
*
* @par Sample Code:
* @code
* @endcode
*/
DM_ERROR receive_cmd(Session * session, GList * receiveCommand);
/**
* @par Description: API to create prepending status
*
*
* @par Purpose:
* @par Typical use case:
* @par Method of function operation:
* @par Important notes:
* @param[in] int type, msg id
* @param[in] int type, command id
* @param[out] pending status structure
*
*
* @return DM_OK on success
* DM_ERROR on fail
*
* @par Errors:
*
* @pre None.
* @post
* @see
* @remarks None.
*
* @par Sample Code:
* @code
* @endcode
*/
DM_ERROR create_prependingstatus(unsigned int msgID, unsigned int cmdID, PendingStatus ** pPendingStatus);
/**
* @par Description: API to set auth cred
*
*
* @par Purpose:
* @par Typical use case:
* @par Method of function operation:
* @par Important notes:
* @param[in] session structure
* @param[in] cred structure
*
*
* @return DM_OK on success
* DM_ERROR on fail
*
* @par Errors:
*
* @pre None.
* @post
* @see
* @remarks None.
*
* @par Sample Code:
* @code
* @endcode
*/
DM_ERROR set_session_authcred(Session * session, Cred * cred);
/**
* @par Description: API to reset command id
*
*
* @par Purpose:
* @par Typical use case:
* @par Method of function operation:
* @par Important notes:
* @param[in] session structure
*
*
* @return
*
* @par Errors:
*
* @pre None.
* @post
* @see
* @remarks None.
*
* @par Sample Code:
* @code
* @endcode
*/
void reset_cmdid_session(Session * session);
/**
* @par Description: API to add response hmac info
*
*
* @par Purpose:
* @par Typical use case:
* @par Method of function operation:
* @par Important notes:
* @param[in] session structure
* @param[in] string type, temp hmac
*
*
* @return DM_OK on success
* DM_ERROR on fail
*
* @par Errors:
*
* @pre None.
* @post
* @see
* @remarks None.
*
* @par Sample Code:
* @code
* @endcode
*/
DM_ERROR add_response_hmacinfo(Session ** session, char *temp_hmac);
/*DM_ERROR get_session_clientauthtype(Session * session, AuthType * authType);
DM_ERROR get_session_serverauthtype(Session * session, AuthType * authType);*/
/**
* @par Description: API to get session authtype
*
*
* @par Purpose:
* @par Typical use case:
* @par Method of function operation:
* @par Important notes:
* @param[in] string type, auth data
*
*
* @return Auth type
*
*
* @par Errors:
*
* @pre None.
* @post
* @see
* @remarks None.
*
* @par Sample Code:
* @code
* @endcode
*/
AuthType __get_Session_AuthType_enum(char *data);
/**
* @par Description: API to get session authname
*
*
* @par Purpose:
* @par Typical use case:
* @par Method of function operation:
* @par Important notes:
* @param[in] enum type, Auth type
* @param[out] string type, auth name
*
* @return
*
*
* @par Errors:
*
* @pre None.
* @post
* @see
* @remarks None.
*
* @par Sample Code:
* @code
* @endcode
*/
void __set_Session_AuthType_name(AuthType authType, char **authname);
#endif /* SE_SESSION_H_ */
|
