1 /******************************************************************
3 * Copyright 2014 Samsung Electronics All Rights Reserved.
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
11 * http://www.apache.org/licenses/LICENSE-2.0
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.
19 ******************************************************************/
22 * This file contains common function for handling protocol messages.
25 #ifndef CA_PROTOCOL_MESSAGE_H_
26 #define CA_PROTOCOL_MESSAGE_H_
38 typedef uint32_t code_t;
40 #define CA_RESPONSE_CLASS(C) (((C) >> 5)*100)
41 #define CA_RESPONSE_CODE(C) (CA_RESPONSE_CLASS(C) + (C - COAP_RESPONSE_CODE(CA_RESPONSE_CLASS(C))))
44 // Include files from the arduino platform do not provide these conversions:
46 #define htons(x) ( ((x)<< 8 & 0xFF00) | ((x)>> 8 & 0x00FF) )
47 #define ntohs(x) htons(x)
53 * generates pdu structure from the given information.
54 * @param[in] code code of the pdu packet.
55 * @param[in] info pdu information.
56 * @param[in] endpoint endpoint information.
57 * @return generated pdu.
59 coap_pdu_t *CAGeneratePDU(uint32_t code, const CAInfo_t *info, const CAEndpoint_t *endpoint);
62 * extracts request information from received pdu.
63 * @param[in] pdu received pdu.
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).
67 CAResult_t CAGetRequestInfoFromPDU(const coap_pdu_t *pdu, CARequestInfo_t *outReqInfo);
70 * extracts response information from received pdu.
71 * @param[in] pdu received pdu.
72 * @param[out] outResInfo response info structure made from received pdu.
73 * @return CA_STATUS_OK or ERROR CODES (CAResult_t error codes in cacommon.h).
75 CAResult_t CAGetResponseInfoFromPDU(const coap_pdu_t *pdu, CAResponseInfo_t *outResInfo);
78 * extracts error information from received pdu.
79 * @param[in] pdu received pdu.
80 * @param[out] errorInfo error info structure made from received pdu.
81 * @return CA_STATUS_OK or ERROR CODES (CAResult_t error codes in cacommon.h).
83 CAResult_t CAGetErrorInfoFromPDU(const coap_pdu_t *pdu, CAErrorInfo_t *errorInfo);
86 * creates pdu from the request information.
87 * @param[in] code request or response code.
88 * @param[out] options options for the request and response.
89 * @param[in] info information to create pdu.
90 * @param[in] endpoint endpoint information.
91 * @return generated pdu.
93 coap_pdu_t *CAGeneratePDUImpl(code_t code, coap_list_t *options, const CAInfo_t *info,
94 const CAEndpoint_t *endpoint);
97 * parse the URI and creates the options.
98 * @param[in] uriInfo uri information.
99 * @param[out] options options information.
100 * @return CA_STATUS_OK or ERROR CODES (CAResult_t error codes in cacommon.h).
102 CAResult_t CAParseURI(const char *uriInfo, coap_list_t **options);
105 * Helper that uses libcoap to parse either the path or the parameters of a URI
106 * and populate the supplied options list.
108 * @param[in] str the input partial URI string (either path or query).
109 * @param[in] length the length of the supplied partial URI.
110 * @param[in] target the part of the URI to parse (either COAP_OPTION_URI_PATH.
111 * or COAP_OPTION_URI_QUERY).
112 * @param[out] optlist options information.
113 * @return CA_STATUS_OK or ERROR CODES (CAResult_t error codes in cacommon.h).
115 CAResult_t CAParseUriPartial(const unsigned char *str, size_t length, int target,
116 coap_list_t **optlist);
119 * create option list from header information in the info.
120 * @param[in] code uri information.
121 * @param[in] info information of the request/response.
122 * @param[out] optlist options information.
123 * @return CA_STATUS_OK or ERROR CODES (CAResult_t error codes in cacommon.h).
125 CAResult_t CAParseHeadOption(uint32_t code, const CAInfo_t *info, coap_list_t **optlist);
128 * creates option node from key length and data.
129 * @param[in] key key for the that needs to be sent.
130 * @param[in] length length of the data that needs to be sent.
131 * @param[in] data data that needs to be sent.
132 * @return created list.
134 coap_list_t *CACreateNewOptionNode(uint16_t key, uint32_t length, const char *data);
137 * order the inserted options.
138 * need to replace queue head if new node has to be added before the existing queue head.
139 * @param[in] a option 1 for insertion.
140 * @param[in] b option 2 for insertion.
143 int CAOrderOpts(void *a, void *b);
146 * number of options count.
147 * @param[in] opt_iter option iteration for count.
148 * @return number of options.
150 uint32_t CAGetOptionCount(coap_opt_iterator_t opt_iter);
154 * @param[in] data data that is received.
155 * @param[in] length length of the data.
156 * @param[out] option result of the operation.
157 * @param[in] buflen buffer length of the result.
158 * @return option count.
160 uint32_t CAGetOptionData(const uint8_t *data, uint32_t len, uint8_t *option, uint32_t buflen);
163 * extracts request information from received pdu.
164 * @param[in] pdu received pdu.
165 * @param[out] outCode code of the received pdu.
166 * @param[out] outInfo request info structure made from received pdu.
167 * @return CA_STATUS_OK or ERROR CODES (CAResult_t error codes in cacommon.h).
169 CAResult_t CAGetInfoFromPDU(const coap_pdu_t *pdu, uint32_t *outCode, CAInfo_t *outInfo);
172 * create pdu from received data.
173 * @param[in] data received data.
174 * @param[in] length length of the data received.
175 * @param[out] outCode code received.
176 * @return coap_pdu_t value.
178 coap_pdu_t *CAParsePDU(const char *data, uint32_t length, uint32_t *outCode);
181 * get Token from received data(pdu).
182 * @param[in] pdu_hdr header of received pdu.
183 * @param[out] outInfo information with token received.
184 * @return CA_STATUS_OK or ERROR CODES (CAResult_t error codes in cacommon.h).
186 CAResult_t CAGetTokenFromPDU(const coap_hdr_t *pdu_hdr, CAInfo_t *outInfo);
189 * generates the token.
190 * @param[out] token generated token.
191 * @param[in] tokenLength length of the token.
192 * @return CA_STATUS_OK or ERROR CODES (CAResult_t error codes in cacommon.h).
194 CAResult_t CAGenerateTokenInternal(CAToken_t *token, uint8_t tokenLength);
197 * destroys the token.
198 * @param[in] token generated token.
200 void CADestroyTokenInternal(CAToken_t token);
203 * destroy the ca info structure.
204 * @param[in] info info structure created from received packet.
206 void CADestroyInfo(CAInfo_t *info);
209 * gets message type from PDU binary data.
210 * @param[in] pdu pdu data.
211 * @param[in] size size of pdu data.
212 * @return message type.
214 CAMessageType_t CAGetMessageTypeFromPduBinaryData(const void *pdu, uint32_t size);
217 * gets message ID PDU binary data.
218 * @param[in] pdu pdu data.
219 * @param[in] size size of pdu data.
220 * @return message ID.
222 uint16_t CAGetMessageIdFromPduBinaryData(const void *pdu, uint32_t size);
225 * gets code PDU binary data.
226 * @param[in] pdu pdu data.
227 * @param[in] size size of pdu data.
230 CAResponseResult_t CAGetCodeFromPduBinaryData(const void *pdu, uint32_t size);
236 #endif /* CA_PROTOCOL_MESSAGE_H_ */