]> git.stg.codes - stg.git/blob - projects/stargazer/plugin_runner.h
Fix tariff field name in XML-RPC API documentation (tariff -> name)
[stg.git] / projects / stargazer / plugin_runner.h
1 /*
2  *    This program is free software; you can redistribute it and/or modify
3  *    it under the terms of the GNU General Public License as published by
4  *    the Free Software Foundation; either version 2 of the License, or
5  *    (at your option) any later version.
6  *
7  *    This program is distributed in the hope that it will be useful,
8  *    but WITHOUT ANY WARRANTY; without even the implied warranty of
9  *    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
10  *    GNU General Public License for more details.
11  *
12  *    You should have received a copy of the GNU General Public License
13  *    along with this program; if not, write to the Free Software
14  *    Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
15  */
16
17 /*
18  *    Author : Boris Mikhailenko <stg34@stargazer.dp.ua>
19  */
20
21 /*
22  $Revision: 1.13 $
23  $Date: 2010/03/04 12:22:41 $
24  $Author: faust $
25  */
26
27 #ifndef PLUGIN_RUNNER_H
28 #define PLUGIN_RUNNER_H
29
30 #include <string>
31
32 #include "stg/module_settings.h"
33 #include "stg/plugin.h"
34 #include "stg/os_int.h"
35
36 class SETTINGS_IMPL;
37 class ADMINS_IMPL;
38 class TARIFFS_IMPL;
39 class USERS_IMPL;
40 class TRAFFCOUNTER;
41 class STORE;
42
43 //-----------------------------------------------------------------------------
44 class PLUGIN_RUNNER {
45 public:
46     PLUGIN_RUNNER(const std::string & pluginFileName,
47                   const MODULE_SETTINGS & ms,
48                   ADMINS_IMPL * admins,
49                   TARIFFS_IMPL * tariffs,
50                   USERS_IMPL * users,
51                   TRAFFCOUNTER * tc,
52                   STORE * store,
53                   const SETTINGS_IMPL * s);
54     PLUGIN_RUNNER(const PLUGIN_RUNNER & rvalue);
55     ~PLUGIN_RUNNER();
56
57     PLUGIN_RUNNER & operator=(const PLUGIN_RUNNER & rvalue);
58
59     int             Start();
60     int             Stop();
61     int             Reload();
62     int             Restart();
63     bool            IsRunning();
64
65     const std::string & GetStrError() const { return errorStr; }
66     PLUGIN *        GetPlugin();
67     const std::string & GetFileName() const { return pluginFileName; }
68
69     int             Load();
70     int             Unload();
71
72     uint16_t        GetStartPosition() const { return plugin->GetStartPosition(); }
73     uint16_t        GetStopPosition() const { return plugin->GetStopPosition(); }
74
75 private:
76     std::string     pluginFileName;
77     std::string     pluginSettingFileName;
78
79     PLUGIN *        plugin;
80     bool            isPluginLoaded;
81     std::string     errorStr;
82
83     void *          libHandle;
84     bool            isRunning;
85
86     ADMINS_IMPL *   admins;
87     TARIFFS_IMPL *  tariffs;
88     USERS_IMPL *    users;
89     STORE *         store;
90     TRAFFCOUNTER *  traffCnt;
91     const SETTINGS_IMPL * stgSettings;
92     MODULE_SETTINGS modSettings;
93 };
94 //-----------------------------------------------------------------------------
95 #endif //PLUGIN_RUNNER_H