mbed client lightswitch demo
Dependencies: mbed Socket lwip-eth lwip-sys lwip
Fork of mbed-client-classic-example-lwip by
Diff: mbed-client-c/source/libCoap/src/include/sn_coap_protocol_internal.h
- Revision:
- 11:cada08fc8a70
diff -r 1280c4c21987 -r cada08fc8a70 mbed-client-c/source/libCoap/src/include/sn_coap_protocol_internal.h --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/mbed-client-c/source/libCoap/src/include/sn_coap_protocol_internal.h Thu Jun 09 17:08:36 2016 +0000 @@ -0,0 +1,166 @@ +/* + * Copyright (c) 2011-2015 ARM Limited. All rights reserved. + * SPDX-License-Identifier: Apache-2.0 + * 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. + */ + +/** + * \file sn_coap_protocol_internal.h + * + * \brief Header file for CoAP Protocol part + * + */ + +#ifndef SN_COAP_PROTOCOL_INTERNAL_H_ +#define SN_COAP_PROTOCOL_INTERNAL_H_ + +#include "ns_list.h" +#include "sn_coap_header_internal.h" + +#ifdef __cplusplus +extern "C" { +#endif + +struct coap_s { + void *(*sn_coap_protocol_malloc)(uint16_t); + void (*sn_coap_protocol_free)(void *); + + uint8_t (*sn_coap_tx_callback)(uint8_t *, uint16_t, sn_nsdl_addr_s *, void *); + int8_t (*sn_coap_rx_callback)(sn_coap_hdr_s *, sn_nsdl_addr_s *, void *); +}; + +/* * * * * * * * * * * */ +/* * * * DEFINES * * * */ +/* * * * * * * * * * * */ + +/* * For Message resending * */ +#define ENABLE_RESENDINGS 1 /**< Enable / Disable resending from library in building */ + +#define SN_COAP_RESENDING_MAX_COUNT 3 /**< Default number of re-sendings */ +#define SN_COAP_RESENDING_QUEUE_SIZE_MSGS 2 /**< Default re-sending queue size - defines how many messages can be stored. Setting this to 0 disables feature */ +#define SN_COAP_RESENDING_QUEUE_SIZE_BYTES 0 /**< Default re-sending queue size - defines size of the re-sending buffer. Setting this to 0 disables feature */ +#define DEFAULT_RESPONSE_TIMEOUT 10 /**< Default re-sending timeout as seconds */ + +/* These parameters sets maximum values application can set with API */ +#define SN_COAP_MAX_ALLOWED_RESENDING_COUNT 6 /**< Maximum allowed count of re-sending */ +#define SN_COAP_MAX_ALLOWED_RESENDING_BUFF_SIZE_MSGS 6 /**< Maximum allowed number of saved re-sending messages */ +#define SN_COAP_MAX_ALLOWED_RESENDING_BUFF_SIZE_BYTES 512 /**< Maximum allowed size of re-sending buffer */ +#define SN_COAP_MAX_ALLOWED_RESPONSE_TIMEOUT 40 /**< Maximum allowed re-sending timeout */ + +#define RESPONSE_RANDOM_FACTOR 1 /**< Resending random factor, value is specified in IETF CoAP specification */ + +/* * For Message duplication detecting * */ + +/* Init value for the maximum count of messages to be stored for duplication detection */ +/* Setting of this value to 0 will disable duplication check, also reduce use of ROM memory */ +#ifndef SN_COAP_DUPLICATION_MAX_MSGS_COUNT +#define SN_COAP_DUPLICATION_MAX_MSGS_COUNT 0 +#endif +/* Maximum allowed number of saved messages for duplicate searching */ +#define SN_COAP_MAX_ALLOWED_DUPLICATION_MESSAGE_COUNT 6 + +/* Maximum time in seconds of messages to be stored for duplication detection */ +#define SN_COAP_DUPLICATION_MAX_TIME_MSGS_STORED 60 /* RESPONSE_TIMEOUT * RESPONSE_RANDOM_FACTOR * (2 ^ MAX_RETRANSMIT - 1) + the expected maximum round trip time */ + +/* * For Message blockwising * */ + +/* Init value for the maximum payload size to be sent and received at one blockwise message */ +/* Setting of this value to 0 will disable this feature, and also reduce use of ROM memory */ +/* Note: Current Coap implementation supports Blockwise transfers specification version draft-ietf-core-block-03 */ +/* Note: This define is common for both received and sent Blockwise messages */ +#ifndef SN_COAP_BLOCKWISE_MAX_PAYLOAD_SIZE +#define SN_COAP_BLOCKWISE_MAX_PAYLOAD_SIZE 0 /**< Must be 2^x and x is at least 4. Suitable values: 0, 16, 32, 64, 128, 256, 512 and 1024 */ +#endif + +#ifndef SN_COAP_BLOCKWISE_MAX_TIME_DATA_STORED +#define SN_COAP_BLOCKWISE_MAX_TIME_DATA_STORED 10 /**< Maximum time in seconds of data (messages and payload) to be stored for blockwising */ +#endif + + +/* * * * * * * * * * * * * * */ +/* * * * ENUMERATIONS * * * */ +/* * * * * * * * * * * * * * */ + +/* * * * * * * * * * * * * */ +/* * * * STRUCTURES * * * */ +/* * * * * * * * * * * * * */ + + +/* Structure which is stored to Linked list for message sending purposes */ +typedef struct coap_send_msg_ { + uint8_t resending_counter; /* Tells how many times message is still tried to resend */ + uint32_t resending_time; /* Tells next resending time */ + + sn_nsdl_transmit_s *send_msg_ptr; + + struct coap_s *coap; /* CoAP library handle */ + void *param; /* Extra parameter that will be passed to TX/RX callback functions */ + + ns_list_link_t link; +} coap_send_msg_s; + +typedef NS_LIST_HEAD(coap_send_msg_s, link) coap_send_msg_list_t; + +/* Structure which is stored to Linked list for message duplication detection purposes */ +typedef struct coap_duplication_info_ { + uint32_t timestamp; /* Tells when duplication information is stored to Linked list */ + + uint8_t addr_len; + uint8_t *addr_ptr; + uint16_t port; + + uint16_t msg_id; + + struct coap_s *coap; /* CoAP library handle */ + + ns_list_link_t link; +} coap_duplication_info_s; + +typedef NS_LIST_HEAD(coap_duplication_info_s, link) coap_duplication_info_list_t; + +/* Structure which is stored to Linked list for blockwise messages sending purposes */ +typedef struct coap_blockwise_msg_ { + uint32_t timestamp; /* Tells when Blockwise message is stored to Linked list */ + + sn_coap_hdr_s *coap_msg_ptr; + struct coap_s *coap; /* CoAP library handle */ + + ns_list_link_t link; +} coap_blockwise_msg_s; + +typedef NS_LIST_HEAD(coap_blockwise_msg_s, link) coap_blockwise_msg_list_t; + +/* Structure which is stored to Linked list for blockwise messages receiving purposes */ +typedef struct coap_blockwise_payload_ { + uint32_t timestamp; /* Tells when Payload is stored to Linked list */ + + uint8_t addr_len; + uint8_t *addr_ptr; + uint16_t port; + + uint16_t payload_len; + uint8_t *payload_ptr; + struct coap_s *coap; /* CoAP library handle */ + + ns_list_link_t link; +} coap_blockwise_payload_s; + +typedef NS_LIST_HEAD(coap_blockwise_payload_s, link) coap_blockwise_payload_list_t; + +#ifdef __cplusplus +} +#endif + +#endif /* SN_COAP_PROTOCOL_INTERNAL_H_ */ + +