projects/smsdaemon/Plugin.h

#ifndef __PLUGIN_H__
#define __PLUGIN_H__

#include <string>

/*
 * Abstract parent class for a sms-daemon plugin.
 */

#include "Sms.h"

class GsmModem;

class Plugin
{
public:
        Plugin(std::string cmd, std::string desc);

        /* Called when a incomming sms triggers this plugin.
         * Use the conversation object to write the response.
         * Note: the plugin is responsible for parsing and validating the arguments, 
         * and if necessary write a error message back to the user.
         */
        virtual void Execute(GsmModem& modem, SMS& sms) = 0;

        /*
         * returns the command that triggers this plugin, for example:  "myplugin"
         */
        virtual std::string GetCommand() {return _command;}

        /*
         * Returns a desciption of this plugin - displayed when somebody calls "help"
         */
        virtual std::string GetDescription() {return _description;}

        virtual ~Plugin() {}
protected:

        std::string _command;
        std::string _description;
};


#endif // __PLUGIN_H__
1	torben	26	#ifndef __PLUGIN_H__
2			#define __PLUGIN_H__
3
4			#include <string>
5
6			/*
7			* Abstract parent class for a sms-daemon plugin.
8			*/
9
10			#include "Sms.h"
11
12			class GsmModem;
13
14			class Plugin
15			{
16			public:
17	torben	28	Plugin(std::string cmd, std::string desc);
18	torben	26
19			/* Called when a incomming sms triggers this plugin.
20			* Use the conversation object to write the response.
21			* Note: the plugin is responsible for parsing and validating the arguments,
22			* and if necessary write a error message back to the user.
23			*/
24			virtual void Execute(GsmModem& modem, SMS& sms) = 0;
25
26			/*
27			* returns the command that triggers this plugin, for example: "myplugin"
28			*/
29	torben	28	virtual std::string GetCommand() {return _command;}
30	torben	26
31			/*
32			* Returns a desciption of this plugin - displayed when somebody calls "help"
33			*/
34	torben	28	virtual std::string GetDescription() {return _description;}
35	torben	26
36			virtual ~Plugin() {}
37	torben	28	protected:
38	torben	30
39			std::string _command;
40	torben	28	std::string _description;
41	torben	26	};
42
43
44			#endif // __PLUGIN_H__