Nicholas Herriot / VodafoneK3770Lib

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.

Embed: (wiki syntax)

« Back to documentation index

SMSInterface Class Reference
Public Member Functions | Friends

SMSInterface Class Reference

Component to use the Short Messages Service (SMS) More...

#include <SMSInterface.h>

Inherits IATCommandsProcessor, and IATEventsHandler.

Public Member Functions

 SMSInterface (ATCommandsInterface *pIf)
 Create SMSInterface instance.
int init ()
 Initialize interface Configure SMS commands & register for SMS-related unsolicited result codes.
int send (const char *number, const char *message)
 Send a SM.
int get (char *number, char *message, size_t maxLength)
 Receive a SM.
int getCount (size_t *pCount)
 Get the number of SMs in the incoming box.

Friends

class ATCommandsInterface
class ATCommandsInterface

Detailed Description

Component to use the Short Messages Service (SMS)

Definition at line 38 of file SMSInterface.h.

Constructor & Destructor Documentation

SMSInterface ( ATCommandsInterface *  pIf )

Create SMSInterface instance.

Parameters:
pIfPointer to the ATCommandsInterface instance to use

Definition at line 37 of file SMSInterface.cpp.

Member Function Documentation

int get ( char *  number,
char *  message,
size_t  maxLength 
)

Receive a SM.

Parameters:
numberPointer 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)
messagePointer to a buffer to store the the incoming message
maxLengthMaximum message length that can be stored in buffer (including null-terminating character)
Returns:
0 on success, error code on failure

Definition at line 110 of file SMSInterface.cpp.

int getCount ( size_t *  pCount )

Get the number of SMs in the incoming box.

Parameters:
pCountpointer to store the number of unprocessed SMs on
Returns:
0 on success, error code on failure

Definition at line 185 of file SMSInterface.cpp.

int init (  )

Initialize interface Configure SMS commands & register for SMS-related unsolicited result codes.

Definition at line 43 of file SMSInterface.cpp.

int send ( const char *  number,
const char *  message 
)

Send a SM.

Parameters:
numberThe receiver's phone number
messageThe message to send
Returns:
0 on success, error code on failure

Definition at line 78 of file SMSInterface.cpp.

Generated on Tue Jul 12 2022 17:50:57 by  doxygen 1.7.2