Cellular: AT remove_urc_handler changed to set_urc_handler(prefix, 0)

Author: Ari Parkkila

UNITTESTS/features/cellular/framework/AT/athandler/athandlertest.cpp

@@ -174,8 +174,7 @@ TEST_F(TestATHandler, test_ATHandler_remove_urc_handler)
     mbed::Callback<void()> cb(&urc_callback);
     at.set_urc_handler(ch, cb);
 
-    //This does nothing!!!
-    at.remove_urc_handler(ch);
+    at.set_urc_handler(ch, 0);
 }
 
 TEST_F(TestATHandler, test_ATHandler_get_last_error)
@@ -996,10 +995,10 @@ TEST_F(TestATHandler, test_ATHandler_resp_start)
     filehandle_stub_table = table9;
     filehandle_stub_table_pos = 0;
 
+    at.set_urc_handler("urc: ", &urc_callback);
     at.set_urc_handler("urc: ", NULL);
     at.resp_start();
-    // Match URC consumes to CRLF -> nothing to read after that -> ERROR
-    EXPECT_TRUE(at.get_last_error() == NSAPI_ERROR_DEVICE_ERROR);
+    EXPECT_EQ(at.get_last_error(), NSAPI_ERROR_OK);
 
     char table10[] = "urc: info\r\ngarbage\r\nprefix: info\r\nOK\r\n\0";
     at.flush();

features/cellular/framework/AT/ATHandler.cpp

@@ -160,8 +160,13 @@ void ATHandler::set_is_filehandle_usable(bool usable)
     _is_fh_usable = usable;
 }
 
-nsapi_error_t ATHandler::set_urc_handler(const char *prefix, mbed::Callback<void()> callback)
+nsapi_error_t ATHandler::set_urc_handler(const char *prefix, Callback<void()> callback)
 {
+    if (!callback) {
+        remove_urc_handler(prefix);
+        return NSAPI_ERROR_OK;
+    }
+
     if (find_urc_handler(prefix)) {
         tr_warn("URC already added with prefix: %s", prefix);
         return NSAPI_ERROR_OK;
@@ -311,7 +316,7 @@ void ATHandler::process_oob()
 
 void ATHandler::set_filehandle_sigio()
 {
-    _fileHandle->sigio(mbed::Callback<void()>(this, &ATHandler::event));
+    _fileHandle->sigio(Callback<void()>(this, &ATHandler::event));
 }
 
 void ATHandler::reset_buffer()

features/cellular/framework/AT/ATHandler.h

@@ -120,20 +120,13 @@ class ATHandler {
      */
     nsapi_error_t unlock_return_error();
 
-    /** Set the urc callback for urc. If urc is found when parsing AT responses, then call if called.
-     *  If urc is already set then it's not set twice.
+    /** Set callback function for URC
      *
-     *  @param prefix   Register urc prefix for callback. Urc could be for example "+CMTI: "
-     *  @param callback Callback, which is called if urc is found in AT response
+     *  @param prefix   URC text to look for, e.g. "+CMTI:"
+     *  @param callback function to call on prefix, or 0 to remove callback
      *  @return NSAPI_ERROR_OK or NSAPI_ERROR_NO_MEMORY if no memory
      */
-    nsapi_error_t set_urc_handler(const char *prefix, mbed::Callback<void()> callback);
-
-    /** Remove urc handler from linked list of urc's
-     *
-     *  @param prefix   Register urc prefix for callback. Urc could be for example "+CMTI: "
-     */
-    void remove_urc_handler(const char *prefix);
+    nsapi_error_t set_urc_handler(const char *prefix, Callback<void()> callback);
 
     ATHandler *_nextATHandler; // linked list
 
@@ -229,6 +222,11 @@ class ATHandler {
 #endif
     FileHandle *_fileHandle;
 private:
+    /** Remove urc handler from linked list of urc's
+     *
+     *  @param prefix   Register urc prefix for callback. Urc could be for example "+CMTI: "
+     */
+    void remove_urc_handler(const char *prefix);
 
     void set_error(nsapi_error_t err);
 
@@ -242,7 +240,7 @@ class ATHandler {
     struct oob_t {
         const char *prefix;
         int prefix_len;
-        mbed::Callback<void()> cb;
+        Callback<void()> cb;
         oob_t *next;
     };
     oob_t *_oobs;

features/cellular/framework/AT/AT_CellularNetwork.cpp

@@ -104,12 +104,12 @@ AT_CellularNetwork::~AT_CellularNetwork()
 
     for (int type = 0; type < CellularNetwork::C_MAX; type++) {
         if (has_registration((RegistrationType)type) != RegistrationModeDisable) {
-            _at.remove_urc_handler(at_reg[type].urc_prefix);
+            _at.set_urc_handler(at_reg[type].urc_prefix, 0);
         }
     }
 
-    _at.remove_urc_handler("NO CARRIER");
-    _at.remove_urc_handler("+CGEV:");
+    _at.set_urc_handler("NO CARRIER", 0);
+    _at.set_urc_handler("+CGEV:", 0);
 }
 
 void AT_CellularNetwork::urc_no_carrier()

features/cellular/framework/targets/GEMALTO/CINTERION/GEMALTO_CINTERION_CellularStack.cpp

@@ -39,9 +39,9 @@ GEMALTO_CINTERION_CellularStack::GEMALTO_CINTERION_CellularStack(ATHandler &atHa
 
 GEMALTO_CINTERION_CellularStack::~GEMALTO_CINTERION_CellularStack()
 {
-    _at.remove_urc_handler("^SIS:");
-    _at.remove_urc_handler("^SISW:");
-    _at.remove_urc_handler("^SISR:");
+    _at.set_urc_handler("^SIS:", 0);
+    _at.set_urc_handler("^SISW:", 0);
+    _at.set_urc_handler("^SISR:", 0);
 }
 
 GEMALTO_CINTERION_CellularStack::CellularSocket *GEMALTO_CINTERION_CellularStack::find_socket(int sock_id)

features/cellular/framework/targets/QUECTEL/BG96/QUECTEL_BG96_CellularPower.cpp

@@ -32,5 +32,5 @@ nsapi_error_t QUECTEL_BG96_CellularPower::set_device_ready_urc_cb(mbed::Callback
 
 void QUECTEL_BG96_CellularPower::remove_device_ready_urc_cb(mbed::Callback<void()> callback)
 {
-    _at.remove_urc_handler(DEVICE_READY_URC);
+    _at.set_urc_handler(DEVICE_READY_URC, 0);
 }