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
|
/*
* oma-ds-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.
*/
/**
* @SA_Session.h
* @version 0.1
* @brief This file is the header file of interface of Session structure
*/
#ifndef SA_SESSION_H_
#define SA_SESSION_H_
#include "service-adapter/sa_define.h"
/**
* @par Description: API to create session_s structure
* This API can be used to create session_s 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_DS)
* @param[in] int type, account id
* @param[in] int type, session id
* @param[in] string type, source uri(server ip)
* @param[in] string type, target uri(client identifer)
* @param[out] session_s structure
*
* @return ERROR_INTERNAL_OK on success
* ERROR_INTERNAL_NO_MEMORY on error
*
* @par Errors:
*
* @pre None.
* @post
* @see
* @remarks None.
*
* @par Sample Code:
* @code
* @endcode
*/
sa_error_type_e create_session(protocol_version_e protocol_version, protocol_type_e protocol_type, int account_id, char *sess_id, location_s * source_location, location_s * target_location, session_s ** session);
/**
* @par Description: API to free session_s structure
* This API can be used to free session_s structure
*
* @par Purpose:
* @par Typical use case:
* @par Method of function operation:
* @par Important notes:
* @param[in] session_s structure
*
* @return
*
* @par Errors:
*
* @pre None.
* @post
* @see
* @remarks None.
*
* @par Sample Code:
* @code
* @endcode
*/
void free_session(session_s * session);
/**
* @par Description: API to set cred_s structure in session_s structure
* This API can be used to set cred_s structure in session_s structure
*
* @par Purpose:
* @par Typical use case:
* @par Method of function operation:
* @par Important notes:
* @param[in] session_s structure
* @param[in] cred_s structure
*
* @return
*
* @par Errors:
*
* @pre None.
* @post
* @see
* @remarks None.
*
* @par Sample Code:
* @code
* @endcode
*/
void set_session_cred(session_s * session, cred_s * cred);
/**
* @par Description: API to set devinf_s structure in session_s structure
* This API can be used to set devinf_s structure in session_s structure
*
* @par Purpose:
* @par Typical use case:
* @par Method of function operation:
* @par Important notes:
* @param[in] session_s structure
* @param[in] devinf_s structure
*
* @return
*
* @par Errors:
*
* @pre None.
* @post
* @see
* @remarks None.
*
* @par Sample Code:
* @code
* @endcode
*/
void set_session_devinf(session_s * session, devinf_s * devInf);
/**
* @par Description: API to create command_status_s structure
* This API can be used to set devinf_s structure in session_s structure
*
* @par Purpose:
* @par Typical use case:
* @par Method of function operation:
* @par Important notes:
* @param[in] unsigned int type, msg id
* @param[in] unsigned int type, cmd id
* @param[out] command_status_s structure
*
* @return ERROR_INTERNAL_OK on success
* ERROR_INTERNAL_NO_MEMORY on error
* @par Errors:
*
* @pre None.
* @post
* @see
* @remarks None.
*
* @par Sample Code:
* @code
* @endcode
*/
sa_error_type_e create_command_status(unsigned int msg_id, unsigned int cmdID, command_status_s ** command_status);
/**
* @par Description: API to process sync_hdr_s structure from server
* This API manage responseURI
* set server info in session_s structure
* check header credential
* create Status structure for header
*
* @par Purpose:
* @par Typical use case:
* @par Method of function operation:
* @par Important notes:
* @param[in] session_s structure
* @param[in] sync_hdr_s structure
*
* @return ERROR_INTERNAL_OK on success
* ERROR_INTERNAL_NO_MEMORY on error
* @par Errors:
*
* @pre None.
* @post
* @see
* @remarks None.
*
* @par Sample Code:
* @code
* @endcode
*/
sa_error_type_e receive_header(session_s * session, sync_hdr_s * header);
/**
* @par Description: API to process list of status_s structure from server
* This API check credential status
* process Status structure for each type
* create AppliedStatus structure for passing to ServiceEngine
*
* @par Purpose:
* @par Typical use case:
* @par Method of function operation:
* @par Important notes:
* @param[in] session_s structure
* @param[in] GList type, list of status_s structure
* @param[out] GList type, list of applied_status_s structure
*
* @return ERROR_INTERNAL_OK on success
* ERROR_INTERNAL_ERROR, ERROR_SERVER_FAILURE, ERROR_INTERNAL_BUSY_SIGNALING on error
* @par Errors:
*
* @pre None.
* @post
* @see
* @remarks None.
*
* @par Sample Code:
* @code
* @endcode
*/
sa_error_type_e receive_statuses(session_s * session, GList * receive_status, GList ** return_status);
/**
* @par Description: API to process list of command_s structure from server
* This API check credential status
* process command_ structure for each type
* create changed_datastore_s structure for passing to ServiceEngine
*
* @par Purpose:
* @par Typical use case:
* @par Method of function operation:
* @par Important notes:
* @param[in] session structure
* @param[in] GList type, list of command_s structure
* @param[in] whether auto configure or not
* @param[out] GList type, list of changed_datastore_s structure
*
* @return ERROR_INTERNAL_OK on success
* ERROR_INTERNAL_ERROR, ERROR_INTERNAL_NO_MEMORY, ERROR_INTERNAL_NOT_DEFINED on error
* @par Errors:
*
* @pre None.
* @post
* @see
* @remarks None.
*
* @par Sample Code:
* @code
* @endcode
*/
sa_error_type_e receive_commands(session_s * session, GList * receive_command, bool auto_config, GList ** return_datastore);
/**
* @par Description: API to reset cmd id(1) in session
*
* @par Purpose:
* @par Typical use case:
* @par Method of function operation:
* @par Important notes:
* @param[in] session_s structure
*
* @return
*
* @par Errors:
*
* @pre None.
* @post
* @see
* @remarks None.
*
* @par Sample Code:
* @code
* @endcode
*/
void reset_cmd_id_session(session_s * session);
#endif /* SE_SESSION_H_ */
|
