Cellular: Refactor get_max_socket_count() into CellularProperty

Author: Ari Parkkila

UNITTESTS/features/cellular/framework/AT/at_cellularcontext/at_cellularcontexttest.cpp

@@ -77,10 +77,6 @@ class TestAT_CellularContext : public testing::Test {
 class my_stack : public AT_CellularStack {
 public:
     my_stack(ATHandler &atHandler, AT_CellularDevice &device) : AT_CellularStack(atHandler, 1, IPV4_STACK, device) {}
-    virtual int get_max_socket_count()
-    {
-        return 1;
-    }
     virtual int get_max_packet_size()
     {
         return 200;

UNITTESTS/features/cellular/framework/AT/at_cellularstack/at_cellularstacktest.cpp

@@ -26,6 +26,7 @@
 #include "ATHandler_stub.h"
 #include "SocketAddress.h"
 #include "CellularDevice_stub.h"
+#include "AT_CellularDevice_stub.h"
 #include "myCellularDevice.h"
 
 using namespace mbed;
@@ -34,22 +35,15 @@ using namespace events;
 class MyStack : public AT_CellularStack {
 public:
     bool bool_value;
-    bool max_sock_value;
     nsapi_error_t create_error;
     CellularSocket socket;
 
     MyStack(ATHandler &atr, int cid, nsapi_ip_stack_t typ, AT_CellularDevice &device) : AT_CellularStack(atr, cid, typ, device)
     {
         bool_value = false;
-        max_sock_value = 0;
         create_error = NSAPI_ERROR_OK;
     }
 
-    virtual int get_max_socket_count()
-    {
-        return max_sock_value;
-    }
-
     virtual bool is_protocol_supported(nsapi_protocol_t protocol)
     {
         return bool_value;
@@ -211,15 +205,17 @@ TEST_F(TestAT_CellularStack, test_AT_CellularStack_socket_open)
     EXPECT_EQ(st.socket_open(NULL, NSAPI_TCP), NSAPI_ERROR_UNSUPPORTED);
 
     st.bool_value = true;
-    st.max_sock_value = 0;
+    AT_CellularDevice_stub::max_sock_value = 0;
     nsapi_socket_t sock = &st.socket;
     EXPECT_EQ(st.socket_open(&sock, NSAPI_TCP), NSAPI_ERROR_NO_SOCKET);
 
     MyStack st2(at, 0, IPV6_STACK, *_dev);
     st2.bool_value = true;
-    st2.max_sock_value = 1;
+    AT_CellularDevice_stub::max_sock_value = 1;
     sock = &st2.socket;
     EXPECT_EQ(st2.socket_open(&sock, NSAPI_TCP), NSAPI_ERROR_OK);
+
+    AT_CellularDevice_stub::max_sock_value = 0;
 }
 
 TEST_F(TestAT_CellularStack, test_AT_CellularStack_socket_close)
@@ -233,13 +229,13 @@ TEST_F(TestAT_CellularStack, test_AT_CellularStack_socket_close)
 
     nsapi_socket_t sock = &st.socket;
     st.bool_value = true;
-    st.max_sock_value = 1;
+    AT_CellularDevice_stub::max_sock_value = 1;
     EXPECT_EQ(st.socket_open(&sock, NSAPI_TCP), NSAPI_ERROR_OK);
-    st.max_sock_value = 0;
+    AT_CellularDevice_stub::max_sock_value = 0;
     EXPECT_EQ(st.socket_close(sock), NSAPI_ERROR_DEVICE_ERROR);
 
     MyStack st2(at, 0, IPV6_STACK, *_dev);
-    st2.max_sock_value = 1;
+    AT_CellularDevice_stub::max_sock_value = 1;
     st2.bool_value = true;
     sock = &st2.socket;
     EXPECT_EQ(st2.socket_open(&sock, NSAPI_TCP), NSAPI_ERROR_OK);
@@ -306,7 +302,7 @@ TEST_F(TestAT_CellularStack, test_AT_CellularStack_socket_send)
     EXPECT_EQ(st.socket_send(&st.socket, "addr", 4), NSAPI_ERROR_NO_CONNECTION);
 
     SocketAddress addr("fc00::", 123);
-    st.max_sock_value = 1;
+    AT_CellularDevice_stub::max_sock_value = 1;
     st.bool_value = true;
     nsapi_socket_t sock = &st.socket;
     st.socket_open(&sock, NSAPI_TCP);
@@ -325,7 +321,7 @@ TEST_F(TestAT_CellularStack, test_AT_CellularStack_socket_sendto)
     SocketAddress addr("fc00::", 123);
     EXPECT_EQ(st.socket_sendto(NULL, addr, "addr", 4), NSAPI_ERROR_NO_SOCKET);
 
-    st.max_sock_value = 1;
+    AT_CellularDevice_stub::max_sock_value = 1;
     st.bool_value = true;
     nsapi_socket_t sock = &st.socket;
     st.socket_open(&sock, NSAPI_TCP);
@@ -359,7 +355,7 @@ TEST_F(TestAT_CellularStack, test_AT_CellularStack_socket_recvfrom)
     EXPECT_EQ(st.socket_recvfrom(NULL, NULL, table, 4), NSAPI_ERROR_NO_SOCKET);
 
     SocketAddress addr;
-    st.max_sock_value = 1;
+    AT_CellularDevice_stub::max_sock_value = 1;
     st.bool_value = true;
     nsapi_socket_t sock = &st.socket;
     st.socket_open(&sock, NSAPI_TCP);
@@ -380,7 +376,7 @@ TEST_F(TestAT_CellularStack, test_AT_CellularStack_socket_attach)
     MyStack st(at, 0, IPV6_STACK, *_dev);
 
     st.socket_attach(NULL, NULL, NULL);
-    st.max_sock_value = 1;
+    AT_CellularDevice_stub::max_sock_value = 1;
     st.bool_value = true;
     nsapi_socket_t sock = &st.socket;
     st.socket_open(&sock, NSAPI_TCP);

UNITTESTS/stubs/AT_CellularDevice_stub.cpp

@@ -31,6 +31,7 @@ int AT_CellularDevice_stub::set_pin_failure_count = 0;
 int AT_CellularDevice_stub::get_sim_failure_count = 0;
 bool AT_CellularDevice_stub::pin_needed = false;
 bool AT_CellularDevice_stub::supported_bool = false;
+int AT_CellularDevice_stub::max_sock_value = 0;
 
 AT_CellularDevice::AT_CellularDevice(FileHandle *fh) : CellularDevice(fh),
 #if MBED_CONF_CELLULAR_USE_SMS
@@ -293,6 +294,8 @@ intptr_t AT_CellularDevice::get_property(CellularProperty key)
         return true;
     } else if (key == PROPERTY_IPV4_PDP_TYPE) {
         return true;
+    } else if (key == PROPERTY_SOCKET_COUNT) {
+        return AT_CellularDevice_stub::max_sock_value;
     }
 
     return AT_CellularDevice_stub::supported_bool;

UNITTESTS/stubs/AT_CellularDevice_stub.h

@@ -28,6 +28,7 @@ extern int set_pin_failure_count;
 extern int get_sim_failure_count;
 extern bool pin_needed;
 extern bool supported_bool;
+extern int max_sock_value;
 }
 
 

features/cellular/framework/AT/AT_CellularDevice.h

@@ -58,7 +58,7 @@ class AT_CellularDevice : public CellularDevice {
         PROPERTY_NON_IP_PDP_TYPE,       // 0 = not supported, 1 = supported. Does modem support Non-IP?
         PROPERTY_AT_CGEREP,             // 0 = not supported, 1 = supported. Does modem support AT command AT+CGEREP.
         PROPERTY_AT_COPS_FALLBACK_AUTO, // 0 = not supported, 1 = supported. Does modem support mode 4 of AT+COPS= ?
-
+        PROPERTY_SOCKET_COUNT,          // The number of sockets of modem IP stack
         PROPERTY_MAX
     };
 

features/cellular/framework/AT/AT_CellularStack.cpp

@@ -25,30 +25,29 @@ using namespace mbed_cellular_util;
 using namespace mbed;
 
 AT_CellularStack::AT_CellularStack(ATHandler &at, int cid, nsapi_ip_stack_t stack_type, AT_CellularDevice &device) :
-    _socket(NULL), _socket_count(0), _cid(cid),
+    _socket(NULL), _cid(cid),
     _stack_type(stack_type), _ip_ver_sendto(NSAPI_UNSPEC), _at(at), _device(device)
 {
     memset(_ip, 0, PDP_IPV6_SIZE);
 }
 
 AT_CellularStack::~AT_CellularStack()
 {
-    for (int i = 0; i < _socket_count; i++) {
-        if (_socket[i]) {
-            delete _socket[i];
-            _socket[i] = NULL;
+    if (_socket) {
+        for (int i = 0; i < _device.get_property(AT_CellularDevice::PROPERTY_SOCKET_COUNT); i++) {
+            if (_socket[i]) {
+                delete _socket[i];
+                _socket[i] = NULL;
+            }
         }
+        delete [] _socket;
+        _socket = NULL;
     }
-    _socket_count = 0;
-
-    delete [] _socket;
-    _socket = NULL;
 }
 
 int AT_CellularStack::find_socket_index(nsapi_socket_t handle)
 {
-    int max_socket_count = get_max_socket_count();
-    for (int i = 0; i < max_socket_count; i++) {
+    for (int i = 0; i < _device.get_property(AT_CellularDevice::PROPERTY_SOCKET_COUNT); i++) {
         if (_socket[i] == handle) {
             return i;
         }
@@ -162,8 +161,6 @@ nsapi_error_t AT_CellularStack::socket_open(nsapi_socket_t *handle, nsapi_protoc
         return NSAPI_ERROR_UNSUPPORTED;
     }
 
-    int max_socket_count = get_max_socket_count();
-
     _socket_mutex.lock();
 
     if (!_socket) {
@@ -172,9 +169,8 @@ nsapi_error_t AT_CellularStack::socket_open(nsapi_socket_t *handle, nsapi_protoc
             return NSAPI_ERROR_NO_SOCKET;
         }
 
-        _socket = new CellularSocket*[max_socket_count];
-        _socket_count = max_socket_count;
-        for (int i = 0; i < max_socket_count; i++) {
+        _socket = new CellularSocket*[_device.get_property(AT_CellularDevice::PROPERTY_SOCKET_COUNT)];
+        for (int i = 0; i < _device.get_property(AT_CellularDevice::PROPERTY_SOCKET_COUNT); i++) {
             _socket[i] = 0;
         }
     }
@@ -435,8 +431,7 @@ void AT_CellularStack::socket_attach(nsapi_socket_t handle, void (*callback)(voi
 
 int AT_CellularStack::get_socket_index_by_port(uint16_t port)
 {
-    int max_socket_count = get_max_socket_count();
-    for (int i = 0; i < max_socket_count; i++) {
+    for (int i = 0; i < _device.get_property(AT_CellularDevice::PROPERTY_SOCKET_COUNT); i++) {
         if (_socket[i]->localAddress.get_port() == port) {
             return i;
         }
@@ -447,7 +442,7 @@ int AT_CellularStack::get_socket_index_by_port(uint16_t port)
 AT_CellularStack::CellularSocket *AT_CellularStack::find_socket(int sock_id)
 {
     CellularSocket *sock = NULL;
-    for (int i = 0; i < _socket_count; i++) {
+    for (int i = 0; i < _device.get_property(AT_CellularDevice::PROPERTY_SOCKET_COUNT); i++) {
         if (_socket[i] && _socket[i]->id == sock_id) {
             sock = _socket[i];
             break;

features/cellular/framework/AT/AT_CellularStack.h

@@ -135,11 +135,6 @@ class AT_CellularStack : public NetworkStack {
         bool txfull_event; // socket event after wouldblock
     };
 
-    /**
-    * Gets maximum number of sockets modem supports
-    */
-    virtual int get_max_socket_count() = 0;
-
     /**
     * Checks if modem supports the given protocol
     *
@@ -218,9 +213,6 @@ class AT_CellularStack : public NetworkStack {
     // socket container
     CellularSocket **_socket;
 
-    // number of socket slots allocated in socket container
-    int _socket_count;
-
     // IP address
     char _ip[PDP_IPV6_SIZE];
 

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

@@ -113,6 +113,7 @@ void GEMALTO_CINTERION::init_module_bgs2()
         0,  // PROPERTY_NON_IP_PDP_TYPE
         1,  // PROPERTY_AT_CGEREP
         1,  // PROPERTY_AT_COPS_FALLBACK_AUTO
+        10, // PROPERTY_SOCKET_COUNT
     };
     set_cellular_properties(cellular_properties);
     _module = ModuleBGS2;
@@ -138,6 +139,7 @@ void GEMALTO_CINTERION::init_module_els61()
         0,  // PROPERTY_NON_IP_PDP_TYPE
         1,  // PROPERTY_AT_CGEREP
         1,  // PROPERTY_AT_COPS_FALLBACK_AUTO
+        10, // PROPERTY_SOCKET_COUNT
     };
     set_cellular_properties(cellular_properties);
     _module = ModuleELS61;
@@ -163,6 +165,7 @@ void GEMALTO_CINTERION::init_module_ems31()
         0,  // PROPERTY_NON_IP_PDP_TYPE
         1,  // PROPERTY_AT_CGEREP
         1,  // PROPERTY_AT_COPS_FALLBACK_AUTO
+        10, // PROPERTY_SOCKET_COUNT
     };
     set_cellular_properties(cellular_properties);
     _module = ModuleEMS31;
@@ -188,6 +191,7 @@ void GEMALTO_CINTERION::init_module_ehs5e()
         0,  // PROPERTY_NON_IP_PDP_TYPE
         1,  // PROPERTY_AT_CGEREP
         1,  // PROPERTY_AT_COPS_FALLBACK_AUTO
+        10, // PROPERTY_SOCKET_COUNT
     };
     set_cellular_properties(cellular_properties);
     _module = ModuleEHS5E;

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

@@ -21,7 +21,6 @@
 #include "CellularLog.h"
 
 // defines as per ELS61-E2_ATC_V01.000 and BGS2-W_ATC_V00.100
-#define SOCKET_MAX 10
 #define UDP_PACKET_SIZE 1460
 #define FAILURE_TIMEOUT (30*1000) // failure timeout in milliseconds on modem side
 
@@ -122,7 +121,7 @@ nsapi_error_t GEMALTO_CINTERION_CellularStack::socket_stack_init()
         _at.set_urc_handler("^SISR:", mbed::Callback<void()>(this, &GEMALTO_CINTERION_CellularStack::urc_sisr));
     } else { // recovery cleanup
         // close all Internet and connection profiles
-        for (int i = 0; i < SOCKET_MAX; i++) {
+        for (int i = 0; i < _device.get_property(AT_CellularDevice::PROPERTY_SOCKET_COUNT); i++) {
             _at.clear_error();
             socket_close_impl(i);
         }
@@ -133,11 +132,6 @@ nsapi_error_t GEMALTO_CINTERION_CellularStack::socket_stack_init()
     return err;
 }
 
-int GEMALTO_CINTERION_CellularStack::get_max_socket_count()
-{
-    return SOCKET_MAX;
-}
-
 bool GEMALTO_CINTERION_CellularStack::is_protocol_supported(nsapi_protocol_t protocol)
 {
     return (protocol == NSAPI_UDP || protocol == NSAPI_TCP);

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

@@ -32,8 +32,6 @@ class GEMALTO_CINTERION_CellularStack : public AT_CellularStack {
 
     virtual nsapi_error_t socket_stack_init();
 
-    virtual int get_max_socket_count();
-
     virtual bool is_protocol_supported(nsapi_protocol_t protocol);
 
     virtual nsapi_error_t socket_close_impl(int sock_id);