aboutsummaryrefslogtreecommitdiffstats
path: root/src/messaging/serviceInfos.hpp
blob: d9ba75102650875b10566924dacc464879ef1188 (plain)
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
//
// 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_SERVICEINFOS_HPP_INCLUDED
#define VMIME_MESSAGING_SERVICEINFOS_HPP_INCLUDED


#include <vector>

#include "../types.hpp"


namespace vmime {
namespace messaging {


/** Stores information about a messaging service.
  */

class serviceInfos
{
	friend class serviceFactory;

protected:

	serviceInfos() { }
	serviceInfos(const serviceInfos&) { }

private:

	serviceInfos& operator=(const serviceInfos&) { return (*this); }

public:

	virtual ~serviceInfos() { }

	/** Return the default port used for the underlying protocol.
	  *
	  * @return default port number
	  */
	virtual const port_t getDefaultPort() const = 0;

	/** Return the property prefix used by this service.
	  * Use this to set/get properties in the session object.
	  *
	  * @return property prefix
	  */
	virtual const string getPropertyPrefix() const = 0;

	/** Return a list of available properties for this service.
	  *
	  * @return list of property names
	  */
	virtual const std::vector <string> getAvailableProperties() const = 0;
};


} // messaging
} // vmime


#endif // VMIME_MESSAGING_SERVICEINFOS_HPP_INCLUDED