aboutsummaryrefslogtreecommitdiffstats
path: root/vmime/messaging/service.hpp
diff options
context:
space:
mode:
Diffstat (limited to 'vmime/messaging/service.hpp')
-rw-r--r--vmime/messaging/service.hpp149
1 files changed, 149 insertions, 0 deletions
diff --git a/vmime/messaging/service.hpp b/vmime/messaging/service.hpp
new file mode 100644
index 00000000..76c603e6
--- /dev/null
+++ b/vmime/messaging/service.hpp
@@ -0,0 +1,149 @@
+//
+// 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 "vmime/types.hpp"
+
+#include "vmime/messaging/session.hpp"
+
+#include "vmime/messaging/authenticator.hpp"
+#include "vmime/messaging/progressionListener.hpp"
+
+#include "vmime/messaging/serviceFactory.hpp"
+#include "vmime/messaging/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