1 |
#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 |
|
11 |
class ISmsTransceiver; |
12 |
class SMS; |
13 |
|
14 |
class Plugin |
15 |
{ |
16 |
public: |
17 |
Plugin(std::string cmd, std::string desc); |
18 |
|
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(ISmsTransceiver& modem, SMS& sms) = 0; |
25 |
|
26 |
/* |
27 |
* returns the command that triggers this plugin, for example: "myplugin" |
28 |
*/ |
29 |
virtual std::string GetCommand() |
30 |
{ |
31 |
return _command; |
32 |
} |
33 |
|
34 |
/* |
35 |
* Returns a desciption of this plugin - displayed when somebody calls "help" |
36 |
*/ |
37 |
virtual std::string GetDescription() |
38 |
{ |
39 |
return _description; |
40 |
} |
41 |
|
42 |
|
43 |
/* |
44 |
* A helper plugin is not accessible to the client but can be used to build a proxy / decorater plugin |
45 |
*/ |
46 |
virtual bool IsHelper() |
47 |
{ |
48 |
return false; |
49 |
} |
50 |
|
51 |
virtual ~Plugin() {} |
52 |
protected: |
53 |
|
54 |
std::string _command; |
55 |
std::string _description; |
56 |
}; |
57 |
|
58 |
|
59 |
#endif // __PLUGIN_H__ |