Removed SessionMsgType enum and its use, since it is useless.
[claws.git] / src / common / session.h
index b57c57dc1bb1b2001c1a4c6e106c2a63c73f1ebb..72b451261c5a08eec72b67c79b511cdf85760c1f 100644 (file)
@@ -1,10 +1,10 @@
 /*
  * Sylpheed -- a GTK+ based, lightweight, and fast e-mail client
- * Copyright (C) 1999-2002 Hiroyuki Yamamoto
+ * Copyright (C) 1999-2012 Hiroyuki Yamamoto and the Claws Mail team
  *
  * 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
+ * the Free Software Foundation; either version 3 of the License, or
  * (at your option) any later version.
  *
  * This program is distributed in the hope that it will be useful,
  * 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., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
+ * along with this program. If not, see <http://www.gnu.org/licenses/>.
+ * 
  */
 
 #ifndef __SESSION_H__
 #define __SESSION_H__
 
+#ifdef HAVE_CONFIG_H
+#include "claws-features.h"
+#endif
+
 #include <glib.h>
+
 #include <time.h>
+#include <unistd.h>
 
 #include "socket.h"
 
+#define SESSION_BUFFSIZE       4096
+
 typedef struct _Session        Session;
 
 #define SESSION(obj)   ((Session *)obj)
 
 typedef enum {
+       SESSION_UNKNOWN,
        SESSION_IMAP,
        SESSION_NEWS,
-       SESSION_SMTP
+       SESSION_SMTP,
+       SESSION_POP3
 } SessionType;
 
 typedef enum {
        SESSION_READY,
        SESSION_SEND,
-       SESSION_RECV
-} SessionPhase;
-
-typedef void (*SessionUIFunc)  (gpointer        data,
-                                gint            state);
+       SESSION_RECV,
+       SESSION_EOF,
+       SESSION_TIMEOUT,
+       SESSION_ERROR,
+       SESSION_DISCONNECTED
+} SessionState;
+
+typedef gint (*RecvMsgNotify)                  (Session        *session,
+                                                const gchar    *msg,
+                                                gpointer        user_data);
+typedef gint (*RecvDataProgressiveNotify)      (Session        *session,
+                                                guint           cur_len,
+                                                guint           total_len,
+                                                gpointer        user_data);
+typedef gint (*RecvDataNotify)                 (Session        *session,
+                                                guint           len,
+                                                gpointer        user_data);
+typedef gint (*SendDataProgressiveNotify)      (Session        *session,
+                                                guint           cur_len,
+                                                guint           total_len,
+                                                gpointer        user_data);
+typedef gint (*SendDataNotify)                 (Session        *session,
+                                                guint           len,
+                                                gpointer        user_data);
 
 struct _Session
 {
        SessionType type;
 
        SockInfo *sock;
+
        gchar *server;
+       gushort port;
+
+       gboolean nonblocking;
 
-       gboolean connected;
-       SessionPhase phase;
+       SessionState state;
 
        time_t last_access_time;
+       GTimeVal tv_prev;
 
-       gpointer data;
+       gint conn_id;
 
-       void (*destroy)         (Session        *session);
+       gint io_tag;
+
+       gchar read_buf[SESSION_BUFFSIZE];
+       gchar *read_buf_p;
+       gint read_buf_len;
+
+       GString *read_msg_buf;
+       GByteArray *read_data_buf;
+       gchar *read_data_terminator;
+
+       /* buffer for short messages */
+       gchar *write_buf;
+       gchar *write_buf_p;
+       gint write_buf_len;
+
+       /* buffer for large data */
+       const guchar *write_data;
+       const guchar *write_data_p;
+       gint write_data_len;
+
+       guint timeout_tag;
+       guint timeout_interval;
+
+       gpointer data;
 
-       SessionUIFunc ui_func;
+       /* virtual methods to parse server responses */
+       gint (*recv_msg)                (Session        *session,
+                                        const gchar    *msg);
+
+       void (*connect_finished)        (Session        *session,
+                                        gboolean       success);
+       gint (*send_data_finished)      (Session        *session,
+                                        guint           len);
+       gint (*recv_data_finished)      (Session        *session,
+                                        guchar         *data,
+                                        guint           len);
+
+       void (*destroy)                 (Session        *session);
+
+       /* notification functions */
+       RecvMsgNotify                   recv_msg_notify;
+       RecvDataProgressiveNotify       recv_data_progressive_notify;
+       RecvDataNotify                  recv_data_notify;
+       SendDataProgressiveNotify       send_data_progressive_notify;
+       SendDataNotify                  send_data_notify;
+
+       gpointer recv_msg_notify_data;
+       gpointer recv_data_progressive_notify_data;
+       gpointer recv_data_notify_data;
+       gpointer send_data_progressive_notify_data;
+       gpointer send_data_notify_data;
+
+       const void *account;
+       gboolean is_smtp;
+       gboolean ssl_cert_auto_accept;
+       gint ping_tag;
+
+#ifdef USE_GNUTLS
+       SSLType ssl_type;
+       gchar *gnutls_priority;
+#endif
 };
 
-void session_destroy   (Session        *session);
+void session_init              (Session        *session, 
+                                const void     *prefs_account,
+                                gboolean        is_smtp);
+gint session_connect           (Session        *session,
+                                const gchar    *server,
+                                gushort         port);
+gint session_disconnect                (Session        *session);
+void session_destroy           (Session        *session);
+gboolean session_is_running    (Session        *session);
+gboolean session_is_connected  (Session        *session);
+
+void session_set_access_time   (Session        *session);
+
+void session_set_timeout       (Session        *session,
+                                guint           interval);
+
+void session_set_recv_message_notify   (Session        *session,
+                                        RecvMsgNotify   notify_func,
+                                        gpointer        data);
+void session_set_recv_data_progressive_notify
+                                       (Session        *session,
+                                        RecvDataProgressiveNotify notify_func,
+                                        gpointer        data);
+void session_set_recv_data_notify      (Session        *session,
+                                        RecvDataNotify  notify_func,
+                                        gpointer        data);
+void session_set_send_data_progressive_notify
+                                       (Session        *session,
+                                        SendDataProgressiveNotify notify_func,
+                                        gpointer        data);
+void session_set_send_data_notify      (Session        *session,
+                                        SendDataNotify  notify_func,
+                                        gpointer        data);
+
+#ifdef USE_GNUTLS
+gint session_start_tls (Session        *session);
+#endif
+
+gint session_send_msg  (Session        *session,
+                        const gchar    *msg);
+gint session_recv_msg  (Session        *session);
+gint session_send_data (Session        *session,
+                        const guchar   *data,
+                        guint           size);
+gint session_recv_data (Session        *session,
+                        guint           size,
+                        const gchar    *terminator);
+void session_register_ping(Session *session, gboolean (*ping_cb)(gpointer data));
 
 #endif /* __SESSION_H__ */