Important changes to repositories hosted on mbed.com
Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.
To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.
It is also possible to export all your personal repositories from the account settings page.
Fork of mbed-os by
ISMSInterface Class Reference
Component to use the Short Messages Service (SMS) More...
#include <SMSInterface.h>
Inherited by CDMASMSInterface, and GSMSMSInterface.
Public Member Functions | |
virtual int | init ()=0 |
Initialize interface Configure SMS commands & register for SMS-related unsolicited result codes. | |
virtual int | send (const char *number, const char *message)=0 |
Send a SM. | |
virtual int | get (char *number, char *message, size_t maxLength)=0 |
Receive a SM. | |
virtual int | getCount (size_t *pCount)=0 |
Get the number of SMs in the incoming box. |
Detailed Description
Component to use the Short Messages Service (SMS)
Definition at line 34 of file SMSInterface.h.
Member Function Documentation
virtual int get | ( | char * | number, |
char * | message, | ||
size_t | maxLength | ||
) | [pure virtual] |
Receive a SM.
- Parameters:
-
number Pointer to a buffer to store the sender's phone number (must be at least 17 characters-long, including the space for the null-terminating char) message Pointer to a buffer to store the the incoming message maxLength Maximum message length that can be stored in buffer (including null-terminating character)
- Returns:
- 0 on success, error code on failure
Implemented in CDMASMSInterface, and GSMSMSInterface.
virtual int getCount | ( | size_t * | pCount ) | [pure virtual] |
Get the number of SMs in the incoming box.
- Parameters:
-
pCount pointer to store the number of unprocessed SMs on
- Returns:
- 0 on success, error code on failure
Implemented in CDMASMSInterface, and GSMSMSInterface.
virtual int init | ( | ) | [pure virtual] |
Initialize interface Configure SMS commands & register for SMS-related unsolicited result codes.
Implemented in CDMASMSInterface, and GSMSMSInterface.
virtual int send | ( | const char * | number, |
const char * | message | ||
) | [pure virtual] |
Send a SM.
- Parameters:
-
number The receiver's phone number message The message to send
- Returns:
- 0 on success, error code on failure
Implemented in CDMASMSInterface, and GSMSMSInterface.
Generated on Tue Jul 12 2022 13:16:52 by
