]> git.stg.codes - stg.git/blob - include/stg/plugin.h
Disable doc generation in release archives.
[stg.git] / include / stg / plugin.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.12 $
23  $Date: 2010/03/04 11:53:14 $
24  $Author: faust $
25 */
26
27
28 #ifndef PLUGIN_H
29 #define PLUGIN_H
30
31 #include <string>
32
33 #include "noncopyable.h"
34 #include "os_int.h"
35 #include "admins.h"
36 #include "users.h"
37 #include "tariffs.h"
38 #include "services.h"
39 #include "corporations.h"
40
41 class TRAFFCOUNTER;
42 class SETTINGS;
43 class STORE;
44 struct MODULE_SETTINGS;
45
46 class PLUGIN : private NONCOPYABLE {
47 public:
48     virtual ~PLUGIN() {}
49     virtual void                SetUsers(USERS *) {}
50     virtual void                SetTariffs(TARIFFS *) {}
51     virtual void                SetAdmins(ADMINS *) {}
52     virtual void                SetServices(SERVICES *) {}
53     virtual void                SetCorporations(CORPORATIONS *) {}
54     virtual void                SetTraffcounter(TRAFFCOUNTER *) {}
55     virtual void                SetStore(STORE *) {}
56     virtual void                SetStgSettings(const SETTINGS *) {}
57     virtual void                SetSettings(const MODULE_SETTINGS &) {}
58     virtual int                 ParseSettings() = 0;
59
60     virtual int                 Start() = 0;
61     virtual int                 Stop() = 0;
62     virtual int                 Reload(const MODULE_SETTINGS &) = 0;
63     virtual bool                IsRunning() = 0;
64     virtual const std::string & GetStrError() const = 0;
65     virtual std::string         GetVersion() const = 0;
66     virtual uint16_t            GetStartPosition() const = 0;
67     virtual uint16_t            GetStopPosition() const = 0;
68 };
69
70 #endif