Clarify function signature

Use coap_msg_process_cb typedef to clarify function signature

Author: Arto Kinnunen

source/coap_message_handler.c

@@ -294,7 +294,7 @@ coap_transaction_t *coap_message_handler_find_transaction(uint8_t *address_ptr,
 }
 
 int16_t coap_message_handler_coap_msg_process(coap_msg_handler_t *handle, int8_t socket_id, int8_t recv_if_id, const uint8_t source_addr_ptr[static 16], uint16_t port, const uint8_t dst_addr_ptr[static 16],
-                                              uint8_t *data_ptr, uint16_t data_len, int16_t (msg_process_callback)(int8_t, int8_t, sn_coap_hdr_s *, coap_transaction_t *, const uint8_t *))
+                                              uint8_t *data_ptr, uint16_t data_len,  coap_msg_process_cb *msg_process_callback)
 {
     sn_nsdl_addr_s src_addr;
     sn_coap_hdr_s *coap_message;

source/include/coap_message_handler.h

@@ -49,9 +49,7 @@ typedef int coap_message_handler_response_recv(int8_t service_id, uint8_t source
 typedef struct coap_msg_handler_s {
     void *(*sn_coap_service_malloc)(uint16_t);
     void (*sn_coap_service_free)(void *);
-
     uint8_t (*sn_coap_tx_callback)(uint8_t *, uint16_t, sn_nsdl_addr_s *, void *);
-
     struct coap_s *coap;
 } coap_msg_handler_t;
 
@@ -74,6 +72,20 @@ typedef struct coap_transaction {
     ns_list_link_t link;
 } coap_transaction_t;
 
+/**
+ * \brief Service message processing callback.
+ *
+ * Function that processes CoAP service message
+ *
+ * \param socket_id         Socket that receives the message.
+ * \param recv_if_id        Interface where message is received.
+ * \param coap_message      Actual CoAP message.
+ * \param transaction_ptr   Message transaction.
+ * \param local_addr        Address where message is received.
+ *
+ * \return 0 for success / -1 for failure
+  */
+typedef int16_t coap_msg_process_cb(int8_t socket_id, int8_t recv_if_id, sn_coap_hdr_s *coap_message, coap_transaction_t *transaction_ptr, const uint8_t * local_addr);
 
 extern coap_msg_handler_t *coap_message_handler_init(void *(*used_malloc_func_ptr)(uint16_t), void (*used_free_func_ptr)(void *),
                                                      uint8_t (*used_tx_callback_ptr)(uint8_t *, uint16_t, sn_nsdl_addr_s *, void *));
@@ -84,9 +96,8 @@ extern coap_transaction_t *coap_message_handler_transaction_valid(coap_transacti
 
 extern coap_transaction_t *coap_message_handler_find_transaction(uint8_t *address_ptr, uint16_t port);
 
-extern int16_t coap_message_handler_coap_msg_process(coap_msg_handler_t *handle, int8_t socket_id, int8_t source_if_id, const uint8_t source_addr_ptr[static 16], uint16_t port,
-                                                    const uint8_t dst_addr_ptr[static 16], uint8_t *data_ptr, uint16_t data_len,
-                                                    int16_t (msg_process_callback)(int8_t, int8_t, sn_coap_hdr_s *, coap_transaction_t *, const uint8_t *));
+extern int16_t coap_message_handler_coap_msg_process(coap_msg_handler_t *handle, int8_t socket_id, int8_t recv_if_id, const uint8_t source_addr_ptr[static 16], uint16_t port,
+                                                    const uint8_t dst_addr_ptr[static 16], uint8_t *data_ptr, uint16_t data_len, coap_msg_process_cb *msg_process_callback);
 
 extern uint16_t coap_message_handler_request_send(coap_msg_handler_t *handle, int8_t service_id, uint8_t options, const uint8_t destination_addr[static 16],
                                                   uint16_t destination_port, sn_coap_msg_type_e msg_type, sn_coap_msg_code_e msg_code, const char *uri, sn_coap_content_format_e cont_type,

test/coap-service/unittest/coap_service_api/test_coap_service_api.c

@@ -417,8 +417,8 @@ bool test_conn_handler_callbacks()
 
         //This could be moved to own test function,
         //but thread_conn_handler_stub.receive_from_sock_cb must be called successfully
-        if (coap_message_handler_stub.cb) {
-            if (-1 != coap_message_handler_stub.cb(1, 1, NULL, NULL, local_addr)) {
+        if (coap_message_handler_stub.msg_process_cb) {
+            if (-1 != coap_message_handler_stub.msg_process_cb(1, 1, NULL, NULL, local_addr)) {
                 return false;
             }
 
@@ -429,7 +429,7 @@ bool test_conn_handler_callbacks()
             coap->uri_path_ptr = &uri;
             coap->uri_path_len = 2;
 
-            if (-1 != coap_message_handler_stub.cb(1, 1, coap, NULL, local_addr)) {
+            if (-1 != coap_message_handler_stub.msg_process_cb(1, 1, coap, NULL, local_addr)) {
                 return false;
             }
 
@@ -439,7 +439,7 @@ bool test_conn_handler_callbacks()
                 return false;
             }
 
-            if (-1 != coap_message_handler_stub.cb(1, 1, coap, NULL, local_addr)) {
+            if (-1 != coap_message_handler_stub.msg_process_cb(1, 1, coap, NULL, local_addr)) {
                 return false;
             }
 
@@ -451,15 +451,15 @@ bool test_conn_handler_callbacks()
                 return false;
             }
 
-            if (-1 != coap_message_handler_stub.cb(1, 1, coap, tr, local_addr)) {
+            if (-1 != coap_message_handler_stub.msg_process_cb(1, 1, coap, tr, local_addr)) {
                 return false;
             }
 
             if (0 != coap_service_msg_prevalidate_callback_set(2, NULL)) {
                 return false;
             }
 
-            if (2 != coap_message_handler_stub.cb(1, 1, coap, tr, local_addr)) {
+            if (2 != coap_message_handler_stub.msg_process_cb(1, 1, coap, tr, local_addr)) {
                 return false;
             }
 

test/coap-service/unittest/stub/coap_connection_handler_stub.c

@@ -33,7 +33,7 @@ int coap_connection_handler_virtual_recv(coap_conn_handler_t *handler, uint8_t a
     return thread_conn_handler_stub.int_value;
 }
 
-coap_conn_handler_t *connection_handler_create(int (*recv_cb)(int8_t socket_id, int8_t source_if_id, uint8_t src_address[static 16], uint16_t port, const uint8_t dst_address[static 16], unsigned char *, int),
+coap_conn_handler_t *connection_handler_create(int (*recv_cb)(int8_t socket_id, int8_t recv_if_id, uint8_t src_address[static 16], uint16_t port, const uint8_t dst_address[static 16], unsigned char *, int),
                                                int (*send_cb)(int8_t socket_id, uint8_t const address[static 16], uint16_t port, const void *, int),
                                                int (*pw_cb)(int8_t socket_id, uint8_t address[static 16], uint16_t port, coap_security_keys_t *security_ptr),
                                                void(*done_cb)(int8_t socket_id, uint8_t address[static 16], uint16_t port, uint8_t keyblock[static KEY_BLOCK_LEN]))

test/coap-service/unittest/stub/coap_connection_handler_stub.h

@@ -33,7 +33,7 @@ typedef struct {
     cch_func_cb *cch_function_callback;
 
     int (*send_to_sock_cb)(int8_t socket_id, uint8_t address[static 16], uint16_t port, const void *, int);
-    int (*receive_from_sock_cb)(int8_t socket_id, int8_t source_if_id, uint8_t src_address[static 16], uint16_t port, const uint8_t dst_address[static 16], unsigned char *, int);
+    int (*receive_from_sock_cb)(int8_t socket_id, int8_t recv_if_id, uint8_t src_address[static 16], uint16_t port, const uint8_t dst_address[static 16], unsigned char *, int);
     int (*get_passwd_cb)(int8_t socket_id, uint8_t address[static 16], uint16_t port, coap_security_keys_t *security_ptr);
     void (*sec_done_cb)(int8_t socket_id, uint8_t address[static 16], uint16_t port, uint8_t keyblock[static 40]);
 

test/coap-service/unittest/stub/coap_message_handler_stub.c

@@ -55,10 +55,10 @@ coap_transaction_t *coap_message_handler_find_transaction(uint8_t *address_ptr,
     return coap_message_handler_stub.coap_tx_ptr;
 }
 
-int16_t coap_message_handler_coap_msg_process(coap_msg_handler_t *handle, int8_t socket_id, int8_t source_if_id, const uint8_t source_addr_ptr[static 16], uint16_t port, const uint8_t dst_addr_ptr[static 16],
-                                              uint8_t *data_ptr, uint16_t data_len, int16_t (cb)(int8_t, int8_t, sn_coap_hdr_s *, coap_transaction_t *, const uint8_t *))
+extern int16_t coap_message_handler_coap_msg_process(coap_msg_handler_t *handle, int8_t socket_id, int8_t recv_if_id, const uint8_t source_addr_ptr[static 16], uint16_t port,
+                                                    const uint8_t dst_addr_ptr[static 16], uint8_t *data_ptr, uint16_t data_len, coap_msg_process_cb *msg_process_callback)
 {
-    coap_message_handler_stub.cb = cb;
+    coap_message_handler_stub.msg_process_cb = msg_process_callback;
     return coap_message_handler_stub.int16_value;
 }
 

test/coap-service/unittest/stub/coap_message_handler_stub.h

@@ -31,7 +31,7 @@ typedef struct {
     uint16_t uint16_value;
     coap_msg_handler_t *coap_ptr;
     coap_transaction_t *coap_tx_ptr;
-    int16_t (*cb)(int8_t, int8_t, sn_coap_hdr_s *, coap_transaction_t *, const uint8_t *);
+    coap_msg_process_cb *msg_process_cb;
 } coap_message_handler_stub_def;
 
 extern coap_message_handler_stub_def coap_message_handler_stub;