NSDL C library
Dependents: NSDL_HelloWorld_WiFi UbloxModemNanoServiceClient IOT-NSDL_HelloWorld LWM2M_NanoService_Ethernet ... more
Fork of nsdl_lib by
Note that use of this software requires acceptance of the Sensinode EULA: http://mbed.org/teams/Sensinode/code/nsdl_lib/wiki/EULA
Revision 0:58c4f13c4b9a, committed 2013-10-09
- Comitter:
- terohoo
- Date:
- Wed Oct 09 09:20:29 2013 +0000
- Child:
- 1:01d723824294
- Child:
- 5:da1db64e7fb9
- Commit message:
- Adding nsdl_lib
Changed in this revision
Binary file nsdl_lib.ar has changed
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/sn_coap_header.h Wed Oct 09 09:20:29 2013 +0000
@@ -0,0 +1,239 @@
+/**
+ * \file sn_coap_header.h
+ *
+ * \brief CoAP C-library User header interface header file
+ *
+ * Created on: Jun 30, 2011
+ * Author: tero
+ *
+ * \note Supports draft-ietf-core-coap-18
+ */
+
+#ifndef SN_COAP_HEADER_H_
+#define SN_COAP_HEADER_H_
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+/* * * * * * * * * * * */
+/* * * * DEFINES * * * */
+/* * * * * * * * * * * */
+
+/* * * * * * * * * * * * * * */
+/* * * * ENUMERATIONS * * * */
+/* * * * * * * * * * * * * * */
+
+/* Enumeration for CoAP Version */
+typedef enum coap_version_
+{
+ COAP_VERSION_1 = 0x40,
+ COAP_VERSION_UNKNOWN = 0xFF
+} coap_version_e;
+
+/* Enumeration for CoAP Message type, used in CoAP Header */
+typedef enum sn_coap_msg_type_
+{
+ COAP_MSG_TYPE_CONFIRMABLE = 0x00, /* User uses this for Reliable Request messages */
+ COAP_MSG_TYPE_NON_CONFIRMABLE = 0x10, /* User uses this for Non-reliable Request and Response messages */
+ COAP_MSG_TYPE_ACKNOWLEDGEMENT = 0x20, /* User uses this for Response to a Confirmable Request */
+ COAP_MSG_TYPE_RESET = 0x30 /* User uses this to answer a Bad Request */
+} sn_coap_msg_type_e;
+
+/* Enumeration for CoAP Message code, used in CoAP Header */
+typedef enum sn_coap_msg_code_
+{
+ COAP_MSG_CODE_EMPTY = 0,
+ COAP_MSG_CODE_REQUEST_GET = 1,
+ COAP_MSG_CODE_REQUEST_POST = 2,
+ COAP_MSG_CODE_REQUEST_PUT = 3,
+ COAP_MSG_CODE_REQUEST_DELETE = 4,
+
+ COAP_MSG_CODE_RESPONSE_CREATED = 65,
+ COAP_MSG_CODE_RESPONSE_DELETED = 66,
+ COAP_MSG_CODE_RESPONSE_VALID = 67,
+ COAP_MSG_CODE_RESPONSE_CHANGED = 68,
+ COAP_MSG_CODE_RESPONSE_CONTENT = 69,
+ COAP_MSG_CODE_RESPONSE_BAD_REQUEST = 128,
+ COAP_MSG_CODE_RESPONSE_UNAUTHORIZED = 129,
+ COAP_MSG_CODE_RESPONSE_BAD_OPTION = 130,
+ COAP_MSG_CODE_RESPONSE_FORBIDDEN = 131,
+ COAP_MSG_CODE_RESPONSE_NOT_FOUND = 132,
+ COAP_MSG_CODE_RESPONSE_METHOD_NOT_ALLOWED = 133,
+ COAP_MSG_CODE_RESPONSE_NOT_ACCEPTABLE = 134,
+ COAP_MSG_CODE_RESPONSE_REQUEST_ENTITY_INCOMPLETE = 136, /* Block */
+ COAP_MSG_CODE_RESPONSE_PRECONDITION_FAILED = 140,
+ COAP_MSG_CODE_RESPONSE_REQUEST_ENTITY_TOO_LARGE = 141,
+ COAP_MSG_CODE_RESPONSE_UNSUPPORTED_CONTENT_FORMAT = 143,
+ COAP_MSG_CODE_RESPONSE_INTERNAL_SERVER_ERROR = 160,
+ COAP_MSG_CODE_RESPONSE_NOT_IMPLEMENTED = 161,
+ COAP_MSG_CODE_RESPONSE_BAD_GATEWAY = 162,
+ COAP_MSG_CODE_RESPONSE_SERVICE_UNAVAILABLE = 163,
+ COAP_MSG_CODE_RESPONSE_GATEWAY_TIMEOUT = 164,
+ COAP_MSG_CODE_RESPONSE_PROXYING_NOT_SUPPORTED = 165
+} sn_coap_msg_code_e;
+
+/* Enumeration for CoAP Option number, used in CoAP Header */
+typedef enum sn_coap_option_numbers_
+{
+ COAP_OPTION_IF_MATCH = 1,
+ COAP_OPTION_URI_HOST = 3,
+ COAP_OPTION_ETAG = 4,
+ COAP_OPTION_IF_NONE_MATCH = 5,
+ COAP_OPTION_OBSERVE = 6,
+ COAP_OPTION_URI_PORT = 7,
+ COAP_OPTION_LOCATION_PATH = 8,
+ COAP_OPTION_URI_PATH = 11,
+ COAP_OPTION_CONTENT_FORMAT = 12,
+ COAP_OPTION_MAX_AGE = 14,
+ COAP_OPTION_URI_QUERY = 15,
+ COAP_OPTION_ACCEPT = 17,
+ COAP_OPTION_LOCATION_QUERY = 20,
+ COAP_OPTION_BLOCK2 = 23,
+ COAP_OPTION_BLOCK1 = 27,
+ COAP_OPTION_PROXY_URI = 35,
+ COAP_OPTION_PROXY_SCHEME = 39,
+ COAP_OPTION_SIZE1 = 60
+// 128 = (Reserved)
+// 132 = (Reserved)
+// 136 = (Reserved)
+} sn_coap_option_numbers_e;
+
+/* Enumeration for CoAP Content Format codes */
+typedef enum sn_coap_content_format_
+{
+ COAP_CT_NONE = -1,
+ COAP_CT_TEXT_PLAIN = 0,
+ COAP_CT_LINK_FORMAT = 40,
+ COAP_CT_XML = 41,
+ COAP_CT_OCTET_STREAM = 42,
+ COAP_CT_EXI = 47,
+ COAP_CT_JSON = 50,
+} sn_coap_content_format_e;
+
+/* Enumeration for CoAP status, used in CoAP Header */
+typedef enum sn_coap_status_
+{
+ COAP_STATUS_OK = 0, /* Default value is OK */
+ COAP_STATUS_PARSER_ERROR_IN_HEADER = 1, /* CoAP will send Reset message to invalid message sender */
+ COAP_STATUS_PARSER_DUPLICATED_MSG = 2, /* CoAP will send Acknowledgement message to duplicated message sender */
+ COAP_STATUS_PARSER_BLOCKWISE_MSG_RECEIVING = 3, /* User will get whole message after all message blocks received.
+ User must release messages with this status. */
+ COAP_STATUS_PARSER_BLOCKWISE_ACK = 4, /* Acknowledgement for sent Blockwise message received */
+ COAP_STATUS_PARSER_BLOCKWISE_MSG_REJECTED = 5, /* Blockwise message received but not supported by compiling switch */
+ COAP_STATUS_PARSER_BLOCKWISE_MSG_RECEIVED = 6 /* Blockwise message fully received and returned to app. */
+ /* User must take care of releasing whole payload of the blockwise messages */
+} sn_coap_status_e;
+
+
+/* * * * * * * * * * * * * */
+/* * * * STRUCTURES * * * */
+/* * * * * * * * * * * * * */
+
+/* Structure for CoAP Options */
+typedef struct sn_coap_options_list_
+{
+
+ /* If-Match */
+ /* If-None-Match */
+ /* Size */
+ /* Proxy-Scheme */
+
+ uint8_t max_age_len; /* 0-4 bytes. */
+ uint8_t *max_age_ptr; /* Must be set to NULL if not used */
+
+ uint16_t proxy_uri_len; /* 1-1034 bytes. */
+ uint8_t *proxy_uri_ptr; /* Must be set to NULL if not used */
+
+ uint8_t etag_len; /* 1-8 bytes. Repeatable */
+ uint8_t *etag_ptr; /* Must be set to NULL if not used */
+
+ uint16_t uri_host_len; /* 1-255 bytes. */
+ uint8_t *uri_host_ptr; /* Must be set to NULL if not used */
+
+ uint16_t location_path_len; /* 0-255 bytes. Repeatable */
+ uint8_t *location_path_ptr; /* Must be set to NULL if not used */
+
+ uint8_t uri_port_len; /* 0-2 bytes. */
+ uint8_t *uri_port_ptr; /* Must be set to NULL if not used */
+
+ uint16_t location_query_len; /* 0-255 bytes. Repeatable */
+ uint8_t *location_query_ptr; /* Must be set to NULL if not used */
+
+ uint8_t observe;
+ uint8_t observe_len; /* 0-2 bytes. */
+ uint8_t *observe_ptr; /* Must be set to NULL if not used */
+
+ uint8_t accept_len; /* 0-2 bytes. Repeatable */
+ uint8_t *accept_ptr; /* Must be set to NULL if not used */
+
+ uint16_t uri_query_len; /* 1-255 bytes. Repeatable */
+ uint8_t *uri_query_ptr; /* Must be set to NULL if not used */
+
+ uint8_t block1_len; /* 0-3 bytes. */
+ uint8_t *block1_ptr; /* Not for User */
+
+ uint8_t block2_len; /* 0-3 bytes. */
+ uint8_t *block2_ptr; /* Not for User */
+} sn_coap_options_list_s;
+
+/* !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! */
+/* !!! Main CoAP message struct !!! */
+/* !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! */
+typedef struct sn_coap_hdr_
+{
+ sn_coap_status_e coap_status; /* Used for telling to User special cases when parsing message */
+
+ /* * * * * * * * * * * */
+ /* * * * Header * * * */
+ /* * * * * * * * * * * */
+
+ sn_coap_msg_type_e msg_type; /* Confirmable, Non-Confirmable, Acknowledgement or Reset */
+ sn_coap_msg_code_e msg_code; /* Empty: 0; Requests: 1-31; Responses: 64-191 */
+ uint16_t msg_id; /* Message ID. Parser sets parsed message ID, builder sets message ID of built coap message */
+
+ /* * * * * * * * * * * */
+ /* * * * Options * * * */
+ /* * * * * * * * * * * */
+
+ /* Here are most often used Options */
+
+ uint16_t uri_path_len; /* 0-255 bytes. Repeatable. */
+ uint8_t *uri_path_ptr; /* Must be set to NULL if not used. E.g: temp1/temp2 */
+
+ uint8_t token_len; /* 1-8 bytes. */
+ uint8_t *token_ptr; /* Must be set to NULL if not used */
+
+ /* todo: COAP12 - content type ptr as a content_type_e */
+ uint8_t content_type_len; /* 0-2 bytes. */
+ uint8_t *content_type_ptr; /* Must be set to NULL if not used */
+
+ /* Here are not so often used Options */
+ sn_coap_options_list_s *options_list_ptr; /* Must be set to NULL if not used */
+
+ /* * * * * * * * * * * */
+ /* * * * Payload * * * */
+ /* * * * * * * * * * * */
+
+ uint16_t payload_len; /* Must be set to zero if not used */
+ uint8_t *payload_ptr; /* Must be set to NULL if not used */
+} sn_coap_hdr_s;
+
+/* * * * * * * * * * * * * * * * * * * * * * */
+/* * * * EXTERNAL FUNCTION PROTOTYPES * * * */
+/* * * * * * * * * * * * * * * * * * * * * * */
+
+extern void sn_coap_builder_and_parser_init(void* (*used_malloc_func_ptr)(uint16_t), void (*used_free_func_ptr)(void*));
+extern sn_coap_hdr_s *sn_coap_parser(uint16_t packet_data_len, uint8_t *packet_data_ptr, coap_version_e *coap_version_ptr);
+extern int16_t sn_coap_builder(uint8_t *dst_packet_data_ptr, sn_coap_hdr_s *src_coap_msg_ptr);
+extern uint16_t sn_coap_builder_calc_needed_packet_data_size(sn_coap_hdr_s *src_coap_msg_ptr);
+extern void sn_coap_builder_release_allocated_send_msg_mem(sn_nsdl_transmit_s *freed_send_msg_ptr);
+extern sn_coap_hdr_s *sn_coap_build_response(sn_coap_hdr_s *coap_packet_ptr, uint8_t msg_code);
+extern void sn_coap_parser_release_allocated_coap_msg_mem(sn_coap_hdr_s *freed_coap_msg_ptr);
+extern void sn_coap_packet_debug(sn_coap_hdr_s *coap_packet_ptr);
+
+#endif /* SN_COAP_HEADER_H_ */
+
+#ifdef __cplusplus
+}
+#endif
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/sn_coap_protocol.h Wed Oct 09 09:20:29 2013 +0000
@@ -0,0 +1,94 @@
+/**
+ * \file sn_coap_protocol.h
+ *
+ * \brief CoAP C-library User protocol interface header file
+ *
+ * Created on: Jun 30, 2011
+ * Author: tero
+ *
+ */
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+#ifndef SN_COAP_PROTOCOL_H_
+#define SN_COAP_PROTOCOL_H_
+
+/* * * * * * * * * * * */
+/* * * * DEFINES * * * */
+/* * * * * * * * * * * */
+
+/* Maximum time in seconds of messages to be stored for Acknowledging. This time tells */
+/* how long time User of CoAP C-library have time to send Piggy-backed acknowledgement */
+/* message to Request sender. */
+#define SN_COAP_ACK_INFO_MAX_TIME_MSGS_STORED 20
+#define SN_COAP_ACK_INFO_MAX_COUNT_MESSAGES_SAVED 10
+
+/* * For Message resending * */
+
+/* Init value for maximum count of ongoing active resending messages */
+/* This value depends on available memory: If there is restricted count of memory, use little value e.g. 1 */
+/* Setting of this value to 0 will disable re-sending and also reduce use of ROM memory */
+#define SN_COAP_RESENDING_MAX_COUNT 0
+/* Default value for re-sending buffer size */
+#define SN_COAP_RESENDING_BUFFER_MAX_SIZE 0
+
+/* These parameters sets maximum values application can set with API */
+/* Maximum allowed count of re-sending */
+#define SN_COAP_MAX_ALLOWED_RESENDING_COUNT 6
+/* Maximum allowed number of saved re-sending messages */
+#define SN_COAP_MAX_ALLOWED_RESENDING_BUFF_SIZE 6
+
+/* * 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 */
+#define SN_COAP_DUPLICATION_MAX_MSGS_COUNT 0
+/* 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
+
+
+/* Maximum time in seconds of data (messages and payload) to be stored for blockwising */
+#ifndef SN_COAP_BLOCKWISE_MAX_TIME_DATA_STORED
+#define SN_COAP_BLOCKWISE_MAX_TIME_DATA_STORED 10
+#endif
+
+
+/* * * * * * * * * * * * * * * * * * * * * * */
+/* * * * EXTERNAL FUNCTION PROTOTYPES * * * */
+/* * * * * * * * * * * * * * * * * * * * * * */
+
+extern int8_t sn_coap_protocol_init(void* (*used_malloc_func_ptr)(uint16_t), void (*used_free_func_ptr)(void*),
+ uint8_t (*used_tx_callback_ptr)(sn_nsdl_capab_e , uint8_t *, uint16_t, sn_nsdl_addr_s *));
+extern int8_t sn_coap_protocol_destroy(void);
+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);
+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);
+extern int8_t sn_coap_protocol_exec(uint32_t current_time);
+extern int8_t sn_coap_protocol_set_block_size(uint16_t block_size);
+extern int8_t sn_coap_protocol_set_duplicate_buffer_size(uint8_t message_count);
+extern int8_t sn_coap_protocol_set_retransmission(uint8_t resending_count, uint8_t buffer_size);
+
+/* NSP registration functions */
+extern int8_t sn_coap_register(sn_coap_hdr_s *coap_hdr_ptr, registration_info_t *endpoint_info_ptr);
+extern int8_t sn_coap_register_update(sn_coap_hdr_s *coap_hdr_ptr, uint8_t *location, uint8_t length);
+extern int8_t sn_coap_deregister(sn_coap_hdr_s *coap_hdr_ptr, uint8_t *location, uint8_t length);
+
+#endif /* SN_COAP_PROTOCOL_H_ */
+
+#ifdef __cplusplus
+}
+#endif
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/sn_nsdl.h Wed Oct 09 09:20:29 2013 +0000
@@ -0,0 +1,113 @@
+/**
+ * \file sn_nsdl.h
+ *
+ * \brief NanoService Devices Library generic header file
+ *
+ * Created on: Aug 23, 2011
+ * Author: tero
+ *
+ */
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+#ifndef SN_NSDL_H_
+#define SN_NSDL_H_
+
+/* * * * * * * * * * * */
+/* * * * DEFINES * * * */
+/* * * * * * * * * * * */
+
+#define SN_GRS_VERSION 0x0101
+
+#ifndef SN_NSDL_HAVE_HTTP_CAPABILITY
+#define SN_NSDL_HAVE_HTTP_CAPABILITY 0
+#endif
+
+#ifndef SN_NSDL_HAVE_HTTPS_CAPABILITY
+#define SN_NSDL_HAVE_HTTPS_CAPABILITY 0
+#endif
+
+#ifndef SN_NSDL_HAVE_COAP_CAPABILITY
+#define SN_NSDL_HAVE_COAP_CAPABILITY 1
+#endif
+
+/* * * Common * * */
+
+#define SN_NSDL_SUCCESS 0
+#define SN_NSDL_FAILURE (-1)
+
+/* * * * * * * * * * * * * * */
+/* * * * ENUMERATIONS * * * */
+/* * * * * * * * * * * * * * */
+
+
+typedef enum sn_nsdl_capab_
+{
+ SN_NSDL_PROTOCOL_HTTP = 0x01,
+ SN_NSDL_PROTOCOL_HTTPS = 0x02,
+ SN_NSDL_PROTOCOL_COAP = 0x04
+} sn_nsdl_capab_e;
+
+typedef enum sn_nsdl_addr_type_
+{
+ SN_NSDL_ADDRESS_TYPE_IPV6 = 0x01,
+ SN_NSDL_ADDRESS_TYPE_IPV4 = 0x02,
+ SN_NSDL_ADDRESS_TYPE_HOSTNAME = 0x03,
+ SN_NSDL_ADDRESS_TYPE_NONE = 0xFF
+} sn_nsdl_addr_type_e;
+
+
+#define SN_NDSL_RESOURCE_NOT_REGISTERED 0
+#define SN_NDSL_RESOURCE_REGISTERING 1
+#define SN_NDSL_RESOURCE_REGISTERED 2
+
+
+/* * * * * * * * * * * * * */
+/* * * * STRUCTURES * * * */
+/* * * * * * * * * * * * * */
+
+/* Address structure of Packet data */
+typedef struct sn_nsdl_addr_
+{
+ sn_nsdl_addr_type_e type;
+
+ uint8_t addr_len;
+ uint8_t *addr_ptr;
+
+ uint16_t port;
+
+ void *socket_information;
+
+} sn_nsdl_addr_s;
+
+/* This structure is returned by sn_coap_exec() for sending */
+typedef struct sn_nsdl_transmit_
+{
+ sn_nsdl_addr_s *dst_addr_ptr;
+
+ sn_nsdl_capab_e protocol;
+
+ uint16_t packet_len;
+ uint8_t *packet_ptr;
+} sn_nsdl_transmit_s;
+
+typedef struct registration_info_
+{
+ uint8_t *endpoint_ptr;
+ uint8_t endpoint_len;
+
+ uint8_t *endpoint_type_ptr;
+ uint8_t endpoint_type_len;
+
+ uint8_t *links_ptr;
+ uint16_t links_len;
+
+}registration_info_t;
+
+#endif /* SN_NSDL_H_ */
+
+#ifdef __cplusplus
+}
+#endif
\ No newline at end of file
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/sn_nsdl_lib.h Wed Oct 09 09:20:29 2013 +0000
@@ -0,0 +1,266 @@
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+#define SN_NSDL_CONST_MEMORY_ATTRIBUTE
+
+#define RESOURCE_DIR_LEN 2
+#define RESOURCE_DIR_PATH {'r','d'}
+
+#define EP_NAME_PARAMETERS_LEN 2
+#define EP_NAME_PARAMETERS {'h','='}
+
+#define RT_PARAMETER_LEN 3
+#define RT_PARAMETER {'r','t','='}
+
+#define IF_PARAMETER_LEN 3
+#define IF_PARAMETER {'i','f','='}
+
+#define CON_PARAMETER_LEN 4
+#define CON_PARAMETER {'c','o','n','='}
+
+#define LT_PARAMETER_LEN 3
+#define LT_PARAMETER {'l','t','='}
+
+#define OBS_PARAMETER_LEN 3
+#define OBS_PARAMETER {'o','b','s'}
+
+#define COAP_CON_PARAMETER_LEN 3
+#define COAP_CON_PARAMETER {'c','t','='}
+
+#define EVENT_PATH_LEN 6
+#define EVENT_PATH {'e','v','e','n','t','/'}
+
+#define WELLKNOWN_PATH_LEN 16
+#define WELLKNOWN_PATH (".well-known/core")
+
+#define SN_NSDL_EP_REGISTER_MESSAGE 1
+#define SN_NSDL_EP_UPDATE_MESSAGE 2
+
+#define SN_NSDL_MSG_NO_TYPE 0
+#define SN_NSDL_MSG_REGISTER 1
+#define SN_NSDL_MSG_UNREGISTER 2
+#define SN_NSDL_MSG_UPDATE 3
+#define SN_NSDL_MSG_EVENT 4
+
+#define SN_NSDL_MAX_MESSAGE_COUNT 1
+
+#define SN_NSDL_ENDPOINT_NOT_REGISTERED 0
+#define SN_NSDL_ENDPOINT_IS_REGISTERED 1
+
+typedef struct sn_nsdl_ep_parameters_
+{
+ uint8_t *endpoint_name_ptr;
+ uint8_t endpoint_name_len;
+
+ uint8_t *domain_name_ptr;
+ uint8_t domain_name_len;
+
+ uint8_t *type_ptr;
+ uint8_t type_len;
+
+ uint8_t *contex_ptr;
+ uint8_t contex_len;
+
+ uint8_t *lifetime_ptr;
+ uint8_t lifetime_len;
+
+} sn_nsdl_ep_parameters_s;
+
+typedef struct sn_nsdl_sent_messages_
+{
+ uint16_t msg_id_number;
+ uint8_t message_type;
+}sn_nsdl_sent_messages_s;
+
+typedef struct sn_nsdl_mem_
+{
+ void *(*sn_nsdl_alloc)(uint16_t);
+ void (*sn_nsdl_free)(void *);
+}sn_nsdl_mem_s;
+
+typedef struct sn_grs_resource_
+{
+ uint8_t pathlen;
+ uint8_t *path;
+}sn_grs_resource_s;
+
+typedef struct sn_grs_resource_list_
+{
+ uint8_t res_count; /* Number of resources */
+ sn_grs_resource_s *res;
+}sn_grs_resource_list_s;
+
+typedef enum sn_nsdl_resource_mode_
+{
+ SN_GRS_STATIC,
+ SN_GRS_DYNAMIC,
+ SN_GRS_DIRECTORY
+}sn_nsdl_resource_mode_e;
+
+typedef enum sn_grs_resource_mutable_
+{
+ SN_GRS_GET = 0x01,
+ SN_GRS_POST = 0x02,
+ SN_GRS_PUT = 0x04,
+ SN_GRS_DELETE = 0x08
+}sn_grs_resource_mutable_e;
+
+typedef enum sn_grs_resource_acl_
+{
+ SN_GRS_GET_ALLOWED = 0x01 ,
+ SN_GRS_PUT_ALLOWED = 0x02,
+ SN_GRS_POST_ALLOWED = 0x04,
+ SN_GRS_DELETE_ALLOWED = 0x08
+}sn_grs_resource_acl_e;
+
+typedef struct sn_proto_info_
+{
+ sn_nsdl_capab_e proto;
+}sn_proto_info_s;
+
+typedef struct sn_nsdl_resource_parameters_
+{
+ uint8_t *resource_type_ptr;
+ uint16_t resource_type_len;
+
+ uint8_t *interface_description_ptr;
+ uint16_t interface_description_len;
+
+ uint8_t coap_content_type;
+
+ uint8_t mime_content_type;
+
+ uint8_t observable;
+
+ uint8_t registered;
+
+}sn_nsdl_resource_parameters_s;
+
+typedef struct sn_nsdl_resource_info_
+{
+ sn_nsdl_resource_parameters_s *resource_parameters_ptr;
+
+ sn_nsdl_resource_mode_e mode; // STATIC etc..
+
+ uint16_t pathlen; // Address
+ uint8_t *path;
+
+ uint16_t resourcelen; // 0 if dynamic resource, resource information in static resource
+ uint8_t *resource; // NULL if dynamic resource
+
+ sn_grs_resource_acl_e access;
+
+ uint8_t (*sn_grs_dyn_res_callback)(sn_coap_hdr_s *, sn_nsdl_addr_s *, sn_proto_info_s *);
+
+} sn_nsdl_resource_info_s;
+
+/**
+ * \fn extern int8_t sn_nsdl_init (uint8_t (*sn_nsdl_tx_cb)(sn_nsdl_capab_e , uint8_t *, uint16_t, sn_nsdl_addr_s *),
+ * uint8_t (*sn_nsdl_rx_cb)(sn_coap_hdr_s *, sn_nsdl_addr_s *),
+ * sn_nsdl_mem_s *sn_memory)
+ *
+ *
+ * \brief Initialization function for NSDL library. Initializes NSDL, GRS, HTTP and CoAP.
+ *
+ * \param *sn_nsdl_tx_callback A callback function for sending messages.
+ *
+ * \param *sn_nsdl_rx_callback A callback function for parsed messages. If received message is not CoAP protocol message (eg. ACK), message for GRS (GET, PUT, POST, DELETE) or
+ * reply for some NSDL message (register message etc.), rx callback will be called.
+ *
+ * \param *sn_memory Memory structure which includes function pointers to the allocation and free functions.
+ *
+ * \return SN_NSDL_SUCCESS = 0, Failed = -1
+ */
+int8_t sn_nsdl_init (uint8_t (*sn_nsdl_tx_cb)(sn_nsdl_capab_e , uint8_t *, uint16_t, sn_nsdl_addr_s *),
+ uint8_t (*sn_nsdl_rx_cb)(sn_coap_hdr_s *, sn_nsdl_addr_s *),
+ sn_nsdl_mem_s *sn_memory);
+
+/**
+ * \fn extern uint8_t sn_nsdl_register_endpoint(sn_nsdl_ep_parameters_s *endpoint_info_ptr)
+ *
+ *
+ * \brief Registers endpoint to NSP server.
+ *
+ * \param *endpoint_info_ptr Contains endpoint information.
+ *
+ * \return SN_NSDL_SUCCESS = 0, Failed = -1
+ */
+int8_t sn_nsdl_register_endpoint(sn_nsdl_ep_parameters_s *endpoint_info_ptr);
+
+/**
+ * \fn extern int8_t sn_nsdl_unregister_endpoint(void)
+ *
+ *
+ * \brief Sends unregister-message to NSP server.
+ *
+ * \return SN_NSDL_SUCCESS = 0, Failed = -1
+ */
+int8_t sn_nsdl_unregister_endpoint(void);
+int8_t sn_nsdl_update_registration (sn_nsdl_ep_parameters_s *endpoint_parameters_ptr);
+int8_t sn_nsdl_send_eventing_message (uint8_t *event_name_ptr, uint16_t event_name_len, uint8_t *message_body_ptr, uint16_t message_body_len);
+
+/**
+ * \fn extern int8_t sn_nsdl_is_ep_registered(void)
+ *
+ *
+ * \brief Checks if endpoint is registered.
+ *
+ * \return 1 if endpointi registration is done SN_NSDL_SUCCESSfully, 0 if endpoint is not registered
+ */
+int8_t sn_nsdl_is_ep_registered(void);
+
+/*
+ * A function to inform NSDL-C library if application detects a fault in NSP registration. After calling this function
+ * , sn_nsdl_is_ep_registered() will return "not registered".
+ */
+void sn_nsdl_nsp_lost(void);
+/**
+ * \fn extern int8_t sn_nsdl_send_observation_notification(uint8_t *token_ptr, uint8_t token_len,
+ * uint8_t *payload_ptr, uint16_t payload_len,
+ * uint8_t *observe_ptr, uint8_t observe_len)
+ *
+ *
+ * \brief Sends observation message to NSP server
+ *
+ * \param *token_ptr Pointer to token to be used
+ * \param token_len Token length
+ * \param *payload_ptr Pointer to payload to be sent
+ * \param payload_len Payload length
+ * \param *observe_ptr Pointer to observe number to be sent
+ * \param observe_len Observe number len
+ *
+ * \return SN_NSDL_SUCCESS = 0, Failed = -1
+ */
+extern uint16_t sn_nsdl_send_observation_notification(uint8_t *token_ptr, uint8_t token_len, uint8_t *payload_ptr, uint16_t payload_len, uint8_t *observe_ptr, uint8_t observe_len, sn_coap_msg_type_e message_type, uint8_t content_type);
+int16_t sn_nsdl_get_capability(void);
+uint32_t sn_nsdl_get_version(void);
+int8_t sn_nsdl_process_http(uint8_t *packet, uint16_t *packet_len, sn_nsdl_addr_s *src);
+int8_t sn_nsdl_process_coap(uint8_t *packet, uint16_t packet_len, sn_nsdl_addr_s *src);
+int8_t sn_nsdl_exec(uint32_t time);
+int8_t sn_nsdl_create_resource(sn_nsdl_resource_info_s *res);
+int8_t sn_nsdl_update_resource(sn_nsdl_resource_info_s *res);
+int8_t sn_nsdl_delete_resource(uint8_t pathlen, uint8_t *path);
+sn_nsdl_resource_info_s *sn_nsdl_get_resource(uint8_t pathlen, uint8_t *path);
+sn_grs_resource_list_s *sn_nsdl_list_resource(uint8_t pathlen, uint8_t *path);
+int8_t sn_nsdl_send_coap_message(sn_nsdl_addr_s *address_ptr, sn_coap_hdr_s *coap_hdr_ptr);
+/**
+ * \brief This function is used to set the NSP address given by an application.
+ * @return 0 on success, -1 on false to indicate that NSDL internal address pointer is not allocated (call nsdl_init() first).
+ */
+int8_t set_NSP_address(uint8_t *NSP_address, uint16_t port, sn_nsdl_addr_type_e address_type);
+
+/**
+ * \brief This function releases all allocated memory in nsdl and grs modules.
+ */
+extern int8_t sn_nsdl_destroy(void);
+
+/*
+ * \brief A function to request SN internal version information out of NSDL library in case of "error reporting" or similar.
+ * @return A string with \0 in the end. A human readable format. Please deliver this item to Sensinode in case if you're to report of errors.
+ */
+//extern const char __code * sn_nsdl_get_library_version_info(void);
+
+#ifdef __cplusplus
+}
+#endif
