SMSInterface.h

00001 /* SMSInterface.h */
00002 /* Copyright (C) 2012 mbed.org, MIT License
00003  *
00004  * Permission is hereby granted, free of charge, to any person obtaining a copy of this software
00005  * and associated documentation files (the "Software"), to deal in the Software without restriction,
00006  * including without limitation the rights to use, copy, modify, merge, publish, distribute,
00007  * sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is
00008  * furnished to do so, subject to the following conditions:
00009  *
00010  * The above copyright notice and this permission notice shall be included in all copies or
00011  * substantial portions of the Software.
00012  *
00013  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING
00014  * BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
00015  * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
00016  * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
00017  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
00018  */
00019 
00020 #ifndef ISMSINTERFACE_H_
00021 #define ISMSINTERFACE_H_
00022 
00023 #include "core/fwk.h"
00024 
00025 #include "rtos.h"
00026 
00027 #include "at/ATCommandsInterface.h"
00028 
00029 #define MAX_SM 8
00030 
00031 /** Component to use the Short Messages Service (SMS)
00032  *
00033  */
00034 class ISMSInterface
00035 {
00036 public:
00037   /** Initialize interface
00038     Configure SMS commands & register for SMS-related unsolicited result codes
00039    */
00040   virtual int init() = 0;
00041 
00042 
00043   /** Send a SM
00044      @param number The receiver's phone number
00045      @param message The message to send
00046      @return 0 on success, error code on failure
00047    */
00048   virtual int send(const char* number, const char* message) = 0;
00049 
00050 
00051   /** Receive a SM
00052      @param 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)
00053      @param message Pointer to a buffer to store the the incoming message
00054      @param maxLength Maximum message length that can be stored in buffer (including null-terminating character)
00055      @return 0 on success, error code on failure
00056    */
00057   virtual int get(char* number, char* message, size_t maxLength) = 0;
00058 
00059 
00060   /** Get the number of SMs in the incoming box
00061      @param pCount pointer to store the number of unprocessed SMs on
00062      @return 0 on success, error code on failure
00063    */
00064   virtual int getCount(size_t* pCount) = 0;
00065 };
00066 
00067 #endif /* ISMSINTERFACE_H_ */