mirror of https://github.com/ARMmbed/mbed-os.git
153 lines
6.0 KiB
C
153 lines
6.0 KiB
C
/*
|
|
* 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"
|
|
#include "mbed-coap/sn_config.h"
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
|
|
struct sn_coap_hdr_;
|
|
|
|
#define RESPONSE_RANDOM_FACTOR 1.5 /**< Resending random factor, value is specified in IETF CoAP specification */
|
|
|
|
/* * For Option handling * */
|
|
#define COAP_OPTION_MAX_AGE_DEFAULT 60 /**< Default value of Max-Age if option not present */
|
|
#define COAP_OPTION_URI_PORT_NONE (-1) /**< Internal value to represent no Uri-Port option */
|
|
#define COAP_OPTION_BLOCK_NONE (-1) /**< Internal value to represent no Block1/2 option */
|
|
|
|
int8_t prepare_blockwise_message(struct coap_s *handle, struct sn_coap_hdr_ *coap_hdr_ptr);
|
|
|
|
/* Structure which is stored to Linked list for message sending purposes */
|
|
typedef struct coap_send_msg_ {
|
|
uint_fast8_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;
|
|
|
|
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 */
|
|
uint16_t msg_id;
|
|
uint16_t packet_len;
|
|
uint8_t *packet_ptr;
|
|
sn_nsdl_addr_s *address;
|
|
void *param;
|
|
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;
|
|
|
|
void *param;
|
|
uint16_t msg_id;
|
|
|
|
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_ {
|
|
uint8_t addr_len;
|
|
uint8_t token_len;
|
|
bool use_size1;
|
|
uint16_t port;
|
|
uint16_t payload_len;
|
|
uint8_t *addr_ptr;
|
|
uint32_t block_number;
|
|
uint8_t *token_ptr;
|
|
uint8_t *payload_ptr;
|
|
uint32_t timestamp; /* Tells when Payload is stored to Linked list */
|
|
ns_list_link_t link;
|
|
} coap_blockwise_payload_s;
|
|
|
|
typedef NS_LIST_HEAD(coap_blockwise_payload_s, link) coap_blockwise_payload_list_t;
|
|
|
|
struct coap_s {
|
|
uint8_t sn_coap_resending_queue_msgs;
|
|
uint8_t sn_coap_resending_count;
|
|
uint8_t sn_coap_resending_intervall;
|
|
uint8_t sn_coap_duplication_buffer_size;
|
|
uint8_t sn_coap_internal_block2_resp_handling; /* If this is set then coap itself sends a next GET request automatically */
|
|
uint16_t sn_coap_block_data_size;
|
|
#if ENABLE_RESENDINGS
|
|
uint16_t count_resent_msgs;
|
|
#endif
|
|
#if SN_COAP_DUPLICATION_MAX_MSGS_COUNT
|
|
uint16_t count_duplication_msgs;
|
|
#endif
|
|
|
|
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 *);
|
|
|
|
#if ENABLE_RESENDINGS /* If Message resending is not used at all, this part of code will not be compiled */
|
|
coap_send_msg_list_t linked_list_resent_msgs; /* Active resending messages are stored to this Linked list */
|
|
#endif
|
|
|
|
#if SN_COAP_DUPLICATION_MAX_MSGS_COUNT /* If Message duplication detection is not used at all, this part of code will not be compiled */
|
|
coap_duplication_info_list_t linked_list_duplication_msgs; /* Messages for duplicated messages detection is stored to this Linked list */
|
|
#endif
|
|
|
|
#if SN_COAP_BLOCKWISE_ENABLED || SN_COAP_MAX_BLOCKWISE_PAYLOAD_SIZE /* If Message blockwise is not enabled, this part of code will not be compiled */
|
|
coap_blockwise_msg_list_t linked_list_blockwise_sent_msgs; /* Blockwise message to to be sent is stored to this Linked list */
|
|
coap_blockwise_payload_list_t linked_list_blockwise_received_payloads; /* Blockwise payload to to be received is stored to this Linked list */
|
|
#endif
|
|
|
|
uint32_t system_time; /* System time seconds */
|
|
uint32_t sn_coap_resending_queue_bytes;
|
|
};
|
|
|
|
/* Utility function which performs a call to sn_coap_protocol_malloc() and memset's the result to zero. */
|
|
void *sn_coap_protocol_calloc(struct coap_s *handle, uint_fast16_t length);
|
|
|
|
/* Utility function which performs a call to sn_coap_protocol_malloc() and memcopy's the source to result buffer. */
|
|
void *sn_coap_protocol_malloc_copy(struct coap_s *handle, const void *source, uint_fast16_t length);
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|
|
|
|
#endif /* SN_COAP_PROTOCOL_INTERNAL_H_ */
|
|
|