SMS.h

00001 /* =====================================================================
00002    Copyright © 2016, Avnet (R)
00003 
00004    Contributors:
00005      * James M Flynn, www.em.avnet.com 
00006  
00007    Licensed under the Apache License, Version 2.0 (the "License"); 
00008    you may not use this file except in compliance with the License.
00009    You may obtain a copy of the License at
00010 
00011     http://www.apache.org/licenses/LICENSE-2.0
00012 
00013    Unless required by applicable law or agreed to in writing, 
00014    software distributed under the License is distributed on an 
00015    "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, 
00016    either express or implied. See the License for the specific 
00017    language governing permissions and limitations under the License.
00018 
00019     @file          SMS.h
00020     @version       1.0
00021     @date          Oct 2016
00022 
00023 ======================================================================== */
00024 
00025 #ifndef SMS_H_
00026 #define SMS_H_
00027 
00028 /** Virtual calss for IoT Short Messages Service (SMS) **/
00029 
00030 class SMSInterface {
00031 public:
00032   /** Initialize interface
00033    */
00034   virtual int init() = 0;
00035 
00036 
00037   /** Send a SM
00038      @param number The receiver's contact number
00039      @param message The message to send
00040      @return 0 on success, error code on failure
00041    */
00042   virtual int send(const string& number, const string& message) = 0;
00043 
00044 
00045   /** Receive a SM
00046      @param msg_orig string containing the sender's phone number
00047      @param Pointer to a string that contains the incoming message
00048      @return 0 on success, error code on failure
00049    */
00050   virtual int get(string& number, string& message) = 0;
00051 };
00052 
00053 #endif /* SMS_H_ */