Skip to content

Deprecate string-based APIs in IPCore #11914

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 15 additions & 0 deletions TESTS/network/emac/emac_TestNetworkStack.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -155,16 +155,31 @@ char *EmacTestNetworkStack::Interface::get_mac_address(char *buf, nsapi_size_t b
return NULL;
}

nsapi_error_t EmacTestNetworkStack::Interface::get_ip_address(SocketAddress *address)
{
return NSAPI_ERROR_OK;
}

char *EmacTestNetworkStack::Interface::get_ip_address(char *buf, nsapi_size_t buflen)
{
return NULL;
}

nsapi_error_t EmacTestNetworkStack::Interface::get_netmask(SocketAddress *address)
{
return NSAPI_ERROR_OK;
}

char *EmacTestNetworkStack::Interface::get_netmask(char *buf, nsapi_size_t buflen)
{
return NULL;
}

nsapi_error_t EmacTestNetworkStack::Interface::get_gateway(SocketAddress *address)
{
return NSAPI_ERROR_OK;
}

char *EmacTestNetworkStack::Interface::get_gateway(char *buf, nsapi_size_t buflen)
{
return NULL;
Expand Down
9 changes: 9 additions & 0 deletions TESTS/network/emac/emac_TestNetworkStack.h
Original file line number Diff line number Diff line change
Expand Up @@ -92,6 +92,9 @@ class EmacTestNetworkStack : public OnboardNetworkStack, private mbed::NonCopyab
* @param buflen size of supplied buffer
* @return Pointer to a buffer, or NULL if the buffer is too small
*/
virtual nsapi_error_t get_ip_address(SocketAddress *address);

MBED_DEPRECATED_SINCE("mbed-os-5.15", "String-based APIs are deprecated")
virtual char *get_ip_address(char *buf, nsapi_size_t buflen);

/** Copies netmask of the network interface to user supplied buffer
Expand All @@ -100,6 +103,9 @@ class EmacTestNetworkStack : public OnboardNetworkStack, private mbed::NonCopyab
* @param buflen size of supplied buffer
* @return Pointer to a buffer, or NULL if the buffer is too small
*/
virtual nsapi_error_t get_netmask(SocketAddress *address);

MBED_DEPRECATED_SINCE("mbed-os-5.15", "String-based APIs are deprecated")
virtual char *get_netmask(char *buf, nsapi_size_t buflen);

/** Copies gateway address of the network interface to user supplied buffer
Expand All @@ -108,6 +114,9 @@ class EmacTestNetworkStack : public OnboardNetworkStack, private mbed::NonCopyab
* @param buflen size of supplied buffer
* @return Pointer to a buffer, or NULL if the buffer is too small
*/
virtual nsapi_error_t get_gateway(SocketAddress *address);

MBED_DEPRECATED_SINCE("mbed-os-5.15", "String-based APIs are deprecated")
virtual char *get_gateway(char *buf, nsapi_size_t buflen);

private:
Expand Down
8 changes: 4 additions & 4 deletions TESTS/network/l3ip/cellular_driver_l3ip.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -66,22 +66,22 @@ void Cellular_driver_L3IP::set_link_state_cb(l3ip_link_state_change_cb_t state_c
l3ip_link_state_cb = state_cb;
}

void Cellular_driver_L3IP::add_ipv4_multicast_group(const char *address)
void Cellular_driver_L3IP::add_ipv4_multicast_group(const SocketAddress &address)
{

}

void Cellular_driver_L3IP::add_ipv6_multicast_group(const char *address)
void Cellular_driver_L3IP::add_ipv6_multicast_group(const SocketAddress &address)
{

}

void Cellular_driver_L3IP::remove_ipv4_multicast_group(const char *address)
void Cellular_driver_L3IP::remove_ipv4_multicast_group(const SocketAddress &address)
{

}

void Cellular_driver_L3IP::remove_ipv6_multicast_group(const char *address)
void Cellular_driver_L3IP::remove_ipv6_multicast_group(const SocketAddress &address)
{

}
Expand Down
8 changes: 4 additions & 4 deletions TESTS/network/l3ip/cellular_driver_l3ip.h
Original file line number Diff line number Diff line change
Expand Up @@ -91,25 +91,25 @@ class Cellular_driver_L3IP : public L3IP {
*
* @param address an IP4 multicast group address
*/
virtual void add_ipv4_multicast_group(const char *address);
virtual void add_ipv4_multicast_group(const SocketAddress &address);

/** Add device to an IP6 multicast group
*
* @param address an IP6 multicast group address
*/
virtual void add_ipv6_multicast_group(const char *address);
virtual void add_ipv6_multicast_group(const SocketAddress &address);

/** Remove device from an IPV4 multicast group
*
* @param address An IPV4 multicast group address
*/
virtual void remove_ipv4_multicast_group(const char *address);
virtual void remove_ipv4_multicast_group(const SocketAddress &address);

/** Remove device from an IPV6 multicast group
*
* @param address An IPV6 multicast group address
*/
virtual void remove_ipv6_multicast_group(const char *address);
virtual void remove_ipv6_multicast_group(const SocketAddress &address);

/** Request reception of all multicast packets
*
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -72,6 +72,10 @@ class testContext : public CellularContext
return NULL;
}

nsapi_error_t get_ip_address(SocketAddress *address)
{
return NSAPI_ERROR_UNSUPPORTED;
}
const char *get_ip_address()
{
return NULL;
Expand Down Expand Up @@ -104,10 +108,18 @@ class testContext : public CellularContext
virtual void set_credentials(const char *apn, const char *uname = 0, const char *pwd = 0)
{
}
nsapi_error_t get_netmask(SocketAddress *address)
{
return NSAPI_ERROR_UNSUPPORTED;
}
virtual const char *get_netmask()
{
return NULL;
}
nsapi_error_t get_gateway(SocketAddress *address)
{
return NSAPI_ERROR_UNSUPPORTED;
}
virtual const char *get_gateway()
{
return NULL;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -93,10 +93,13 @@ class EmacNetworkStackMock : public OnboardNetworkStack {
MOCK_METHOD1(attach, void(mbed::Callback<void(nsapi_event_t, intptr_t)> status_cb));
MOCK_CONST_METHOD0(get_connection_status, nsapi_connection_status_t());
MOCK_METHOD2(get_mac_address, char *(char *buf, nsapi_size_t buflen));
MOCK_METHOD1(get_ip_address, nsapi_error_t(SocketAddress *address));
MOCK_METHOD2(get_ip_address, char *(char *buf, nsapi_size_t buflen));
MOCK_METHOD1(get_ipv6_link_local_address, nsapi_error_t(SocketAddress *address));
MOCK_METHOD1(get_netmask, nsapi_error_t(SocketAddress *address));
MOCK_METHOD2(get_netmask, char *(char *buf, nsapi_size_t buflen));
MOCK_METHOD1(get_gateway, nsapi_error_t(SocketAddress *address));
MOCK_METHOD2(get_gateway, char *(char *buf, nsapi_size_t buflen));
MOCK_METHOD1(get_ipv6_link_local_address, nsapi_error_t(SocketAddress *address));
};
};

Expand Down
2 changes: 0 additions & 2 deletions UNITTESTS/features/netsocket/EthernetInterface/unittest.cmake
Original file line number Diff line number Diff line change
Expand Up @@ -31,8 +31,6 @@ set(unittest-test-sources
stubs/mbed_shared_queues_stub.cpp
stubs/nsapi_dns_stub.cpp
stubs/EventFlags_stub.cpp
stubs/stoip4_stub.c
stubs/ip4tos_stub.c
stubs/NetworkStack_stub.cpp
stubs/NetworkInterfaceDefaults_stub.cpp
stubs/SocketStats_Stub.cpp
Expand Down
3 changes: 3 additions & 0 deletions UNITTESTS/features/netsocket/nsapi_dns/test_nsapi_dns.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -89,8 +89,11 @@ class NetworkStackMock : public OnboardNetworkStack {
MOCK_METHOD1(attach, void(mbed::Callback<void(nsapi_event_t, intptr_t)> status_cb));
MOCK_CONST_METHOD0(get_connection_status, nsapi_connection_status_t());
MOCK_METHOD2(get_mac_address, char *(char *buf, nsapi_size_t buflen));
MOCK_METHOD1(get_ip_address, nsapi_error_t(SocketAddress *address));
MOCK_METHOD2(get_ip_address, char *(char *buf, nsapi_size_t buflen));
MOCK_METHOD1(get_netmask, nsapi_error_t(SocketAddress *address));
MOCK_METHOD2(get_netmask, char *(char *buf, nsapi_size_t buflen));
MOCK_METHOD1(get_gateway, nsapi_error_t(SocketAddress *address));
MOCK_METHOD2(get_gateway, char *(char *buf, nsapi_size_t buflen));
};
};
Expand Down
15 changes: 15 additions & 0 deletions UNITTESTS/stubs/AT_CellularContext_stub.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -111,6 +111,11 @@ NetworkStack *AT_CellularContext::get_stack()
return NULL;
}

nsapi_error_t AT_CellularContext::get_ip_address(SocketAddress *address)
{
return NSAPI_ERROR_UNSUPPORTED;
}

const char *AT_CellularContext::get_ip_address()
{
return NULL;
Expand Down Expand Up @@ -144,11 +149,21 @@ void AT_CellularContext::set_credentials(const char *apn, const char *uname, con

}

nsapi_error_t AT_CellularContext::get_netmask(SocketAddress *address)
{
return NSAPI_ERROR_UNSUPPORTED;
}

const char *AT_CellularContext::get_netmask()
{
return NULL;
}

nsapi_error_t AT_CellularContext::get_gateway(SocketAddress *address)
{
return NSAPI_ERROR_UNSUPPORTED;
}

const char *AT_CellularContext::get_gateway()
{
return NULL;
Expand Down
5 changes: 5 additions & 0 deletions UNITTESTS/stubs/AT_CellularStack_stub.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,11 @@ nsapi_error_t AT_CellularStack::socket_stack_init()
return NSAPI_ERROR_OK;
}

nsapi_error_t AT_CellularStack::get_ip_address(SocketAddress* address)
{
return NSAPI_ERROR_UNSUPPORTED;
}

const char *AT_CellularStack::get_ip_address()
{
return NULL;
Expand Down
27 changes: 23 additions & 4 deletions UNITTESTS/stubs/NetworkInterface_stub.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -26,24 +26,43 @@ const char *NetworkInterface::get_mac_address()
return 0;
}

const char *NetworkInterface::get_ip_address()
nsapi_error_t NetworkInterface::get_ip_address(SocketAddress *)
{
return 0;
return NSAPI_ERROR_UNSUPPORTED;
}

const char *NetworkInterface::get_ip_address()
{
return nullptr;
}
nsapi_error_t NetworkInterface::get_ipv6_link_local_address(SocketAddress *address)
{
return NSAPI_ERROR_UNSUPPORTED;
}

nsapi_error_t NetworkInterface::get_netmask(SocketAddress *)
{
return NSAPI_ERROR_UNSUPPORTED;
}

const char *NetworkInterface::get_netmask()
{
return 0;
return nullptr;
}

nsapi_error_t NetworkInterface::get_gateway(SocketAddress *)
{
return NSAPI_ERROR_UNSUPPORTED;
}

const char *NetworkInterface::get_gateway()
{
return 0;
return nullptr;
}

nsapi_error_t NetworkInterface::set_network(const SocketAddress &ip_address, const SocketAddress &netmask, const SocketAddress &gateway)
{
return NSAPI_ERROR_UNSUPPORTED;
}

nsapi_error_t NetworkInterface::set_network(const char *ip_address, const char *netmask, const char *gateway)
Expand Down
10 changes: 10 additions & 0 deletions UNITTESTS/stubs/NetworkStack_stub.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -89,6 +89,11 @@ nsapi_error_t NetworkStack::call_in(int delay, mbed::Callback<void()> func)
return NSAPI_ERROR_UNSUPPORTED;
}

nsapi_error_t NetworkStack::get_ip_address(SocketAddress* address)
{
return NSAPI_ERROR_UNSUPPORTED;
}

const char *NetworkStack::get_ip_address()
{
return NULL;
Expand All @@ -99,6 +104,11 @@ nsapi_error_t NetworkStack::get_ipv6_link_local_address(SocketAddress *address)
return NSAPI_ERROR_UNSUPPORTED;
}

nsapi_error_t NetworkStack::get_ip_address_if(SocketAddress* address, const char *interface_name)
{
return NSAPI_ERROR_UNSUPPORTED;
}

const char *NetworkStack::get_ip_address_if(const char *interface_name)
{
return NULL;
Expand Down
5 changes: 5 additions & 0 deletions UNITTESTS/stubs/NetworkStack_stub.h
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,11 @@ class NetworkStackstub : public NetworkStack {
{
return "127.0.0.1";
}
virtual nsapi_error_t get_ip_address(SocketAddress* address)
{
address->set_ip_address("127.0.0.1");
return NSAPI_ERROR_OK;
}
virtual nsapi_error_t gethostbyname(const char *host,
SocketAddress *address, nsapi_version_t version, const char *interface_name)
{
Expand Down
15 changes: 15 additions & 0 deletions UNITTESTS/target_h/myCellularContext.h
Original file line number Diff line number Diff line change
Expand Up @@ -97,6 +97,11 @@ class myCellularContext : public CellularContext {
return NULL;
};

nsapi_error_t get_ip_address(SocketAddress *address)
{
return NSAPI_ERROR_UNSUPPORTED;
}

const char *get_ip_address()
{
return NULL;
Expand Down Expand Up @@ -130,11 +135,21 @@ class myCellularContext : public CellularContext {

};

nsapi_error_t get_netmask(SocketAddress *address)
{
return NSAPI_ERROR_UNSUPPORTED;
}

const char *get_netmask()
{
return NULL;
};

nsapi_error_t get_gateway(SocketAddress *address)
{
return NSAPI_ERROR_UNSUPPORTED;
}

const char *get_gateway()
{
return NULL;
Expand Down
6 changes: 6 additions & 0 deletions features/cellular/framework/API/CellularContext.h
Original file line number Diff line number Diff line change
Expand Up @@ -121,6 +121,8 @@ class CellularContext : public CellularInterface {
public: // from NetworkInterface
virtual nsapi_error_t set_blocking(bool blocking) = 0;
virtual NetworkStack *get_stack() = 0;
virtual nsapi_error_t get_ip_address(SocketAddress *address) = 0;
MBED_DEPRECATED_SINCE("mbed-os-5.15", "String-based APIs are deprecated")
virtual const char *get_ip_address() = 0;

/** Register callback for status reporting.
Expand All @@ -144,7 +146,11 @@ class CellularContext : public CellularInterface {
virtual nsapi_error_t connect(const char *sim_pin, const char *apn = 0, const char *uname = 0,
const char *pwd = 0) = 0;
virtual void set_credentials(const char *apn, const char *uname = 0, const char *pwd = 0) = 0;
virtual nsapi_error_t get_netmask(SocketAddress *address) = 0;
MBED_DEPRECATED_SINCE("mbed-os-5.15", "String-based APIs are deprecated")
virtual const char *get_netmask() = 0;
virtual nsapi_error_t get_gateway(SocketAddress *address) = 0;
MBED_DEPRECATED_SINCE("mbed-os-5.15", "String-based APIs are deprecated")
virtual const char *get_gateway() = 0;
virtual bool is_connected() = 0;

Expand Down
Loading