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.
CDMASMSInterface Class Reference
Component to use the Short Messages Service (SMS) More...
#include <CDMASMSInterface.h>
Inherits ISMSInterface, and IATCommandsProcessor.
Public Member Functions | |
CDMASMSInterface (ATCommandsInterface *pIf) | |
Create SMSInterface instance. | |
virtual int | init () |
Initialize interface Configure SMS commands & register for SMS-related unsolicited result codes. | |
virtual int | send (const char *number, const char *message) |
Send a SM. | |
virtual int | get (char *number, char *message, size_t maxLength) |
Receive a SM. | |
virtual int | getCount (size_t *pCount) |
Get the number of SMs in the incoming box. | |
Friends | |
class | ATCommandsInterface |
Detailed Description
Component to use the Short Messages Service (SMS)
Definition at line 30 of file CDMASMSInterface.h.
Constructor & Destructor Documentation
CDMASMSInterface | ( | ATCommandsInterface * | pIf ) |
Create SMSInterface instance.
- Parameters:
-
pIf Pointer to the ATCommandsInterface instance to use
Definition at line 36 of file CDMASMSInterface.cpp.
Member Function Documentation
int get | ( | char * | number, |
char * | message, | ||
size_t | maxLength | ||
) | [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
Implements ISMSInterface.
Definition at line 120 of file CDMASMSInterface.cpp.
int getCount | ( | size_t * | pCount ) | [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
Implements ISMSInterface.
Definition at line 230 of file CDMASMSInterface.cpp.
int init | ( | ) | [virtual] |
Initialize interface Configure SMS commands & register for SMS-related unsolicited result codes.
Implements ISMSInterface.
Definition at line 40 of file CDMASMSInterface.cpp.
int send | ( | const char * | number, |
const char * | message | ||
) | [virtual] |
Send a SM.
- Parameters:
-
number The receiver's phone number message The message to send
- Returns:
- 0 on success, error code on failure
Implements ISMSInterface.
Definition at line 55 of file CDMASMSInterface.cpp.
Generated on Tue Jul 12 2022 17:35:11 by
