Skip to content

Commit 16e8b77

Browse files
author
Teppo Järvelin
committed
PR review findings, updated deprecated comments.
1 parent 783d0c5 commit 16e8b77

File tree

4 files changed

+31
-31
lines changed

4 files changed

+31
-31
lines changed

‎features/netsocket/CellularInterface.h

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ class CellularInterface : public NetworkInterface
2929
public:
3030
/** CellularInterface lifetime
3131
*/
32-
MBED_DEPRECATED_SINCE("mbed-os-5.9", "This API will be deprecated, use mbed-os/features/cellular/framework/API instead.")
32+
MBED_DEPRECATED_SINCE("mbed-os-5.9", "This API will be deprecated, use mbed-os/features/cellular/framework/API/CellularNetwork.h instead.")
3333
virtual ~CellularInterface() {};
3434

3535
/** Set the cellular network APN and credentials
@@ -39,7 +39,7 @@ class CellularInterface : public NetworkInterface
3939
* @param password Optional password fot the APN
4040
* @return 0 on success, negative error code on failure
4141
*/
42-
MBED_DEPRECATED_SINCE("mbed-os-5.9", "This API will be deprecated, use mbed-os/features/cellular/framework/API instead.")
42+
MBED_DEPRECATED_SINCE("mbed-os-5.9", "This API will be deprecated, use mbed-os/features/cellular/framework/API/CellularNetwork.h instead.")
4343
virtual nsapi_error_t set_credentials(const char *apn,
4444
const char *username = 0, const char *password = 0) = 0;
4545

@@ -50,7 +50,7 @@ class CellularInterface : public NetworkInterface
5050
* @param password Optional password for your APN
5151
* @return 0 on success, negative error code on failure
5252
*/
53-
MBED_DEPRECATED_SINCE("mbed-os-5.9", "This API will be deprecated, use mbed-os/features/cellular/framework/API instead.")
53+
MBED_DEPRECATED_SINCE("mbed-os-5.9", "This API will be deprecated, use mbed-os/features/cellular/framework/API/CellularNetwork.h instead.")
5454
virtual nsapi_error_t connect(const char *apn,
5555
const char *username = 0, const char *password = 0) = 0;
5656

@@ -60,14 +60,14 @@ class CellularInterface : public NetworkInterface
6060
*
6161
* @return 0 on success, negative error code on failure
6262
*/
63-
MBED_DEPRECATED_SINCE("mbed-os-5.9", "This API will be deprecated, use mbed-os/features/cellular/framework/API instead.")
63+
MBED_DEPRECATED_SINCE("mbed-os-5.9", "This API will be deprecated, use mbed-os/features/cellular/framework/API/CellularNetwork.h instead.")
6464
virtual nsapi_error_t connect() = 0;
6565

6666
/** Stop the interface
6767
*
6868
* @return 0 on success, negative error code on failure
6969
*/
70-
MBED_DEPRECATED_SINCE("mbed-os-5.9", "This API will be deprecated, use mbed-os/features/cellular/framework/API instead.")
70+
MBED_DEPRECATED_SINCE("mbed-os-5.9", "This API will be deprecated, use mbed-os/features/cellular/framework/API/CellularNetwork.h instead.")
7171
virtual nsapi_error_t disconnect() = 0;
7272
};
7373

‎features/netsocket/cellular/generic_modem_driver/OnboardCellularInterface.h

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -37,10 +37,10 @@ class OnboardCellularInterface : public UARTCellularInterface {
3737

3838
public:
3939

40-
MBED_DEPRECATED_SINCE("mbed-os-5.9", "This API will be deprecated, use mbed-os/features/cellular/framework/API instead.")
40+
MBED_DEPRECATED_SINCE("mbed-os-5.9", "This API will be deprecated, use mbed-os/features/cellular/framework/API/CellularPower.h instead.")
4141
OnboardCellularInterface(bool debug = false);
4242

43-
MBED_DEPRECATED_SINCE("mbed-os-5.9", "This API will be deprecated, use mbed-os/features/cellular/framework/API instead.")
43+
MBED_DEPRECATED_SINCE("mbed-os-5.9", "This API will be deprecated, use mbed-os/features/cellular/framework/API/CellularPower.h instead.")
4444
virtual ~OnboardCellularInterface();
4545

4646
protected:
@@ -49,7 +49,7 @@ class OnboardCellularInterface : public UARTCellularInterface {
4949
* modem_init() is equivalent to plugging in the device, for example, attaching power and serial port.
5050
* Uses onboard_modem_api.h where the target provides the implementation of onboard_modem_api.
5151
*/
52-
MBED_DEPRECATED_SINCE("mbed-os-5.9", "This API will be deprecated, use mbed-os/features/cellular/framework/API instead.")
52+
MBED_DEPRECATED_SINCE("mbed-os-5.9", "This API will be deprecated, use mbed-os/features/cellular/framework/API/CellularPower.h instead.")
5353
virtual void modem_init();
5454

5555
/** Sets the modem in unplugged state
@@ -58,7 +58,7 @@ class OnboardCellularInterface : public UARTCellularInterface {
5858
* and serial port. This puts the modem in lowest power state.
5959
* Uses onboard_modem_api.h where the target provides the implementation of onboard_modem_api.
6060
*/
61-
MBED_DEPRECATED_SINCE("mbed-os-5.9", "This API will be deprecated, use mbed-os/features/cellular/framework/API instead.")
61+
MBED_DEPRECATED_SINCE("mbed-os-5.9", "This API will be deprecated, use mbed-os/features/cellular/framework/API/CellularPower.h instead.")
6262
virtual void modem_deinit();
6363

6464
/** Powers up the modem
@@ -67,15 +67,15 @@ class OnboardCellularInterface : public UARTCellularInterface {
6767
* The driver may repeat this if the modem is not responsive to AT commands.
6868
* Uses onboard_modem_api.h where the target provides the implementation of onboard_modem_api.
6969
*/
70-
MBED_DEPRECATED_SINCE("mbed-os-5.9", "This API will be deprecated, use mbed-os/features/cellular/framework/API instead.")
70+
MBED_DEPRECATED_SINCE("mbed-os-5.9", "This API will be deprecated, use mbed-os/features/cellular/framework/API/CellularPower.h instead.")
7171
virtual void modem_power_up();
7272

7373
/** Powers down the modem
7474
*
7575
* modem_power_down() is equivalent to turning off the modem by button press.
7676
* Uses onboard_modem_api.h where the target provides the implementation of onboard_modem_api.
7777
*/
78-
MBED_DEPRECATED_SINCE("mbed-os-5.9", "This API will be deprecated, use mbed-os/features/cellular/framework/API instead.")
78+
MBED_DEPRECATED_SINCE("mbed-os-5.9", "This API will be deprecated, use mbed-os/features/cellular/framework/API/CellularPower.h instead.")
7979
virtual void modem_power_down();
8080
};
8181

‎features/netsocket/cellular/generic_modem_driver/PPPCellularInterface.h

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -109,10 +109,10 @@ class PPPCellularInterface : public CellularBase {
109109
* The file handle pointer is not accessed within the constructor, only recorded for later
110110
* use - this permits a derived class to pass a pointer to a not-yet-constructed member object.
111111
*/
112-
MBED_DEPRECATED_SINCE("mbed-os-5.9", "This API will be deprecated, use mbed-os/features/cellular/framework/API instead.")
112+
MBED_DEPRECATED_SINCE("mbed-os-5.9", "This API will be deprecated, use mbed-os/features/cellular/easy_cellular/EasyCellularConnection.h instead.")
113113
PPPCellularInterface(FileHandle *fh, bool debug = false);
114114

115-
MBED_DEPRECATED_SINCE("mbed-os-5.9", "This API will be deprecated, use mbed-os/features/cellular/framework/API instead.")
115+
MBED_DEPRECATED_SINCE("mbed-os-5.9", "This API will be deprecated, use mbed-os/features/cellular/easy_cellular/EasyCellularConnection.h instead.")
116116
virtual ~PPPCellularInterface();
117117

118118
/** Set the Cellular network credentials
@@ -123,15 +123,15 @@ class PPPCellularInterface : public CellularBase {
123123
* @param uname optionally, Username
124124
* @param pwd optionally, password
125125
*/
126-
MBED_DEPRECATED_SINCE("mbed-os-5.9", "This API will be deprecated, use mbed-os/features/cellular/framework/API instead.")
126+
MBED_DEPRECATED_SINCE("mbed-os-5.9", "This API will be deprecated, use mbed-os/features/cellular/easy_cellular/EasyCellularConnection.h instead.")
127127
virtual void set_credentials(const char *apn, const char *uname = 0,
128128
const char *pwd = 0);
129129

130130
/** Set the pin code for SIM card
131131
*
132132
* @param sim_pin PIN for the SIM card
133133
*/
134-
MBED_DEPRECATED_SINCE("mbed-os-5.9", "This API will be deprecated, use mbed-os/features/cellular/framework/API instead.")
134+
MBED_DEPRECATED_SINCE("mbed-os-5.9", "This API will be deprecated, use mbed-os/features/cellular/easy_cellular/EasyCellularConnection.h instead.")
135135
virtual void set_sim_pin(const char *sim_pin);
136136

137137
/** Start the interface
@@ -149,7 +149,7 @@ class PPPCellularInterface : public CellularBase {
149149
* @param pwd optionally, password
150150
* @return NSAPI_ERROR_OK on success, or negative error code on failure
151151
*/
152-
MBED_DEPRECATED_SINCE("mbed-os-5.9", "This API will be deprecated, use mbed-os/features/cellular/framework/API instead.")
152+
MBED_DEPRECATED_SINCE("mbed-os-5.9", "This API will be deprecated, use mbed-os/features/cellular/easy_cellular/EasyCellularConnection.h instead.")
153153
virtual nsapi_error_t connect(const char *sim_pin, const char *apn = 0,
154154
const char *uname = 0, const char *pwd = 0);
155155

@@ -173,7 +173,7 @@ class PPPCellularInterface : public CellularBase {
173173
* Preferred method is to setup APN using 'set_credentials()' API.
174174
* @return 0 on success, negative error code on failure
175175
*/
176-
MBED_DEPRECATED_SINCE("mbed-os-5.9", "This API will be deprecated, use mbed-os/features/cellular/framework/API instead.")
176+
MBED_DEPRECATED_SINCE("mbed-os-5.9", "This API will be deprecated, use mbed-os/features/cellular/easy_cellular/EasyCellularConnection.h instead.")
177177
virtual nsapi_error_t connect();
178178

179179
/** Attempt to disconnect from the network
@@ -183,7 +183,7 @@ class PPPCellularInterface : public CellularBase {
183183
*
184184
* @return 0 on success, negative error code on failure
185185
*/
186-
MBED_DEPRECATED_SINCE("mbed-os-5.9", "This API will be deprecated, use mbed-os/features/cellular/framework/API instead.")
186+
MBED_DEPRECATED_SINCE("mbed-os-5.9", "This API will be deprecated, use mbed-os/features/cellular/easy_cellular/EasyCellularConnection.h instead.")
187187
virtual nsapi_error_t disconnect();
188188

189189
/** Adds or removes a SIM facility lock
@@ -196,7 +196,7 @@ class PPPCellularInterface : public CellularBase {
196196
* @param set can be set to true if the SIM pin check is supposed to be enabled
197197
* and vice versa.
198198
*/
199-
MBED_DEPRECATED_SINCE("mbed-os-5.9", "This API will be deprecated, use mbed-os/features/cellular/framework/API instead.")
199+
MBED_DEPRECATED_SINCE("mbed-os-5.9", "This API will be deprecated, use mbed-os/features/cellular/easy_cellular/EasyCellularConnection.h instead.")
200200
void set_sim_pin_check(bool set);
201201

202202
/** Change the pin for the SIM card
@@ -207,7 +207,7 @@ class PPPCellularInterface : public CellularBase {
207207
*
208208
* @param new_pin new pin to be used in string format
209209
*/
210-
MBED_DEPRECATED_SINCE("mbed-os-5.9", "This API will be deprecated, use mbed-os/features/cellular/framework/API instead.")
210+
MBED_DEPRECATED_SINCE("mbed-os-5.9", "This API will be deprecated, use mbed-os/features/cellular/easy_cellular/EasyCellularConnection.h instead.")
211211
void set_new_sim_pin(const char *new_pin);
212212

213213
/** Check if the connection is currently established or not
@@ -216,61 +216,61 @@ class PPPCellularInterface : public CellularBase {
216216
* connected to an external packet data network using PPP, isConnected()
217217
* API returns true and false otherwise.
218218
*/
219-
MBED_DEPRECATED_SINCE("mbed-os-5.9", "This API will be deprecated, use mbed-os/features/cellular/framework/API instead.")
219+
MBED_DEPRECATED_SINCE("mbed-os-5.9", "This API will be deprecated, use mbed-os/features/cellular/easy_cellular/EasyCellularConnection.h instead.")
220220
virtual bool is_connected();
221221

222222
/** Get the local IP address
223223
*
224224
* @return Null-terminated representation of the local IP address
225225
* or null if no IP address has been recieved
226226
*/
227-
MBED_DEPRECATED_SINCE("mbed-os-5.9", "This API will be deprecated, use mbed-os/features/cellular/framework/API instead.")
227+
MBED_DEPRECATED_SINCE("mbed-os-5.9", "This API will be deprecated, use mbed-os/features/cellular/easy_cellular/EasyCellularConnection.h instead.")
228228
virtual const char *get_ip_address();
229229

230230
/** Get the local network mask
231231
*
232232
* @return Null-terminated representation of the local network mask
233233
* or null if no network mask has been recieved
234234
*/
235-
MBED_DEPRECATED_SINCE("mbed-os-5.9", "This API will be deprecated, use mbed-os/features/cellular/framework/API instead.")
235+
MBED_DEPRECATED_SINCE("mbed-os-5.9", "This API will be deprecated, use mbed-os/features/cellular/easy_cellular/EasyCellularConnection.h instead.")
236236
virtual const char *get_netmask();
237237

238238
/** Get the local gateways
239239
*
240240
* @return Null-terminated representation of the local gateway
241241
* or null if no network mask has been recieved
242242
*/
243-
MBED_DEPRECATED_SINCE("mbed-os-5.9", "This API will be deprecated, use mbed-os/features/cellular/framework/API instead.")
243+
MBED_DEPRECATED_SINCE("mbed-os-5.9", "This API will be deprecated, use mbed-os/features/cellular/easy_cellular/EasyCellularConnection.h instead.")
244244
virtual const char *get_gateway();
245245

246246

247247
/** Turn modem debug traces on
248248
*
249249
* @param on set true to enable debug traces
250250
*/
251-
MBED_DEPRECATED_SINCE("mbed-os-5.9", "This API will be deprecated, use mbed-os/features/cellular/framework/API instead.")
251+
MBED_DEPRECATED_SINCE("mbed-os-5.9", "This API will be deprecated, use mbed-os/features/cellular/easy_cellular/EasyCellularConnection.h instead.")
252252
void modem_debug_on(bool on);
253253

254254
/** Register callback for status reporting
255255
*
256256
* @param status_cb The callback for status changes
257257
*/
258-
MBED_DEPRECATED_SINCE("mbed-os-5.9", "This API will be deprecated, use mbed-os/features/cellular/framework/API instead.")
258+
MBED_DEPRECATED_SINCE("mbed-os-5.9", "This API will be deprecated, use mbed-os/features/cellular/easy_cellular/EasyCellularConnection.h instead.")
259259
virtual void attach(Callback<void(nsapi_event_t, intptr_t)> status_cb);
260260

261261
/** Get the connection status
262262
*
263263
* @return The connection status according to nsapi_connection_status_t
264264
*/
265-
MBED_DEPRECATED_SINCE("mbed-os-5.9", "This API will be deprecated, use mbed-os/features/cellular/framework/API instead.")
265+
MBED_DEPRECATED_SINCE("mbed-os-5.9", "This API will be deprecated, use mbed-os/features/cellular/easy_cellular/EasyCellularConnection.h instead.")
266266
virtual nsapi_connection_status_t get_connection_status() const;
267267

268268
/** Set blocking status of connect() which by default should be blocking
269269
*
270270
* @param blocking true if connect is blocking
271271
* @return 0 on success, negative error code on failure
272272
*/
273-
MBED_DEPRECATED_SINCE("mbed-os-5.9", "This API will be deprecated, use mbed-os/features/cellular/framework/API instead.")
273+
MBED_DEPRECATED_SINCE("mbed-os-5.9", "This API will be deprecated, use mbed-os/features/cellular/easy_cellular/EasyCellularConnection.h instead.")
274274
virtual nsapi_error_t set_blocking(bool blocking);
275275

276276
private:

‎features/netsocket/cellular/generic_modem_driver/UARTCellularInterface.h

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -34,13 +34,13 @@ class UARTCellularInterface : public PPPCellularInterface {
3434

3535
public:
3636

37-
MBED_DEPRECATED_SINCE("mbed-os-5.9", "This API will be deprecated, use mbed-os/features/cellular/framework/API instead.")
37+
MBED_DEPRECATED_SINCE("mbed-os-5.9", "This API will be deprecated, use mbed-os/features/cellular/easy_cellular/EasyCellularConnection.h instead.")
3838
UARTCellularInterface(PinName tx, PinName rx, PinName dcd = NC, PinName rts = NC, PinName cts = NC, PinName ri = NC,
3939
PinName dtr = NC, PinName dsr = NC, int baud = MBED_CONF_PPP_CELL_IFACE_BAUD_RATE,
4040
bool active_high = false,
4141
bool debug = false);
4242

43-
MBED_DEPRECATED_SINCE("mbed-os-5.9", "This API will be deprecated, use mbed-os/features/cellular/framework/API instead.")
43+
MBED_DEPRECATED_SINCE("mbed-os-5.9", "This API will be deprecated, use mbed-os/features/cellular/easy_cellular/EasyCellularConnection.h instead.")
4444
virtual ~UARTCellularInterface();
4545

4646
private:
@@ -56,7 +56,7 @@ class UARTCellularInterface : public PPPCellularInterface {
5656
* signaling is not desired. enable_hup() controls whether this function should be
5757
* active.
5858
*/
59-
MBED_DEPRECATED_SINCE("mbed-os-5.9", "This API will be deprecated, use mbed-os/features/cellular/framework/API instead.")
59+
MBED_DEPRECATED_SINCE("mbed-os-5.9", "This API will be deprecated, use mbed-os/features/cellular/easy_cellular/EasyCellularConnection.h instead.")
6060
virtual void enable_hup(bool enable);
6161
};
6262

0 commit comments

Comments
 (0)