]> git.stg.codes - stg.git/blob - include/stg/user.h
Placeholder added to the XML-RPC API documentation book
[stg.git] / include / stg / user.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 : Maxim Mamontov <faust@stargazer.dp.ua>
19  */
20
21 #ifndef USER_H
22 #define USER_H
23
24 #include <ctime>
25 #include <string>
26
27 #include "os_int.h"
28 #include "notifer.h"
29 #include "message.h"
30 #include "tariff.h"
31 #include "user_traff.h"
32
33 class USER_PROPERTIES;
34 class AUTH;
35
36 class USER {
37 public:
38     virtual int                 WriteConf() = 0;
39     virtual int                 WriteStat() = 0;
40
41     virtual const std::string & GetLogin() const = 0;
42
43     virtual uint32_t            GetCurrIP() const = 0;
44     virtual time_t              GetCurrIPModificationTime() const = 0;
45
46     virtual void                AddCurrIPBeforeNotifier(PROPERTY_NOTIFIER_BASE<uint32_t> * notifier) = 0;
47     virtual void                DelCurrIPBeforeNotifier(PROPERTY_NOTIFIER_BASE<uint32_t> * notifier) = 0;
48
49     virtual void                AddCurrIPAfterNotifier(PROPERTY_NOTIFIER_BASE<uint32_t> * notifier) = 0;
50     virtual void                DelCurrIPAfterNotifier(PROPERTY_NOTIFIER_BASE<uint32_t> * notifier) = 0;
51
52     virtual void                AddConnectedBeforeNotifier(PROPERTY_NOTIFIER_BASE<bool> * notifier) = 0;
53     virtual void                DelConnectedBeforeNotifier(PROPERTY_NOTIFIER_BASE<bool> * notifier) = 0;
54
55     virtual void                AddConnectedAfterNotifier(PROPERTY_NOTIFIER_BASE<bool> * notifier) = 0;
56     virtual void                DelConnectedAfterNotifier(PROPERTY_NOTIFIER_BASE<bool> * notifier) = 0;
57
58     virtual int                 GetID() const = 0;
59
60     virtual double              GetPassiveTimePart() const = 0;
61
62     virtual const TARIFF *      GetTariff() const = 0;
63     virtual void                ResetNextTariff() = 0;
64
65     virtual const DIR_TRAFF &   GetSessionUpload() const = 0;
66     virtual const DIR_TRAFF &   GetSessionDownload() const = 0;
67
68     virtual bool                GetConnected() const = 0;
69     virtual time_t              GetConnectedModificationTime() const = 0;
70     virtual int                 GetAuthorized() const = 0;
71     virtual int                 Authorize(uint32_t ip,
72                                           uint32_t enabledDirs,
73                                           const AUTH * auth) = 0;
74     virtual void                Unauthorize(const AUTH * auth) = 0;
75     virtual bool                IsAuthorizedBy(const AUTH * auth) const = 0;
76
77     virtual int                 AddMessage(STG_MSG * msg) = 0;
78
79     virtual void                UpdatePingTime(time_t t = 0) = 0;
80     virtual time_t              GetPingTime() const = 0;
81
82     virtual void                Run() = 0;
83
84     virtual const std::string & GetStrError() const = 0;
85
86     virtual USER_PROPERTIES &   GetProperty() = 0;
87     virtual const USER_PROPERTIES & GetProperty() const = 0;
88
89     virtual bool                GetDeleted() const = 0;
90     virtual void                SetDeleted() = 0;
91
92     virtual time_t              GetLastWriteStatTime() const = 0;
93
94     virtual bool                IsInetable() = 0;
95     virtual std::string         GetEnabledDirs() = 0;
96
97     virtual void                OnAdd() = 0;
98     virtual void                OnDelete() = 0;
99 };
100
101 typedef USER * USER_PTR;
102
103 #endif