1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
|
//
// VMime library (http://vmime.sourceforge.net)
// Copyright (C) 2002-2004 Vincent Richard <[email protected]>
//
// This program is free software; you can redistribute it and/or
// modify it under the terms of the GNU General Public License as
// published by the Free Software Foundation; either version 2 of
// the License, or (at your option) any later version.
//
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
// General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with this program; if not, write to the Free Software
// Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
//
#ifndef VMIME_MESSAGING_SERVICE_HPP_INCLUDED
#define VMIME_MESSAGING_SERVICE_HPP_INCLUDED
#include "../types.hpp"
#include "session.hpp"
#include "authenticator.hpp"
#include "progressionListener.hpp"
#include "serviceFactory.hpp"
#include "serviceInfos.hpp"
namespace vmime {
namespace messaging {
/** Base class for messaging services.
*/
class service
{
protected:
service(session* sess, const serviceInfos& infos, authenticator* auth);
public:
virtual ~service();
// Possible service types
enum Type
{
TYPE_STORE = 0, /**< The service is a message store. */
TYPE_TRANSPORT /**< The service sends messages. */
};
/** Return the type of service.
*
* @return type of service
*/
virtual const Type getType() const = 0;
/** Return the protocol name of this service.
*
* @return protocol name
*/
virtual const string getProtocolName() const = 0;
/** Return the session object associated with this service instance.
*
* @return session object
*/
const session* getSession() const;
/** Return the session object associated with this service instance.
*
* @return session object
*/
session* getSession();
/** Return information about this service.
*
* @return information about the service
*/
virtual const serviceInfos& getInfos() const = 0;
/** Connect to service.
*/
virtual void connect() = 0;
/** Disconnect from service.
*/
virtual void disconnect() = 0;
/** Test whether this service is connected.
*
* @return true if the service is connected, false otherwise
*/
virtual const bool isConnected() const = 0;
/** Do nothing but ensure the server do not disconnect (for
* example, this can reset the auto-logout timer on the
* server, if one exists).
*/
virtual void noop() = 0;
/** Return the authenticator object used with this service instance.
*
* @return authenticator object
*/
const authenticator* getAuthenticator() const;
/** Return the authenticator object used with this service instance.
*
* @return authenticator object
*/
authenticator* getAuthenticator();
#ifndef VMIME_BUILDING_DOC
// Basic service registerer
template <class S>
class initializer
{
public:
initializer(const string& protocol)
{
serviceFactory::getInstance()->
template registerServiceByProtocol <S>(protocol);
}
};
#endif // VMIME_BUILDING_DOC
private:
bool m_deleteAuth;
session* m_session;
authenticator* m_auth;
};
} // messaging
} // vmime
#endif // VMIME_MESSAGING_SERVICE_HPP_INCLUDED
|
