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
|
/*
* 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.
*/
/**
* @oma_ds_protocol_binder.h
* @version 0.1
* @brief This file is the header file of interface of protocol binder
*/
#ifndef OMA_DS_PROTOCOL_BINDER_H_
#define OMA_DS_PROTOCOL_BINDER_H_
#include <sync_agent.h>
#include "service-adapter/protocol-binder/oma_ds_protocol_binder_definition.h"
/**
* @par Description: API to Initialize protocol binder function set
*
*
* @par Purpose:
* @par Typical use case:
* @par Method of function operation:
* @par Important notes:
* @param[in] sync_agent_pb_protocol_binder_function_set_s structure
* @param[out]
*
* @return sync_agent_pb_error_e type
*
* @par Errors:
*
* @pre None.
* @post
* @see
* @remarks None.
*
* @par Sample Code:
* @code
* @endcode
*/
sync_agent_pb_error_e init_oma_ds_1_2_binder_function_set(sync_agent_pb_protocol_binder_function_set_s ** binder_function_set);
/**
* @par Description: API to free sync_agent_pb_protocol_binder_function_set_s structure
*
*
* @par Purpose:
* @par Typical use case:
* @par Method of function operation:
* @par Important notes:
* @param[in] sync_agent_pb_protocol_binder_function_set_s structure
* @param[out]
*
* @return
*
* @par Errors:
*
* @pre None.
* @post
* @see
* @remarks None.
*
* @par Sample Code:
* @code
* @endcode
*/
void free_oma_ds_1_2_binder_function_set(sync_agent_pb_protocol_binder_function_set_s * binder_function_set);
/**
* @par Description: API to Initialize protocol binder
*
*
* @par Purpose:
* @par Typical use case:
* @par Method of function operation:
* @par Important notes:
* @param[in] sync_agent_pb_protocol_binder_info_s structure
* @param[in] enum type, sync_agent_pb_encoding_e(SYNC_AGENT_PB_ENCODING_XML, SYNC_AGENT_PB_ENCODING_WBXML_10, SYNC_AGENT_PB_ENCODING_WBXML_11, SYNC_AGENT_PB_ENCODING_WBXML_12, SYNC_AGENT_PB_ENCODING_WBXML_13)
* @param[in] boolean type, whether encode xml header or not
* @param[in] boolean type, whether use string table or not
* @param[in] boolean type, whether protocol is anonymous or not
* @param[in] boolean type, whether use flow mode or not
* @param[in] boolean type, whether use textual public id or not
* @param[in] sync_agent_pb_protocol_binder_function_set_s structure
* @param[out]
*
* @return sync_agent_pb_protocol_binder_info_s on success
* NULL on error
*
* @par Errors:
*
* @pre None.
* @post
* @see
* @remarks None.
*
* @par Sample Code:
* @code
* @endcode
*/
sync_agent_pb_protocol_binder_info_s *oma_ds_1_2_binder_init(sync_agent_pb_protocol_binder_info_s * binder, sync_agent_pb_encoding_e enc, bool encode_xml_header,
bool use_strtbl, bool produce_anonymous, bool use_flow_mode, bool text_public_id, sync_agent_pb_protocol_binder_function_set_s * binder_function_set);
/**
* @par Description: API to append specific element to WBXML tree
*
*
* @par Purpose:
* @par Typical use case:
* @par Method of function operation:
* @par Important notes:
* @param[in] sync_agent_pb_protocol_binder_info_s structure
* @param[in] enum type, protocol element
* @param[in] content(structure to append)
* @param[out]
*
* @return SYNC_AGENT_PB_RETURN_OK on success
* others on error
*
* @par Errors:
*
* @pre None.
* @post
* @see
* @remarks None.
*
* @par Sample Code:
* @code
* @endcode
*/
sync_agent_pb_error_e oma_ds_1_2_binder_append(sync_agent_pb_protocol_binder_info_s * binder, oma_ds_protocol_element_e protocol_element, Content_Ptr content);
/**
* @par Description: API to terminate sync_agent_pb_protocol_binder_info_s structure
*
*
* @par Purpose:
* @par Typical use case:
* @par Method of function operation:
* @par Important notes:
* @param[in] sync_agent_pb_protocol_binder_info_s structure
* @param[out]
*
* @return
*
* @par Errors:
*
* @pre None.
* @post
* @see
* @remarks None.
*
* @par Sample Code:
* @code
* @endcode
*/
void oma_ds_1_2_binder_terminate(sync_agent_pb_protocol_binder_info_s * binder);
/**
* @par Description: API to get stream
*
*
* @par Purpose:
* @par Typical use case:
* @par Method of function operation:
* @par Important notes:
* @param[in] sync_agent_pb_protocol_binder_info_s structure
* @param[out] string type, stream from WBXML tree
* @param[out] unsigned int type, size of stream
*
* @return SYNC_AGENT_PB_RETURN_OK on success
* others on error
*
* @par Errors:
*
* @pre None.
* @post
* @see
* @remarks None.
*
* @par Sample Code:
* @code
* @endcode
*/
sync_agent_pb_error_e oma_ds_1_2_binder_get_stream(sync_agent_pb_protocol_binder_info_s * binder, char **byte_stream, unsigned int *byte_stream_size);
/**
* @par Description: API to get stream size
*
*
* @par Purpose:
* @par Typical use case:
* @par Method of function operation:
* @par Important notes:
* @param[in] sync_agent_pb_protocol_binder_info_s structure
* @param[out] unsigned int type, size of stream
*
* @return SYNC_AGENT_PB_RETURN_OK on success
* others on error
*
* @par Errors:
*
* @pre None.
* @post
* @see
* @remarks None.
*
* @par Sample Code:
* @code
* @endcode
*/
sync_agent_pb_error_e oma_ds_1_2_binder_get_stream_size(sync_agent_pb_protocol_binder_info_s * binder, unsigned int *byte_stream_size);
/**
* @par Description: API to get encoding type
*
*
* @par Purpose:
* @par Typical use case:
* @par Method of function operation:
* @par Important notes:
* @param[in] sync_agent_pb_protocol_binder_info_s structure
* @param[out] enum type, sync_agent_pb_encoding_e(SYNC_AGENT_PB_ENCODING_XML, SYNC_AGENT_PB_ENCODING_WBXML_10, SYNC_AGENT_PB_ENCODING_WBXML_11, SYNC_AGENT_PB_ENCODING_WBXML_12, SYNC_AGENT_PB_ENCODING_WBXML_13)
*
* @return SYNC_AGENT_PB_RETURN_OK on success
* others on error
*
* @par Errors:
*
* @pre None.
* @post
* @see
* @remarks None.
*
* @par Sample Code:
* @code
* @endcode
*/
sync_agent_pb_error_e oma_ds_1_2_binder_get_encoding(sync_agent_pb_protocol_binder_info_s * binder, sync_agent_pb_encoding_e * enc);
/**
* @par Description: API to Initialize reverse protocol binder
*
*
* @par Purpose:
* @par Typical use case:
* @par Method of function operation:
* @par Important notes:
* @param[in] string type, WBXML stream to parse
* @param[in] unsigned int type, size of stream
* @param[in] enum type, decoding(SYNC_AGENT_PB_DECODING_XML, SYNC_AGENT_PB_DECODING_WBXML)
* @param[in] user data
* @param[out] sync_agent_pb_protocol_binder_reverse_info_s structure
*
* @return SYNC_AGENT_PB_RETURN_OK on success
* others on error
*
* @par Errors:
*
* @pre None.
* @post
* @see
* @remarks None.
*
* @par Sample Code:
* @code
* @endcode
*/
sync_agent_pb_error_e reverse_oma_ds_1_2_binder_init(char *byte_stream,
unsigned int byte_stream_len, sync_agent_pb_decoding_e dec, sync_agent_pb_protocol_binder_function_set_s * binder_function_set, void *user_data, sync_agent_pb_protocol_binder_reverse_info_s ** binder);
/**
* @par Description: API to parse and get next contents
*
*
* @par Purpose:
* @par Typical use case:
* @par Method of function operation:
* @par Important notes:
* @param[in] sync_agent_pb_protocol_binder_reverse_info_s structure
* @param[out] protocol element
* @param[out] string type, protocol element
* @param[out] parsed contents(defined structure)
*
* @return SYNC_AGENT_PB_RETURN_OK on success
* others on error
*
* @par Errors:
*
* @pre None.
* @post
* @see
* @remarks None.
*
* @par Sample Code:
* @code
* @endcode
*/
sync_agent_pb_error_e reverse_oma_ds_1_2_binder_next(sync_agent_pb_protocol_binder_reverse_info_s * binder, Protocol_Element * protocol_element, char **protocol_element_name, Content_Ptr * content);
#endif /* OMA_DS_PROTOCOL_BINDER_H_ */
|
