]> git.stg.codes - stg.git/blob - projects/stargazer/plugin_runner.h
convertor -> sgconv in docs.
[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  *    Author : Maksym Mamontov <stg@madf.info>
20  */
21
22 #ifndef PLUGIN_RUNNER_H
23 #define PLUGIN_RUNNER_H
24
25 #include "stg/plugin.h"
26 #include "stg/module_settings.h"
27 #include "stg/os_int.h"
28
29 #include <string>
30 #include <stdexcept>
31
32 class SETTINGS;
33 class ADMINS;
34 class TARIFFS;
35 class USERS;
36 class SERVICES;
37 class CORPORATIONS;
38 class TRAFFCOUNTER;
39 class STORE;
40
41 //-----------------------------------------------------------------------------
42 class PLUGIN_RUNNER {
43 public:
44     struct Error : public std::runtime_error {
45         explicit Error(const std::string & msg) : runtime_error(msg) {}
46     };
47
48     PLUGIN_RUNNER(const std::string & pluginFileName,
49                   const std::string & pluginName,
50                   const MODULE_SETTINGS & ms,
51                   ADMINS & admins,
52                   TARIFFS & tariffs,
53                   USERS & users,
54                   SERVICES & services,
55                   CORPORATIONS & corporations,
56                   TRAFFCOUNTER & traffcounter,
57                   STORE & store,
58                   const SETTINGS & settings);
59     ~PLUGIN_RUNNER();
60
61     int             Start();
62     int             Stop();
63     int             Reload(const MODULE_SETTINGS & ms);
64     int             Restart();
65     bool            IsRunning() { return m_plugin.IsRunning(); }
66
67     const std::string & GetStrError() const { return errorStr; }
68     PLUGIN &        GetPlugin() { return m_plugin; }
69     const std::string & GetFileName() const { return pluginFileName; }
70     const std::string & GetName() const { return pluginName; }
71
72     uint16_t        GetStartPosition() const { return m_plugin.GetStartPosition(); }
73     uint16_t        GetStopPosition() const { return m_plugin.GetStopPosition(); }
74
75 private:
76     PLUGIN_RUNNER(const PLUGIN_RUNNER & rvalue);
77     PLUGIN_RUNNER & operator=(const PLUGIN_RUNNER & rvalue);
78
79     PLUGIN & Load(const MODULE_SETTINGS & ms,
80                   ADMINS & admins,
81                   TARIFFS & tariffs,
82                   USERS & users,
83                   SERVICES & services,
84                   CORPORATIONS & corporations,
85                   TRAFFCOUNTER & traffcounter,
86                   STORE & store,
87                   const SETTINGS & settings);
88
89     std::string     pluginFileName;
90     std::string     pluginName;
91     void *          libHandle;
92
93     PLUGIN &        m_plugin;
94     std::string     errorStr;
95 };
96 //-----------------------------------------------------------------------------
97 #endif //PLUGIN_RUNNER_H