ARMmbed
/
mbed-os
mirror of https://github.com/ARMmbed/mbed-os.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Cellular: updated doxygen for CellularContext and CellularDevice.

pull/9208/head
Teppo Järvelin 2018-11-23 11:54:50 +02:00 committed by Cruz Monrreal II
parent c154da4123
commit f9742e978c
2 changed files with 18 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
features/cellular/framework/API/CellularContext.h
View File

@ -106,6 +106,16 @@ public: // from NetworkInterface
virtual nsapi_error_t set_blocking(bool blocking) = 0; virtual nsapi_error_t set_blocking(bool blocking) = 0;
virtual NetworkStack *get_stack() = 0; virtual NetworkStack *get_stack() = 0;
virtual const char *get_ip_address() = 0; virtual const char *get_ip_address() = 0;
/** Register callback for status reporting.
*
* The specified status callback function will be called on the network and cellular device status changes.
* The parameters on the callback are the event type and event-type dependent reason parameter.
*
* @remark deleting CellularDevice/CellularContext in callback not allowed.
*
* @param status_cb The callback for status changes.
*/
virtual void attach(mbed::Callback<void(nsapi_event_t, intptr_t)> status_cb) = 0; virtual void attach(mbed::Callback<void(nsapi_event_t, intptr_t)> status_cb) = 0;
virtual nsapi_error_t connect() = 0; virtual nsapi_error_t connect() = 0;
virtual nsapi_error_t disconnect() = 0; virtual nsapi_error_t disconnect() = 0;

20
features/cellular/framework/API/CellularDevice.h
View File

@ -104,9 +104,8 @@ public:
/** Start the interface /** Start the interface
* *
* Power on the device and does the initializations for communication with the modem.. * Power on the device and does the initializations for communication with the modem..
* By default this API is synchronous. API can be set to asynchronous with method set_blocking(...). * API is asynchronous. Application can get results from CellularContext callback which is set
* In synchronous and asynchronous mode application can get result in from callback which is set with * with attach(...) or callback which is set by attach(...) in this class.
* attach(...)
* *
* @return NSAPI_ERROR_OK on success * @return NSAPI_ERROR_OK on success
* NSAPI_ERROR_NO_MEMORY on case of memory failure * NSAPI_ERROR_NO_MEMORY on case of memory failure
@ -116,9 +115,8 @@ public:
/** Start the interface /** Start the interface
* *
* Attempts to open the sim. * Attempts to open the sim.
* By default this API is synchronous. API can be set to asynchronous with method set_blocking(...). * API is asynchronous. Application can get results from CellularContext callback which is set
* In synchronous and asynchronous mode application can get result in from callback which is set with * with attach(...) or callback which is set by attach(...) in this class.
* attach(...)
* *
* @return NSAPI_ERROR_OK on success * @return NSAPI_ERROR_OK on success
* NSAPI_ERROR_NO_MEMORY on case of memory failure * NSAPI_ERROR_NO_MEMORY on case of memory failure
@ -128,9 +126,8 @@ public:
/** Start the interface /** Start the interface
* *
* Attempts to register the device to cellular network. * Attempts to register the device to cellular network.
* By default this API is synchronous. API can be set to asynchronous with method set_blocking(...). * API is asynchronous. Application can get results from CellularContext callback which is set
* In synchronous and asynchronous mode application can get result in from callback which is set with * with attach(...) or callback which is set by attach(...) in this class.
* attach(...)
* *
* @return NSAPI_ERROR_OK on success * @return NSAPI_ERROR_OK on success
* NSAPI_ERROR_NO_MEMORY on case of memory failure * NSAPI_ERROR_NO_MEMORY on case of memory failure
@ -140,9 +137,8 @@ public:
/** Start the interface /** Start the interface
* *
* Attempts to attach the device to cellular network. * Attempts to attach the device to cellular network.
* By default this API is synchronous. API can be set to asynchronous with method set_blocking(...). * API is asynchronous. Application can get results from CellularContext callback which is set
* In synchronous and asynchronous mode application can get result in from callback which is set with * with attach(...) or callback which is set by attach(...) in this class.
* attach(...)
* *
* @return NSAPI_ERROR_OK on success * @return NSAPI_ERROR_OK on success
* NSAPI_ERROR_NO_MEMORY on case of memory failure * NSAPI_ERROR_NO_MEMORY on case of memory failure