]> git.stg.codes - stg.git/blob - projects/stargazer/plugin_runner.h
Merge remote-tracking branch 'github/master'
[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 : Maxim Mamontov <faust@stargazer.dp.ua>
20  */
21
22 #pragma once
23
24 #include "stg/plugin.h"
25
26 #include <string>
27 #include <stdexcept>
28 #include <cstdint>
29
30 namespace STG
31 {
32
33 struct ModuleSettings;
34 struct Settings;
35 struct Admins;
36 class Tariffs;
37 class Users;
38 struct Services;
39 struct Corporations;
40 struct TraffCounter;
41 struct Store;
42
43 //-----------------------------------------------------------------------------
44 class PluginRunner {
45 public:
46     struct Error : public std::runtime_error {
47         explicit Error(const std::string & msg) : runtime_error(msg) {}
48     };
49
50     PluginRunner(const std::string& pluginFileName,
51                  const std::string& pluginName,
52                  const ModuleSettings& ms,
53                  Admins& admins,
54                  Tariffs& tariffs,
55                  Users& users,
56                  Services& services,
57                  Corporations& corporations,
58                  TraffCounter& traffcounter,
59                  Store& store,
60                  const Settings & settings);
61     ~PluginRunner();
62
63     int             Start();
64     int             Stop();
65     int             Reload(const ModuleSettings& ms);
66     int             Restart();
67     bool            IsRunning() { return m_plugin.IsRunning(); }
68
69     const std::string& GetStrError() const { return errorStr; }
70     Plugin& GetPlugin() { return m_plugin; }
71     const std::string& GetFileName() const { return pluginFileName; }
72     const std::string& GetName() const { return pluginName; }
73
74     uint16_t        GetStartPosition() const { return m_plugin.GetStartPosition(); }
75     uint16_t        GetStopPosition() const { return m_plugin.GetStopPosition(); }
76
77 private:
78     Plugin & load(const ModuleSettings& ms,
79                   Admins& admins,
80                   Tariffs& tariffs,
81                   Users& users,
82                   Services& services,
83                   Corporations& corporations,
84                   TraffCounter& traffcounter,
85                   Store& store,
86                   const Settings& settings);
87
88     std::string pluginFileName;
89     std::string pluginName;
90     void*       libHandle;
91
92     Plugin&     m_plugin;
93     std::string errorStr;
94 };
95 //-----------------------------------------------------------------------------
96 }