Skip to content

Commit 639b58f

Browse files
michalpasztamobicamichalpasztamobica
committed
Deprecate string-based APIs in IPCore
MBED_DEPRECATE macros is added to string-based APIs. New, non-string-based APIs are added in their place. Wiced binaries rebuilt Any existing stubs or mocks are adjusted to compile and run with the newly added non-string based functions.
1 parent 9dc0c37 commit 639b58f

File tree

46 files changed

+518
-108
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

46 files changed

+518
-108
lines changed

‎TESTS/network/emac/emac_TestNetworkStack.cpp

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -155,16 +155,31 @@ char *EmacTestNetworkStack::Interface::get_mac_address(char *buf, nsapi_size_t b
155155
return NULL;
156156
}
157157

158+
nsapi_error_t EmacTestNetworkStack::Interface::get_ip_address(SocketAddress *address)
159+
{
160+
return NSAPI_ERROR_OK;
161+
}
162+
158163
char *EmacTestNetworkStack::Interface::get_ip_address(char *buf, nsapi_size_t buflen)
159164
{
160165
return NULL;
161166
}
162167

168+
nsapi_error_t EmacTestNetworkStack::Interface::get_netmask(SocketAddress *address)
169+
{
170+
return NSAPI_ERROR_OK;
171+
}
172+
163173
char *EmacTestNetworkStack::Interface::get_netmask(char *buf, nsapi_size_t buflen)
164174
{
165175
return NULL;
166176
}
167177

178+
nsapi_error_t EmacTestNetworkStack::Interface::get_gateway(SocketAddress *address)
179+
{
180+
return NSAPI_ERROR_OK;
181+
}
182+
168183
char *EmacTestNetworkStack::Interface::get_gateway(char *buf, nsapi_size_t buflen)
169184
{
170185
return NULL;

‎TESTS/network/emac/emac_TestNetworkStack.h

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -92,6 +92,9 @@ class EmacTestNetworkStack : public OnboardNetworkStack, private mbed::NonCopyab
9292
* @param buflen size of supplied buffer
9393
* @return Pointer to a buffer, or NULL if the buffer is too small
9494
*/
95+
virtual nsapi_error_t get_ip_address(SocketAddress* address);
96+
97+
MBED_DEPRECATED_SINCE("mbed-os-5.15", "String-based APIs are deprecated")
9598
virtual char *get_ip_address(char *buf, nsapi_size_t buflen);
9699

97100
/** Copies netmask of the network interface to user supplied buffer
@@ -100,6 +103,9 @@ class EmacTestNetworkStack : public OnboardNetworkStack, private mbed::NonCopyab
100103
* @param buflen size of supplied buffer
101104
* @return Pointer to a buffer, or NULL if the buffer is too small
102105
*/
106+
virtual nsapi_error_t get_netmask(SocketAddress* address);
107+
108+
MBED_DEPRECATED_SINCE("mbed-os-5.15", "String-based APIs are deprecated")
103109
virtual char *get_netmask(char *buf, nsapi_size_t buflen);
104110

105111
/** Copies gateway address of the network interface to user supplied buffer
@@ -108,6 +114,9 @@ class EmacTestNetworkStack : public OnboardNetworkStack, private mbed::NonCopyab
108114
* @param buflen size of supplied buffer
109115
* @return Pointer to a buffer, or NULL if the buffer is too small
110116
*/
117+
virtual nsapi_error_t get_gateway(SocketAddress* address);
118+
119+
MBED_DEPRECATED_SINCE("mbed-os-5.15", "String-based APIs are deprecated")
111120
virtual char *get_gateway(char *buf, nsapi_size_t buflen);
112121

113122
private:

‎TESTS/network/l3ip/cellular_driver_l3ip.cpp

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -66,22 +66,22 @@ void Cellular_driver_L3IP::set_link_state_cb(l3ip_link_state_change_cb_t state_c
6666
l3ip_link_state_cb = state_cb;
6767
}
6868

69-
void Cellular_driver_L3IP::add_ipv4_multicast_group(const char *address)
69+
void Cellular_driver_L3IP::add_ipv4_multicast_group(const SocketAddress &address)
7070
{
7171

7272
}
7373

74-
void Cellular_driver_L3IP::add_ipv6_multicast_group(const char *address)
74+
void Cellular_driver_L3IP::add_ipv6_multicast_group(const SocketAddress &address)
7575
{
7676

7777
}
7878

79-
void Cellular_driver_L3IP::remove_ipv4_multicast_group(const char *address)
79+
void Cellular_driver_L3IP::remove_ipv4_multicast_group(const SocketAddress &address)
8080
{
8181

8282
}
8383

84-
void Cellular_driver_L3IP::remove_ipv6_multicast_group(const char *address)
84+
void Cellular_driver_L3IP::remove_ipv6_multicast_group(const SocketAddress &address)
8585
{
8686

8787
}

‎TESTS/network/l3ip/cellular_driver_l3ip.h

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -91,25 +91,25 @@ class Cellular_driver_L3IP : public L3IP {
9191
*
9292
* @param address an IP4 multicast group address
9393
*/
94-
virtual void add_ipv4_multicast_group(const char *address);
94+
virtual void add_ipv4_multicast_group(const SocketAddress &address);
9595

9696
/** Add device to an IP6 multicast group
9797
*
9898
* @param address an IP6 multicast group address
9999
*/
100-
virtual void add_ipv6_multicast_group(const char *address);
100+
virtual void add_ipv6_multicast_group(const SocketAddress &address);
101101

102102
/** Remove device from an IPV4 multicast group
103103
*
104104
* @param address An IPV4 multicast group address
105105
*/
106-
virtual void remove_ipv4_multicast_group(const char *address);
106+
virtual void remove_ipv4_multicast_group(const SocketAddress &address);
107107

108108
/** Remove device from an IPV6 multicast group
109109
*
110110
* @param address An IPV6 multicast group address
111111
*/
112-
virtual void remove_ipv6_multicast_group(const char *address);
112+
virtual void remove_ipv6_multicast_group(const SocketAddress &address);
113113

114114
/** Request reception of all multicast packets
115115
*

‎UNITTESTS/features/cellular/framework/device/cellularcontext/cellularcontexttest.cpp

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -72,6 +72,10 @@ class testContext : public CellularContext
7272
return NULL;
7373
}
7474

75+
nsapi_error_t get_ip_address(SocketAddress *address)
76+
{
77+
return NSAPI_ERROR_UNSUPPORTED;
78+
}
7579
const char *get_ip_address()
7680
{
7781
return NULL;
@@ -104,10 +108,18 @@ class testContext : public CellularContext
104108
virtual void set_credentials(const char *apn, const char *uname = 0, const char *pwd = 0)
105109
{
106110
}
111+
nsapi_error_t get_netmask(SocketAddress *address)
112+
{
113+
return NSAPI_ERROR_UNSUPPORTED;
114+
}
107115
virtual const char *get_netmask()
108116
{
109117
return NULL;
110118
}
119+
nsapi_error_t get_gateway(SocketAddress *address)
120+
{
121+
return NSAPI_ERROR_UNSUPPORTED;
122+
}
111123
virtual const char *get_gateway()
112124
{
113125
return NULL;

‎UNITTESTS/features/netsocket/EthernetInterface/test_EthernetInterface.cpp

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -93,10 +93,13 @@ class EmacNetworkStackMock : public OnboardNetworkStack {
9393
MOCK_METHOD1(attach, void(mbed::Callback<void(nsapi_event_t, intptr_t)> status_cb));
9494
MOCK_CONST_METHOD0(get_connection_status, nsapi_connection_status_t());
9595
MOCK_METHOD2(get_mac_address, char *(char *buf, nsapi_size_t buflen));
96+
MOCK_METHOD1(get_ip_address, nsapi_error_t(SocketAddress *address));
9697
MOCK_METHOD2(get_ip_address, char *(char *buf, nsapi_size_t buflen));
97-
MOCK_METHOD1(get_ipv6_link_local_address, nsapi_error_t(SocketAddress *address));
98+
MOCK_METHOD1(get_netmask, nsapi_error_t(SocketAddress *address));
9899
MOCK_METHOD2(get_netmask, char *(char *buf, nsapi_size_t buflen));
100+
MOCK_METHOD1(get_gateway, nsapi_error_t(SocketAddress *address));
99101
MOCK_METHOD2(get_gateway, char *(char *buf, nsapi_size_t buflen));
102+
MOCK_METHOD1(get_ipv6_link_local_address, nsapi_error_t(SocketAddress *address));
100103
};
101104
};
102105

‎UNITTESTS/features/netsocket/EthernetInterface/unittest.cmake

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -31,8 +31,6 @@ set(unittest-test-sources
3131
stubs/mbed_shared_queues_stub.cpp
3232
stubs/nsapi_dns_stub.cpp
3333
stubs/EventFlags_stub.cpp
34-
stubs/stoip4_stub.c
35-
stubs/ip4tos_stub.c
3634
stubs/NetworkStack_stub.cpp
3735
stubs/NetworkInterfaceDefaults_stub.cpp
3836
stubs/SocketStats_Stub.cpp

‎UNITTESTS/features/netsocket/nsapi_dns/test_nsapi_dns.cpp

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -89,8 +89,11 @@ class NetworkStackMock : public OnboardNetworkStack {
8989
MOCK_METHOD1(attach, void(mbed::Callback<void(nsapi_event_t, intptr_t)> status_cb));
9090
MOCK_CONST_METHOD0(get_connection_status, nsapi_connection_status_t());
9191
MOCK_METHOD2(get_mac_address, char *(char *buf, nsapi_size_t buflen));
92+
MOCK_METHOD1(get_ip_address, nsapi_error_t(SocketAddress *address));
9293
MOCK_METHOD2(get_ip_address, char *(char *buf, nsapi_size_t buflen));
94+
MOCK_METHOD1(get_netmask, nsapi_error_t(SocketAddress *address));
9395
MOCK_METHOD2(get_netmask, char *(char *buf, nsapi_size_t buflen));
96+
MOCK_METHOD1(get_gateway, nsapi_error_t(SocketAddress *address));
9497
MOCK_METHOD2(get_gateway, char *(char *buf, nsapi_size_t buflen));
9598
};
9699
};

‎UNITTESTS/stubs/AT_CellularContext_stub.cpp

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -111,6 +111,11 @@ NetworkStack *AT_CellularContext::get_stack()
111111
return NULL;
112112
}
113113

114+
nsapi_error_t AT_CellularContext::get_ip_address(SocketAddress *address)
115+
{
116+
return NSAPI_ERROR_UNSUPPORTED;
117+
}
118+
114119
const char *AT_CellularContext::get_ip_address()
115120
{
116121
return NULL;
@@ -144,11 +149,21 @@ void AT_CellularContext::set_credentials(const char *apn, const char *uname, con
144149

145150
}
146151

152+
nsapi_error_t AT_CellularContext::get_netmask(SocketAddress *address)
153+
{
154+
return NSAPI_ERROR_UNSUPPORTED;
155+
}
156+
147157
const char *AT_CellularContext::get_netmask()
148158
{
149159
return NULL;
150160
}
151161

162+
nsapi_error_t AT_CellularContext::get_gateway(SocketAddress *address)
163+
{
164+
return NSAPI_ERROR_UNSUPPORTED;
165+
}
166+
152167
const char *AT_CellularContext::get_gateway()
153168
{
154169
return NULL;

‎UNITTESTS/stubs/AT_CellularStack_stub.cpp

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,11 @@ nsapi_error_t AT_CellularStack::socket_stack_init()
3535
return NSAPI_ERROR_OK;
3636
}
3737

38+
nsapi_error_t AT_CellularStack::get_ip_address(SocketAddress* address)
39+
{
40+
return NSAPI_ERROR_UNSUPPORTED;
41+
}
42+
3843
const char *AT_CellularStack::get_ip_address()
3944
{
4045
return NULL;

‎UNITTESTS/stubs/NetworkInterface_stub.cpp

Lines changed: 23 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -26,24 +26,43 @@ const char *NetworkInterface::get_mac_address()
2626
return 0;
2727
}
2828

29-
const char *NetworkInterface::get_ip_address()
29+
nsapi_error_t NetworkInterface::get_ip_address(SocketAddress *)
3030
{
31-
return 0;
31+
return NSAPI_ERROR_UNSUPPORTED;
3232
}
3333

34+
const char *NetworkInterface::get_ip_address()
35+
{
36+
return nullptr;
37+
}
3438
nsapi_error_t NetworkInterface::get_ipv6_link_local_address(SocketAddress *address)
3539
{
3640
return NSAPI_ERROR_UNSUPPORTED;
3741
}
3842

43+
nsapi_error_t NetworkInterface::get_netmask(SocketAddress *)
44+
{
45+
return NSAPI_ERROR_UNSUPPORTED;
46+
}
47+
3948
const char *NetworkInterface::get_netmask()
4049
{
41-
return 0;
50+
return nullptr;
51+
}
52+
53+
nsapi_error_t NetworkInterface::get_gateway(SocketAddress *)
54+
{
55+
return NSAPI_ERROR_UNSUPPORTED;
4256
}
4357

4458
const char *NetworkInterface::get_gateway()
4559
{
46-
return 0;
60+
return nullptr;
61+
}
62+
63+
nsapi_error_t NetworkInterface::set_network(const SocketAddress &ip_address, const SocketAddress &netmask, const SocketAddress &gateway)
64+
{
65+
return NSAPI_ERROR_UNSUPPORTED;
4766
}
4867

4968
nsapi_error_t NetworkInterface::set_network(const char *ip_address, const char *netmask, const char *gateway)

‎UNITTESTS/stubs/NetworkStack_stub.cpp

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -89,6 +89,11 @@ nsapi_error_t NetworkStack::call_in(int delay, mbed::Callback<void()> func)
8989
return NSAPI_ERROR_UNSUPPORTED;
9090
}
9191

92+
nsapi_error_t NetworkStack::get_ip_address(SocketAddress* address)
93+
{
94+
return NSAPI_ERROR_UNSUPPORTED;
95+
}
96+
9297
const char *NetworkStack::get_ip_address()
9398
{
9499
return NULL;
@@ -99,6 +104,11 @@ nsapi_error_t NetworkStack::get_ipv6_link_local_address(SocketAddress *address)
99104
return NSAPI_ERROR_UNSUPPORTED;
100105
}
101106

107+
nsapi_error_t NetworkStack::get_ip_address_if(SocketAddress* address, const char *interface_name)
108+
{
109+
return NSAPI_ERROR_UNSUPPORTED;
110+
}
111+
102112
const char *NetworkStack::get_ip_address_if(const char *interface_name)
103113
{
104114
return NULL;

‎UNITTESTS/stubs/NetworkStack_stub.h

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,11 @@ class NetworkStackstub : public NetworkStack {
3737
{
3838
return "127.0.0.1";
3939
}
40+
virtual nsapi_error_t get_ip_address(SocketAddress* address)
41+
{
42+
address->set_ip_address("127.0.0.1");
43+
return NSAPI_ERROR_OK;
44+
}
4045
virtual nsapi_error_t gethostbyname(const char *host,
4146
SocketAddress *address, nsapi_version_t version, const char *interface_name)
4247
{

‎UNITTESTS/target_h/myCellularContext.h

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -97,6 +97,11 @@ class myCellularContext : public CellularContext {
9797
return NULL;
9898
};
9999

100+
nsapi_error_t get_ip_address(SocketAddress *address)
101+
{
102+
return NSAPI_ERROR_UNSUPPORTED;
103+
}
104+
100105
const char *get_ip_address()
101106
{
102107
return NULL;
@@ -130,11 +135,21 @@ class myCellularContext : public CellularContext {
130135

131136
};
132137

138+
nsapi_error_t get_netmask(SocketAddress *address)
139+
{
140+
return NSAPI_ERROR_UNSUPPORTED;
141+
}
142+
133143
const char *get_netmask()
134144
{
135145
return NULL;
136146
};
137147

148+
nsapi_error_t get_gateway(SocketAddress *address)
149+
{
150+
return NSAPI_ERROR_UNSUPPORTED;
151+
}
152+
138153
const char *get_gateway()
139154
{
140155
return NULL;

‎features/cellular/framework/API/CellularContext.h

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -121,6 +121,8 @@ class CellularContext : public CellularInterface {
121121
public: // from NetworkInterface
122122
virtual nsapi_error_t set_blocking(bool blocking) = 0;
123123
virtual NetworkStack *get_stack() = 0;
124+
virtual nsapi_error_t get_ip_address(SocketAddress *address) = 0;
125+
MBED_DEPRECATED_SINCE("mbed-os-5.15", "String-based APIs are deprecated")
124126
virtual const char *get_ip_address() = 0;
125127

126128
/** Register callback for status reporting.
@@ -144,7 +146,11 @@ class CellularContext : public CellularInterface {
144146
virtual nsapi_error_t connect(const char *sim_pin, const char *apn = 0, const char *uname = 0,
145147
const char *pwd = 0) = 0;
146148
virtual void set_credentials(const char *apn, const char *uname = 0, const char *pwd = 0) = 0;
149+
virtual nsapi_error_t get_netmask(SocketAddress *address) = 0;
150+
MBED_DEPRECATED_SINCE("mbed-os-5.15", "String-based APIs are deprecated")
147151
virtual const char *get_netmask() = 0;
152+
virtual nsapi_error_t get_gateway(SocketAddress *address) = 0;
153+
MBED_DEPRECATED_SINCE("mbed-os-5.15", "String-based APIs are deprecated")
148154
virtual const char *get_gateway() = 0;
149155
virtual bool is_connected() = 0;
150156

0 commit comments

Comments
 (0)