aboutsummaryrefslogtreecommitdiffstats
path: root/libemail-engine/mail-mt.h
blob: 8ac8b8c2934e2891a299d9bb5c71b0b22a0f136b (plain) (blame)
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
/*
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2 of the License, or (at your option) version 3.
 *
 * 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
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with the program; if not, see <http://www.gnu.org/licenses/>
 *
 *
 * Authors:
 *      Michael Zucchi <notzed@ximian.com>
 *
 * Copyright (C) 1999-2008 Novell, Inc. (www.novell.com)
 *
 */

#if !defined (__LIBEMAIL_ENGINE_H_INSIDE__) && !defined (LIBEMAIL_ENGINE_COMPILATION)
#error "Only <libemail-engine/libemail-engine.h> should be included directly."
#endif

#ifndef _MAIL_MT
#define _MAIL_MT

#include <camel/camel.h>

#include <e-util/e-util.h>

typedef struct _MailMsg MailMsg;
typedef struct _MailMsgInfo MailMsgInfo;

typedef gchar * (*MailMsgDescFunc)      (MailMsg *msg);
typedef void    (*MailMsgExecFunc)      (MailMsg *msg,
                         GCancellable *cancellable,
                         GError **error);
typedef void    (*MailMsgDoneFunc)      (MailMsg *msg);
typedef void    (*MailMsgFreeFunc)      (MailMsg *msg);
typedef void    (*MailMsgDispatchFunc)      (gpointer msg);

typedef void    (*MailMsgCreateActivityFunc)    (GCancellable *cancellable);
typedef void    (*MailMsgSubmitActivityFunc)    (GCancellable *cancellable);
typedef void    (*MailMsgFreeActivityFunc)  (GCancellable *cancellable);
typedef void    (*MailMsgCompleteActivityFunc)  (GCancellable *cancellable);
typedef void    (*MailMsgCancelActivityFunc)    (GCancellable *cancellable);
typedef void    (*MailMsgAlertErrorFunc)    (GCancellable *cancellable,
                         const gchar *what,
                         const gchar *message);
typedef EAlertSink *
        (*MailMsgGetAlertSinkFunc)  (void);

struct _MailMsg {
    MailMsgInfo *info;
    volatile gint ref_count;
    guint seq;          /* seq number for synchronisation */
    gint priority;          /* priority (default = 0) */
    GCancellable *cancellable;
    GError *error;          /* up to the caller to use this */
};

struct _MailMsgInfo {
    gsize size;
    MailMsgDescFunc desc;
    MailMsgExecFunc exec;
    MailMsgDoneFunc done;
    MailMsgFreeFunc free;
};

/* Just till we move this out to EDS */
EAlertSink *    mail_msg_get_alert_sink (void);

/* setup ports */
void mail_msg_init (void);
void mail_msg_register_activities (MailMsgCreateActivityFunc,
                   MailMsgSubmitActivityFunc,
                   MailMsgFreeActivityFunc,
                   MailMsgCompleteActivityFunc,
                   MailMsgCancelActivityFunc,
                   MailMsgAlertErrorFunc,
                   MailMsgGetAlertSinkFunc);

gboolean mail_in_main_thread (void);

/* allocate a new message */
gpointer mail_msg_new (MailMsgInfo *info);
gpointer mail_msg_ref (gpointer msg);
void mail_msg_unref (gpointer msg);
void mail_msg_check_error (gpointer msg);
void mail_msg_cancel (guint msgid);
gboolean mail_msg_active (void);

/* dispatch a message */
void mail_msg_main_loop_push (gpointer msg);
void mail_msg_unordered_push (gpointer msg);
void mail_msg_fast_ordered_push (gpointer msg);
void mail_msg_slow_ordered_push (gpointer msg);

/* To implement the stop button */
void mail_cancel_all (void);

/* Call a function in the GUI thread, wait for it to return, type is
 * the marshaller to use.  FIXME This thing is horrible, please put
 * it out of its misery. */
typedef enum {
    MAIL_CALL_p_p,
    MAIL_CALL_p_pp,
    MAIL_CALL_p_ppp,
    MAIL_CALL_p_pppp,
    MAIL_CALL_p_ppppp,
    MAIL_CALL_p_ppippp
} mail_call_t;

typedef gpointer (*MailMainFunc)();

gpointer mail_call_main (mail_call_t type, MailMainFunc func, ...);

#endif /* _MAIL_MT */