Remove arduino support 3/3
[iotivity.git] / resource / csdk / connectivity / inc / caprotocolmessage.h
1 /******************************************************************
2  *
3  * Copyright 2014 Samsung Electronics All Rights Reserved.
4  *
5  *
6  *
7  * Licensed under the Apache License, Version 2.0 (the "License");
8  * you may not use this file except in compliance with the License.
9  * You may obtain a copy of the License at
10  *
11  *      http://www.apache.org/licenses/LICENSE-2.0
12  *
13  * Unless required by applicable law or agreed to in writing, software
14  * distributed under the License is distributed on an "AS IS" BASIS,
15  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16  * See the License for the specific language governing permissions and
17  * limitations under the License.
18  *
19  ******************************************************************/
20 /**
21  * @file
22  * This file contains common function for handling protocol messages.
23  */
24
25 #ifndef CA_PROTOCOL_MESSAGE_H_
26 #define CA_PROTOCOL_MESSAGE_H_
27
28 #include "cacommon.h"
29 #ifndef WITH_UPSTREAM_LIBCOAP
30 #include "coap/config.h"
31 #endif
32 #include <coap/coap.h>
33
34 #ifdef __cplusplus
35 extern "C"
36 {
37 #endif
38
39 typedef uint32_t code_t;
40
41 #define CA_RESPONSE_CLASS(C) (((C) >> 5)*100)
42 #define CA_RESPONSE_CODE(C) (CA_RESPONSE_CLASS(C) + (C - COAP_RESPONSE_CODE(CA_RESPONSE_CLASS(C))))
43
44 #define HAVE_TIME_H 1
45
46 #ifdef WITH_TCP
47 static const uint8_t PAYLOAD_MARKER = 1;
48 #endif
49
50 /**
51  * generates pdu structure from the given information.
52  * @param[in]   code                 code of the pdu packet.
53  * @param[in]   info                 pdu information.
54  * @param[in]   endpoint             endpoint information.
55  * @return  generated pdu.
56  */
57 coap_pdu_t *CAGeneratePDU(uint32_t code, const CAInfo_t *info, const CAEndpoint_t *endpoint,
58                           coap_list_t **optlist, coap_transport_t *transport);
59
60 /**
61  * extracts request information from received pdu.
62  * @param[in]   pdu                   received pdu.
63  * @param[in]   endpoint              endpoint information.
64  * @param[out]  outReqInfo            request info structure made from received pdu.
65  * @return  CA_STATUS_OK or ERROR CODES (CAResult_t error codes in cacommon.h).
66  */
67 CAResult_t CAGetRequestInfoFromPDU(const coap_pdu_t *pdu, const CAEndpoint_t *endpoint,
68                                    CARequestInfo_t *outReqInfo);
69
70 /**
71  * extracts response information from received pdu.
72  * @param[in]   pdu                   received pdu.
73  * @param[out]  outResInfo            response info structure made from received pdu.
74  * @param[in]   endpoint              endpoint information.
75  * @return  CA_STATUS_OK or ERROR CODES (CAResult_t error codes in cacommon.h).
76  */
77 CAResult_t CAGetResponseInfoFromPDU(const coap_pdu_t *pdu, CAResponseInfo_t *outResInfo,
78                                     const CAEndpoint_t *endpoint);
79
80 /**
81  * extracts error information from received pdu.
82  * @param[in]   pdu                   received pdu.
83  * @param[in]   endpoint              endpoint information.
84  * @param[out]  errorInfo             error info structure made from received pdu.
85  * @return  CA_STATUS_OK or ERROR CODES (CAResult_t error codes in cacommon.h).
86  */
87 CAResult_t CAGetErrorInfoFromPDU(const coap_pdu_t *pdu, const CAEndpoint_t *endpoint,
88                                  CAErrorInfo_t *errorInfo);
89
90 /**
91  * creates pdu from the request information.
92  * @param[in]   code                 request or response code.
93  * @param[in]   info                 information to create pdu.
94  * @param[in]   endpoint             endpoint information.
95  * @param[out]  options              options for the request and response.
96  * @return  generated pdu.
97  */
98 coap_pdu_t *CAGeneratePDUImpl(code_t code, const CAInfo_t *info,
99                               const CAEndpoint_t *endpoint, coap_list_t *options,
100                               coap_transport_t *transport);
101
102 /**
103  * parse the URI and creates the options.
104  * @param[in]    uriInfo             uri information.
105  * @param[out]   options             options information.
106  * @return  CA_STATUS_OK or ERROR CODES (CAResult_t error codes in cacommon.h).
107  */
108 CAResult_t CAParseURI(const char *uriInfo, coap_list_t **options);
109
110 /**
111  * Helper that uses libcoap to parse either the path or the parameters of a URI
112  * and populate the supplied options list.
113  *
114  * @param[in]   str                  the input partial URI string (either path or query).
115  * @param[in]   length               the length of the supplied partial URI.
116  * @param[in]   target               the part of the URI to parse (either COAP_OPTION_URI_PATH.
117  *                                   or COAP_OPTION_URI_QUERY).
118  * @param[out]  optlist              options information.
119  * @return  CA_STATUS_OK or ERROR CODES (CAResult_t error codes in cacommon.h).
120  */
121 CAResult_t CAParseUriPartial(const unsigned char *str, size_t length, uint16_t target,
122                              coap_list_t **optlist);
123
124 /**
125  * create option list from header information in the info.
126  * @param[in]   code                 uri information.
127  * @param[in]   info                 information of the request/response.
128  * @param[out]  optlist              options information.
129  * @return  CA_STATUS_OK or ERROR CODES (CAResult_t error codes in cacommon.h).
130  */
131 CAResult_t CAParseHeadOption(uint32_t code, const CAInfo_t *info, coap_list_t **optlist);
132
133 /**
134  * Helper to parse content format and accept format header options
135  * and populate the supplied options list.
136  *
137  * @param[in]   formatOption         CoAP format header option.
138  * @param[in]   format               content or accept format.
139  * @param[in]   versionOption        CoAP version header option.
140  * @param[in]   version              value of version.
141  * @param[out]  optlist              options information.
142  * @return  CA_STATUS_OK or ERROR CODES (CAResult_t error codes in cacommon.h).
143  */
144
145 CAResult_t CAParsePayloadFormatHeadOption(uint16_t formatOption, CAPayloadFormat_t format,
146         uint16_t versionOption, uint16_t version, coap_list_t **optlist);
147
148 /**
149  * creates option node from key length and data.
150  * @param[in]   key                  key for the that needs to be sent.
151  * @param[in]   length               length of the data that needs to be sent.
152  * @param[in]   data                 data that needs to be sent.
153  * @return  created list.
154  */
155 coap_list_t *CACreateNewOptionNode(uint16_t key, uint32_t length, const char *data);
156
157 /**
158  * order the inserted options.
159  * need to replace queue head if new node has to be added before the existing queue head.
160  * @param[in]   a                    option 1 for insertion.
161  * @param[in]   b                    option 2 for insertion.
162  * @return  0 or 1.
163  */
164 int CAOrderOpts(void *a, void *b);
165
166 /**
167  * number of options count.
168  * @param[in]   opt_iter            option iteration for count.
169  * @param[out]  optionCount         number of options.
170  * @return CA_STATUS_OK or ERROR CODES (CAResult_t error codes in cacommon.h).
171  */
172 CAResult_t CAGetOptionCount(coap_opt_iterator_t opt_iter, uint8_t *optionCount);
173
174 /**
175  * gets option data.
176  * @param[in]   key                  ID of the option
177  * @param[in]   data                 data that is received.
178  * @param[in]   length               length of the data.
179  * @param[out]  option               result of the operation.
180  * @param[in]   buflen               buffer length of the result.
181  * @return  option count.
182  */
183 uint32_t CAGetOptionData(uint16_t key, const uint8_t *data, uint32_t len,
184                          uint8_t *option, uint32_t buflen);
185
186 /**
187  * extracts request information from received pdu.
188  * @param[in]    pdu                  received pdu.
189  * @param[in]    endpoint             endpoint information.
190  * @param[out]   outCode              code of the received pdu.
191  * @param[out]   outInfo              request info structure made from received pdu.
192  * @return  CA_STATUS_OK or ERROR CODES (CAResult_t error codes in cacommon.h).
193  */
194 CAResult_t CAGetInfoFromPDU(const coap_pdu_t *pdu, const CAEndpoint_t *endpoint,
195                             uint32_t *outCode, CAInfo_t *outInfo);
196
197 /**
198  * create pdu from received data.
199  * @param[in]   data                received data.
200  * @param[in]   length              length of the data received.
201  * @param[out]  outCode             code received.
202  * @param[in]   endpoint            endpoint information.
203  * @return  coap_pdu_t value.
204  */
205 coap_pdu_t *CAParsePDU(const char *data, size_t length, uint32_t *outCode,
206                        const CAEndpoint_t *endpoint);
207
208 /**
209  * get Token from received data(pdu).
210  * @param[in]    pdu_hdr             header of received pdu.
211  * @param[out]   outInfo             information with token received.
212  * @param[in]    endpoint            endpoint information.
213  * @return  CA_STATUS_OK or ERROR CODES (CAResult_t error codes in cacommon.h).
214  */
215 CAResult_t CAGetTokenFromPDU(const coap_hdr_transport_t *pdu_hdr,
216                              CAInfo_t *outInfo,
217                              const CAEndpoint_t *endpoint);
218
219 /**
220  * generates the token.
221  * @param[out]   token           generated token.
222  * @param[in]    tokenLength     length of the token.
223  * @return  CA_STATUS_OK or ERROR CODES (CAResult_t error codes in cacommon.h).
224  */
225 CAResult_t CAGenerateTokenInternal(CAToken_t *token, uint8_t tokenLength);
226
227 /**
228  * destroys the token.
229  * @param[in]   token           generated token.
230  */
231 void CADestroyTokenInternal(CAToken_t token);
232
233 /**
234  * gets message type from PDU binary data.
235  * @param[in]   pdu                 pdu data.
236  * @param[in]   size                size of pdu data.
237  * @return  message type.
238  */
239 CAMessageType_t CAGetMessageTypeFromPduBinaryData(const void *pdu, uint32_t size);
240
241 /**
242  * gets message ID PDU binary data.
243  * @param[in]   pdu                 pdu data.
244  * @param[in]   size                size of pdu data.
245  * @return  message ID.
246  */
247 uint16_t CAGetMessageIdFromPduBinaryData(const void *pdu, uint32_t size);
248
249 /**
250  * gets code PDU binary data.
251  * @param[in]   pdu                 pdu data.
252  * @param[in]   size                size of pdu data.
253  * @return  code.
254  */
255 CAResponseResult_t CAGetCodeFromPduBinaryData(const void *pdu, uint32_t size);
256
257 /**
258  * convert format from CoAP media type encoding to CAPayloadFormat_t.
259  * @param[in]   format              coap format code.
260  * @return format.
261  */
262 CAPayloadFormat_t CAConvertFormat(uint16_t format);
263
264 #ifdef WITH_TCP
265 /**
266  * check whether CoAP over TCP is supported or not.
267  * @param[in]   adapter             transport adapter type.
268  * @return true or false.
269  */
270 bool CAIsSupportedCoAPOverTCP(CATransportAdapter_t adapter);
271 #endif
272
273 #ifdef WITH_BWT
274 /**
275  * check whether blockwise transfer is supported or not.
276  * @param[in]   adapter             transport adapter type.
277  * @return true or false.
278  */
279 bool CAIsSupportedBlockwiseTransfer(CATransportAdapter_t adapter);
280 #endif
281
282 #ifdef __cplusplus
283 } /* extern "C" */
284 #endif
285
286 #endif /* CA_PROTOCOL_MESSAGE_H_ */