aboutsummaryrefslogtreecommitdiffstats
path: root/src/platformDependant.hpp
diff options
context:
space:
mode:
Diffstat (limited to 'src/platformDependant.hpp')
-rw-r--r--src/platformDependant.hpp155
1 files changed, 155 insertions, 0 deletions
diff --git a/src/platformDependant.hpp b/src/platformDependant.hpp
new file mode 100644
index 00000000..920e970b
--- /dev/null
+++ b/src/platformDependant.hpp
@@ -0,0 +1,155 @@
+//
+// 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_PLATFORMDEPENDANT_HPP_INCLUDED
+#define VMIME_PLATFORMDEPENDANT_HPP_INCLUDED
+
+
+#include "config.hpp"
+#include "dateTime.hpp"
+#include "exception.hpp"
+#include "charset.hpp"
+
+#if VMIME_HAVE_MESSAGING_FEATURES
+ #include "messaging/socket.hpp"
+ #include "messaging/timeoutHandler.hpp"
+#endif
+
+#if VMIME_HAVE_FILESYSTEM_FEATURES
+ #include "utility/file.hpp"
+#endif
+
+
+namespace vmime
+{
+
+
+/** The link between your application and VMime. It offers an interface to
+ * access platform-dependant objects: sockets, date/time, file system, etc.
+ */
+
+class platformDependant
+{
+public:
+
+ class handler
+ {
+ public:
+
+ virtual ~handler();
+
+ /** Return the current UNIX time (Epoch time): the number of
+ * seconds elapsed since Jan, 1st 1970 00:00.
+ *
+ * @return UNIX Epoch time
+ */
+ virtual const unsigned int getUnixTime() const = 0;
+
+ /** Return the current date and time, in the local time zone.
+ *
+ * @return current date and time
+ */
+ virtual const datetime getCurrentLocalTime() const = 0;
+
+ /** Return the host name of the system.
+ * Used when generating message ids.
+ *
+ * @return host name
+ */
+ virtual const string getHostName() const = 0;
+
+ /** Return the current process identifier.
+ * Used when generating random strings (part boundaries or message ids).
+ *
+ * @return current process id
+ */
+ virtual const unsigned int getProcessId() const = 0;
+
+ /** Return the charset used on the system.
+ *
+ * @return locale charset
+ */
+ virtual const charset getLocaleCharset() const = 0;
+
+ /** This function is called when VMime library is waiting for
+ * something (for example, it is called when there is no data
+ * available in a socket). On POSIX-compliant systems, a
+ * simple call to sched_yield() should suffice.
+ */
+ virtual void wait() const = 0;
+
+#if VMIME_HAVE_MESSAGING_FEATURES
+ /** Return a pointer to a socket factory for the specified socket
+ * type name (this is user-defined, and used for example when you
+ * want to set up a SSL connection to a server).
+ * The returned object will not be deleted by VMime, so it can be
+ * a pointer to a static object.
+ *
+ * @param name socket type name (user-dependant): this is usually
+ * the value of the property "server.socket-factory" set in the
+ * session object
+ * @return socket factory
+ */
+ virtual messaging::socketFactory* getSocketFactory(const string& name = "default") const = 0;
+
+ /** Return a pointer to a timeout-handler factory for the specified name.
+ * The returned object will not be deleted by VMime, so it can be a
+ * pointer to a static object.
+ *
+ * This is used when you want to handle a timeout-mechanism when
+ * connecting to messaging servers (please read the documentation to
+ * learn how to use it). If you are not using time-out handlers, you
+ * can safely return NULL here.
+ *
+ * @param name time-out type name
+ * @return time-out factory
+ */
+ virtual messaging::timeoutHandlerFactory* getTimeoutHandlerFactory(const string& name = "default") const = 0;
+#endif
+#if VMIME_HAVE_FILESYSTEM_FEATURES
+ virtual utility::fileSystemFactory* getFileSystemFactory() const = 0;
+#endif
+ };
+
+
+ template <class TYPE>
+ static void setHandler()
+ {
+ delete (sm_handler);
+ sm_handler = new TYPE;
+ }
+
+ static const handler* const getHandler()
+ {
+ if (!sm_handler)
+ throw exceptions::no_platform_dependant_handler();
+
+ return (sm_handler);
+ }
+
+private:
+
+ static handler* sm_handler;
+};
+
+
+} // vmime
+
+
+#endif // VMIME_PLATFORMDEPENDANT_HPP_INCLUDED