NSDL C library

Dependents:   NSDL_HelloWorld_WiFi UbloxModemNanoServiceClient IOT-NSDL_HelloWorld LWM2M_NanoService_Ethernet ... more

Fork of nsdl_lib by Tero Heinonen

Note that use of this software requires acceptance of the Sensinode EULA: http://mbed.org/teams/Sensinode/code/nsdl_lib/wiki/EULA

Committer:
sam_grove
Date:
Wed Apr 22 20:34:36 2015 -0500
Revision:
11:8a47d4c71067
Parent:
9:9db1daa49115
Update error return from sn_nsdl_register_endpoint

Who changed what in which revision?

UserRevisionLine numberNew contents of line
sam_grove 9:9db1daa49115 1 /**
sam_grove 9:9db1daa49115 2 * \file sn_coap_protocol.h
sam_grove 9:9db1daa49115 3 *
sam_grove 9:9db1daa49115 4 * \brief CoAP C-library User protocol interface header file
sam_grove 9:9db1daa49115 5 *
sam_grove 9:9db1daa49115 6 * Created on: Jun 30, 2011
sam_grove 9:9db1daa49115 7 * Author: tero
sam_grove 9:9db1daa49115 8 *
sam_grove 9:9db1daa49115 9 */
sam_grove 9:9db1daa49115 10
sam_grove 9:9db1daa49115 11 #ifdef __cplusplus
sam_grove 9:9db1daa49115 12 extern "C" {
sam_grove 9:9db1daa49115 13 #endif
sam_grove 9:9db1daa49115 14
sam_grove 9:9db1daa49115 15 #ifndef SN_COAP_PROTOCOL_H_
sam_grove 9:9db1daa49115 16 #define SN_COAP_PROTOCOL_H_
sam_grove 9:9db1daa49115 17
sam_grove 9:9db1daa49115 18
sam_grove 9:9db1daa49115 19 /* * * * * * * * * * * * * * * * * * * * * * */
sam_grove 9:9db1daa49115 20 /* * * * EXTERNAL FUNCTION PROTOTYPES * * * */
sam_grove 9:9db1daa49115 21 /* * * * * * * * * * * * * * * * * * * * * * */
sam_grove 9:9db1daa49115 22
sam_grove 9:9db1daa49115 23 /**
sam_grove 9:9db1daa49115 24 * \brief This function sets the memory allocation and deallocation functions and used TX callback function pointer the library will use, and must be called first.
sam_grove 9:9db1daa49115 25 */
sam_grove 9:9db1daa49115 26 extern int8_t sn_coap_protocol_init(void* (*used_malloc_func_ptr)(uint16_t), void (*used_free_func_ptr)(void*),
sam_grove 9:9db1daa49115 27 uint8_t (*used_tx_callback_ptr)(sn_nsdl_capab_e , uint8_t *, uint16_t, sn_nsdl_addr_s *));
sam_grove 9:9db1daa49115 28
sam_grove 9:9db1daa49115 29 /**
sam_grove 9:9db1daa49115 30 * \brief Frees all allocated memory in libCoap protocol part.
sam_grove 9:9db1daa49115 31 */
sam_grove 9:9db1daa49115 32 extern int8_t sn_coap_protocol_destroy(void);
sam_grove 9:9db1daa49115 33
sam_grove 9:9db1daa49115 34 /**
sam_grove 9:9db1daa49115 35 * \brief Use to build an outgoing message buffer from a CoAP header structure.
sam_grove 9:9db1daa49115 36 */
sam_grove 9:9db1daa49115 37 extern int16_t sn_coap_protocol_build(sn_nsdl_addr_s *dst_addr_ptr, uint8_t *dst_packet_data_ptr, sn_coap_hdr_s *src_coap_msg_ptr);
sam_grove 9:9db1daa49115 38
sam_grove 9:9db1daa49115 39 /**
sam_grove 9:9db1daa49115 40 * \brief Use to parse an incoming message buffer to a CoAP header structure.
sam_grove 9:9db1daa49115 41 */
sam_grove 9:9db1daa49115 42 extern sn_coap_hdr_s *sn_coap_protocol_parse(sn_nsdl_addr_s *src_addr_ptr, uint16_t packet_data_len, uint8_t *packet_data_ptr);
sam_grove 9:9db1daa49115 43
sam_grove 9:9db1daa49115 44 /**
sam_grove 9:9db1daa49115 45 * \brief Called periodically to allow the protocol to update retransmission timers and destroy unneeded data.
sam_grove 9:9db1daa49115 46 */
sam_grove 9:9db1daa49115 47 extern int8_t sn_coap_protocol_exec(uint32_t current_time);
sam_grove 9:9db1daa49115 48
sam_grove 9:9db1daa49115 49 /**
sam_grove 9:9db1daa49115 50 * \brief If block transfer is enabled, this function changes the block size.
sam_grove 9:9db1daa49115 51 */
sam_grove 9:9db1daa49115 52 extern int8_t sn_coap_protocol_set_block_size(uint16_t block_size);
sam_grove 9:9db1daa49115 53
sam_grove 9:9db1daa49115 54 /**
sam_grove 9:9db1daa49115 55 * \brief If dublicate message detection is enabled, this function changes buffer size.
sam_grove 9:9db1daa49115 56 */
sam_grove 9:9db1daa49115 57 extern int8_t sn_coap_protocol_set_duplicate_buffer_size(uint8_t message_count);
sam_grove 9:9db1daa49115 58
sam_grove 9:9db1daa49115 59 /**
sam_grove 9:9db1daa49115 60 * \brief If re-transmissions are enabled, this function changes resending count and interval.
sam_grove 9:9db1daa49115 61 */
sam_grove 9:9db1daa49115 62 extern int8_t sn_coap_protocol_set_retransmission_parameters(uint8_t resending_count, uint8_t resending_interval);
sam_grove 9:9db1daa49115 63
sam_grove 9:9db1daa49115 64 /**
sam_grove 9:9db1daa49115 65 * \brief If re-transmissions are enabled, this function changes resending buffer size.
sam_grove 9:9db1daa49115 66 */
sam_grove 9:9db1daa49115 67 extern int8_t sn_coap_protocol_set_retransmission_buffer(uint8_t buffer_size_messages, uint16_t buffer_size_bytes);
sam_grove 9:9db1daa49115 68
sam_grove 9:9db1daa49115 69
sam_grove 9:9db1daa49115 70 /* NSP manual registration functions */
sam_grove 9:9db1daa49115 71
sam_grove 9:9db1daa49115 72
sam_grove 9:9db1daa49115 73 /**
sam_grove 9:9db1daa49115 74 * \brief Create an NSP registration message.
sam_grove 9:9db1daa49115 75 */
sam_grove 9:9db1daa49115 76 extern int8_t sn_coap_register(sn_coap_hdr_s *coap_hdr_ptr, registration_info_t *endpoint_info_ptr);
sam_grove 9:9db1daa49115 77
sam_grove 9:9db1daa49115 78 /**
sam_grove 9:9db1daa49115 79 * \brief Create an NSP update message.
sam_grove 9:9db1daa49115 80 */
sam_grove 9:9db1daa49115 81 extern int8_t sn_coap_register_update(sn_coap_hdr_s *coap_hdr_ptr, uint8_t *location, uint8_t length);
sam_grove 9:9db1daa49115 82
sam_grove 9:9db1daa49115 83 /**
sam_grove 9:9db1daa49115 84 * \brief Create an NSP de-registration message.
sam_grove 9:9db1daa49115 85 */
sam_grove 9:9db1daa49115 86 extern int8_t sn_coap_deregister(sn_coap_hdr_s *coap_hdr_ptr, uint8_t *location, uint8_t length);
sam_grove 9:9db1daa49115 87
sam_grove 9:9db1daa49115 88 #endif /* SN_COAP_PROTOCOL_H_ */
sam_grove 9:9db1daa49115 89
sam_grove 9:9db1daa49115 90 #ifdef __cplusplus
sam_grove 9:9db1daa49115 91 }
sam_grove 9:9db1daa49115 92 #endif
screamer 2:ab50a2ab6ec9 93