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 122 123 124 125 126 127 128 129 130 131 132
|
/* -*- Mode: C; tab-width: 8; indent-tabs-mode: t; c-basic-offset: 8 -*-
*
* Authors: Michael Zucchi <notzed@ximian.com>
*
* Copyright 2000, Ximian, Inc. (www.ximian.com)
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of version 2 of the GNU General Public
* License as published by the Free Software Foundation.
*
* 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., 59 Temple Place - Suite 330,
* Boston, MA 02111-1307, USA.
*
*/
#ifndef _MAIL_MT
#define _MAIL_MT
#include <pthread.h>
#include "camel/camel-exception.h"
#include "libedataserver/e-msgport.h"
#include "camel/camel-object.h"
#include "camel/camel-operation.h"
typedef struct _mail_msg {
EMsg msg; /* parent type */
struct _mail_msg_op *ops; /* operation functions */
unsigned int seq; /* seq number for synchronisation */
CamelOperation *cancel; /* a cancellation/status handle */
CamelException ex; /* an initialised camel exception, upto the caller to use this */
struct _mail_msg_priv *priv; /* private for internal use */
} mail_msg_t;
/* callback functions for thread message */
typedef struct _mail_msg_op {
char *(*describe_msg)(struct _mail_msg *msg, int complete);
void (*receive_msg)(struct _mail_msg *msg); /* message received */
void (*reply_msg)(struct _mail_msg *msg); /* message replied */
void (*destroy_msg)(struct _mail_msg *msg); /* finalise message */
} mail_msg_op_t;
/* setup ports */
void mail_msg_init(void);
void mail_msg_cleanup (void);
/* allocate a new message */
void *mail_msg_new(mail_msg_op_t *ops, EMsgPort *reply_port, size_t size);
void mail_msg_free(void *msg);
void mail_msg_check_error(void *msg);
void mail_msg_cancel(unsigned int msgid);
void mail_msg_wait(unsigned int msgid);
void mail_msg_wait_all(void);
int mail_msg_active(unsigned int msgid);
/* To implement the stop button */
void *mail_cancel_hook_add(GDestroyNotify func, void *data);
void mail_cancel_hook_remove(void *handle);
void mail_cancel_all(void);
/* request a string/password */
char *mail_get_password (CamelService *service, const char *prompt,
gboolean secret, gboolean *cache);
/* present information and get an ok (or possibly cancel)
* "type" is as for gnome_message_box_new();
*/
gboolean mail_user_message (const char *type, const char *prompt, gboolean allow_cancel);
/* asynchronous event proxies */
typedef struct _MailAsyncEvent {
GMutex *lock;
GSList *tasks;
} MailAsyncEvent;
typedef enum _mail_async_event_t {
MAIL_ASYNC_GUI,
MAIL_ASYNC_THREAD,
} mail_async_event_t;
typedef void (*MailAsyncFunc)(void *, void *, void *);
/* create a new async event handler */
MailAsyncEvent *mail_async_event_new(void);
/* forward a camel event (or other call) to the gui thread */
int mail_async_event_emit(MailAsyncEvent *ea, mail_async_event_t type, MailAsyncFunc func, void *, void *, void *);
/* wait for all outstanding async events to complete */
int mail_async_event_destroy(MailAsyncEvent *ea);
/* Call a function in the gui thread, wait for it to return, type is the marshaller to use */
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 void *(*MailMainFunc)();
void *mail_call_main(mail_call_t type, MailMainFunc func, ...);
/* use with caution. only works with active message's anyway */
void mail_enable_stop(void);
void mail_disable_stop(void);
/* a message port that receives messages in the gui thread, used for sending port */
extern EMsgPort *mail_gui_port;
/* a message port that receives messages in the gui thread, used for the reply port */
extern EMsgPort *mail_gui_reply_port;
/* some globally available threads */
extern EThread *mail_thread_queued; /* for operations that can (or should) be queued */
extern EThread *mail_thread_new; /* for operations that should run in a new thread each time */
extern EThread *mail_thread_queued_slow; /* for operations that can (or should) be queued, but take a long time */
/* The main thread. */
extern pthread_t mail_gui_thread;
/* A generic proxy event for anything that can be proxied during the life of the mailer (almost nothing) */
/* Note that almost all objects care about the lifecycle of their events, so this cannot be used */
extern MailAsyncEvent *mail_async_event;
#endif /* ! _MAIL_MT */
|