Add application definable context to nsdl handle (#96)

Added application definable context field to nsdl handle. This is useful for example when interfacing with c++ objects where a pointer to object is set as the context, and in the callback functions the context pointer can be used to call methods for the correct instance of the c++ object.

Author: Jaakko Kukkohovi

nsdl-c/sn_nsdl_lib.h

@@ -723,6 +723,35 @@ extern int8_t sn_nsdl_set_block_size(struct nsdl_s *handle, uint16_t block_size)
  */
 extern int8_t sn_nsdl_set_duplicate_buffer_size(struct nsdl_s *handle, uint8_t message_count);
 
+/**
+ * \fn void *sn_nsdl_set_context(const struct nsdl_s *handle, void *context)
+ *
+ * \brief Set the application defined context parameter for given handle.
+ *        This is useful for example when interfacing with c++ objects where a
+ *        pointer to object is set as the context, and in the callback functions
+ *        the context pointer can be used to call methods for the correct instance
+ *        of the c++ object.
+ *
+ * \param *handle Pointer to library handle
+ * \param *context Pointer to the application defined context
+ * \return 0 = success, -1 = failure
+ */
+extern int8_t sn_nsdl_set_context(struct nsdl_s * const handle, void * const context);
+
+/**
+ * \fn void *sn_nsdl_get_context(const struct nsdl_s *handle)
+ *
+ * \brief Get the application defined context parameter for given handle.
+ *        This is useful for example when interfacing with c++ objects where a
+ *        pointer to object is set as the context, and in the callback functions
+ *        the context pointer can be used to call methods for the correct instance
+ *        of the c++ object.
+ *
+ * \param *handle Pointer to library handle
+ * \return Pointer to the application defined context
+ */
+extern void *sn_nsdl_get_context(const struct nsdl_s * const handle);
+
 #ifdef __cplusplus
 }
 #endif

source/libNsdl/src/include/sn_grs.h

@@ -79,6 +79,9 @@ struct nsdl_s {
     uint8_t *oma_bs_address_ptr;                                                /* Bootstrap address pointer. If null, no bootstrap in use */
     sn_nsdl_ep_parameters_s *ep_information_ptr;                                // Endpoint parameters, Name, Domain etc..
     sn_nsdl_oma_server_info_t *nsp_address_ptr;                                 // NSP server address information
+    /* Application definable context. This is useful for example when interfacing with c++ objects where a pointer to object is set as the
+     * context, and in the callback functions the context pointer can be used to call methods for the correct instance of the c++ object. */
+    void *context;
 
     void (*sn_nsdl_oma_bs_done_cb)(sn_nsdl_oma_server_info_t *server_info_ptr); /* Callback to inform application when bootstrap is done */
     void *(*sn_nsdl_alloc)(uint16_t);

source/libNsdl/src/sn_nsdl.c

@@ -223,6 +223,8 @@ struct nsdl_s *sn_nsdl_init(uint8_t (*sn_nsdl_tx_cb)(struct nsdl_s *, sn_nsdl_ca
     handle->sn_nsdl_endpoint_registered = SN_NSDL_ENDPOINT_NOT_REGISTERED;
     // By default bootstrap msgs are handled in nsdl
     handle->handle_bootstrap_msg = true;
+    handle->context = NULL;
+
     return handle;
 }
 
@@ -2585,3 +2587,20 @@ bool sn_nsdl_check_uint_overflow(uint16_t resource_size, uint16_t param_a, uint1
         }
     }
 }
+
+extern int8_t sn_nsdl_set_context(struct nsdl_s * const handle, void * const context)
+{
+    if (handle == NULL) {
+        return SN_NSDL_FAILURE;
+    }
+    handle->context = context;
+    return SN_NSDL_SUCCESS;
+}
+
+extern void *sn_nsdl_get_context(const struct nsdl_s * const handle)
+{
+    if (handle == NULL) {
+        return NULL;
+    }
+    return handle->context;
+}

test/nsdl-c/unittest/sn_nsdl/sn_nsdltest.cpp

@@ -186,5 +186,14 @@ TEST(sn_nsdl, test_sn_nsdl_set_duplicate_buffer_size)
     CHECK(test_sn_nsdl_set_duplicate_buffer_size());
 }
 
+TEST(sn_nsdl, test_sn_nsdl_get_context)
+{
+    CHECK(test_sn_nsdl_get_context());
+}
+
+TEST(sn_nsdl, test_sn_nsdl_set_context)
+{
+    CHECK(test_sn_nsdl_set_context());
+}
 
 

test/nsdl-c/unittest/sn_nsdl/test_sn_nsdl.c

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2015 ARM. All rights reserved.
+* Copyright (c) 2015 ARM. All rights reserved.
  */
 #include "test_sn_nsdl.h"
 #include <string.h>
@@ -2972,3 +2972,51 @@ bool test_sn_nsdl_set_duplicate_buffer_size()
     sn_nsdl_destroy(handle);
     return true;
 }
+
+bool test_sn_nsdl_set_context()
+{
+    struct nsdl_s* handle = NULL;
+    if (sn_nsdl_set_context(handle,NULL) == 0){
+        printf("\n\neka\n\n");
+        return false;
+    }
+    retCounter = 4;
+    sn_grs_stub.expectedGrs = (struct grs_s *)malloc(sizeof(struct grs_s));
+    memset(sn_grs_stub.expectedGrs,0, sizeof(struct grs_s));
+    handle = sn_nsdl_init(&nsdl_tx_callback, &nsdl_rx_callback, &myMalloc, &myFree);
+
+    if (sn_nsdl_set_context(handle,NULL) != 0){
+        printf("\n\ntoka\n\n");
+        return false;
+    }
+
+    int somecontext = 1;
+    if (sn_nsdl_set_context(handle,&somecontext) != 0){
+        printf("\n\nkolmas\n\n");
+        return false;
+    }
+    sn_nsdl_destroy(handle);
+    return true;
+}
+
+bool test_sn_nsdl_get_context()
+{
+    struct nsdl_s* handle = NULL;
+    if (sn_nsdl_get_context(handle) != NULL){
+        return false;
+    }
+
+    retCounter = 4;
+    sn_grs_stub.expectedGrs = (struct grs_s *)malloc(sizeof(struct grs_s));
+    memset(sn_grs_stub.expectedGrs,0, sizeof(struct grs_s));
+    handle = sn_nsdl_init(&nsdl_tx_callback, &nsdl_rx_callback, &myMalloc, &myFree);
+
+    int somecontext = 1;
+    sn_nsdl_set_context(handle,&somecontext);
+    if (sn_nsdl_get_context(handle) != &somecontext){
+        return false;
+    }
+
+    sn_nsdl_destroy(handle);
+    return true;
+}

test/nsdl-c/unittest/sn_nsdl/test_sn_nsdl.h

@@ -78,6 +78,10 @@ bool test_sn_nsdl_set_block_size();
 
 bool test_sn_nsdl_set_duplicate_buffer_size();
 
+bool test_sn_nsdl_set_context();
+
+bool test_sn_nsdl_get_context();
+
 #ifdef __cplusplus
 }
 #endif