1 /* Copyright (c) 2006, Nokia Corporation
4 * Redistribution and use in source and binary forms, with or without
5 * modification, are permitted provided that the following conditions are
8 * * Redistributions of source code must retain the above copyright
9 * notice, this list of conditions and the following disclaimer.
10 * * Redistributions in binary form must reproduce the above copyright
11 * notice, this list of conditions and the following disclaimer in the
12 * documentation and/or other materials provided with the distribution.
13 * * Neither the name of the Nokia Corporation nor the names of its
14 * contributors may be used to endorse or promote products derived from
15 * this software without specific prior written permission.
17 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
18 * IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
19 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
20 * PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER
21 * OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
22 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
23 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
24 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
25 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
26 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
27 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
31 #include "modest-marshal.h"
32 #include "modest-mail-operation-queue.h"
33 #include "modest-runtime.h"
35 /* 'private'/'protected' functions */
36 static void modest_mail_operation_queue_class_init (ModestMailOperationQueueClass *klass);
37 static void modest_mail_operation_queue_init (ModestMailOperationQueue *obj);
38 static void modest_mail_operation_queue_finalize (GObject *obj);
40 static void modest_mail_operation_queue_cancel_no_block_wrapper (ModestMailOperation *mail_op,
41 ModestMailOperationQueue *op_queue);
43 static void modest_mail_operation_queue_cancel_no_block (ModestMailOperationQueue *op_queue,
44 ModestMailOperation *mail_op);
52 typedef struct _ModestMailOperationQueuePrivate ModestMailOperationQueuePrivate;
53 struct _ModestMailOperationQueuePrivate {
58 #define MODEST_MAIL_OPERATION_QUEUE_GET_PRIVATE(o) (G_TYPE_INSTANCE_GET_PRIVATE((o), \
59 MODEST_TYPE_MAIL_OPERATION_QUEUE, \
60 ModestMailOperationQueuePrivate))
62 static GObjectClass *parent_class = NULL;
64 static guint signals[NUM_SIGNALS] = {0};
67 modest_mail_operation_queue_get_type (void)
69 static GType my_type = 0;
71 static const GTypeInfo my_info = {
72 sizeof(ModestMailOperationQueueClass),
74 NULL, /* base finalize */
75 (GClassInitFunc) modest_mail_operation_queue_class_init,
76 NULL, /* class finalize */
77 NULL, /* class data */
78 sizeof(ModestMailOperationQueue),
80 (GInstanceInitFunc) modest_mail_operation_queue_init,
84 my_type = g_type_register_static (G_TYPE_OBJECT,
85 "ModestMailOperationQueue",
92 modest_mail_operation_queue_class_init (ModestMailOperationQueueClass *klass)
94 GObjectClass *gobject_class;
96 gobject_class = (GObjectClass*) klass;
97 parent_class = g_type_class_peek_parent (klass);
99 gobject_class->finalize = modest_mail_operation_queue_finalize;
101 g_type_class_add_private (gobject_class, sizeof(ModestMailOperationQueuePrivate));
104 * ModestMailOperationQueue::queue-changed
105 * @self: the #ModestMailOperationQueue that emits the signal
106 * @mail_op: the #ModestMailOperation affected
107 * @type: the type of change in the queue
108 * @user_data: user data set when the signal handler was connected
110 * Emitted whenever the contents of the queue change
112 signals[QUEUE_CHANGED_SIGNAL] =
113 g_signal_new ("queue-changed",
114 G_TYPE_FROM_CLASS (gobject_class),
116 G_STRUCT_OFFSET (ModestMailOperationQueueClass, queue_changed),
118 modest_marshal_VOID__POINTER_INT,
119 G_TYPE_NONE, 2, G_TYPE_POINTER, G_TYPE_INT);
123 modest_mail_operation_queue_init (ModestMailOperationQueue *obj)
125 ModestMailOperationQueuePrivate *priv;
127 priv = MODEST_MAIL_OPERATION_QUEUE_GET_PRIVATE(obj);
129 priv->op_queue = g_queue_new ();
130 priv->queue_lock = g_mutex_new ();
135 modest_mail_operation_queue_finalize (GObject *obj)
137 ModestMailOperationQueuePrivate *priv;
139 priv = MODEST_MAIL_OPERATION_QUEUE_GET_PRIVATE(obj);
141 g_mutex_lock (priv->queue_lock);
143 if (priv->op_queue) {
145 if (!g_queue_is_empty (priv->op_queue))
146 modest_mail_operation_queue_cancel_all (MODEST_MAIL_OPERATION_QUEUE (obj));
147 g_queue_free (priv->op_queue);
150 g_mutex_unlock (priv->queue_lock);
151 g_mutex_free (priv->queue_lock);
153 G_OBJECT_CLASS(parent_class)->finalize (obj);
156 ModestMailOperationQueue *
157 modest_mail_operation_queue_new (void)
159 ModestMailOperationQueue *self = g_object_new (MODEST_TYPE_MAIL_OPERATION_QUEUE, NULL);
161 return MODEST_MAIL_OPERATION_QUEUE (self);
165 modest_mail_operation_queue_add (ModestMailOperationQueue *self,
166 ModestMailOperation *mail_op)
168 ModestMailOperationQueuePrivate *priv;
170 g_return_if_fail (MODEST_IS_MAIL_OPERATION_QUEUE (self));
171 g_return_if_fail (MODEST_IS_MAIL_OPERATION (mail_op));
173 priv = MODEST_MAIL_OPERATION_QUEUE_GET_PRIVATE(self);
175 g_mutex_lock (priv->queue_lock);
176 g_queue_push_tail (priv->op_queue, g_object_ref (mail_op));
177 modest_mail_operation_set_id (mail_op, priv->op_id++);
178 g_mutex_unlock (priv->queue_lock);
180 /* Notify observers */
181 g_signal_emit (self, signals[QUEUE_CHANGED_SIGNAL], 0,
182 mail_op, MODEST_MAIL_OPERATION_QUEUE_OPERATION_ADDED);
186 modest_mail_operation_queue_remove (ModestMailOperationQueue *self,
187 ModestMailOperation *mail_op)
189 ModestMailOperationQueuePrivate *priv;
190 ModestMailOperationStatus status;
192 g_return_if_fail (MODEST_IS_MAIL_OPERATION_QUEUE (self));
193 g_return_if_fail (MODEST_IS_MAIL_OPERATION (mail_op));
195 priv = MODEST_MAIL_OPERATION_QUEUE_GET_PRIVATE(self);
197 g_mutex_lock (priv->queue_lock);
198 g_queue_remove (priv->op_queue, mail_op);
199 g_mutex_unlock (priv->queue_lock);
201 /* Notify observers */
202 g_signal_emit (self, signals[QUEUE_CHANGED_SIGNAL], 0,
203 mail_op, MODEST_MAIL_OPERATION_QUEUE_OPERATION_REMOVED);
206 status = modest_mail_operation_get_status (mail_op);
207 if (status != MODEST_MAIL_OPERATION_STATUS_SUCCESS)
208 modest_mail_operation_execute_error_handler (mail_op);
211 modest_runtime_verify_object_last_ref (mail_op, "");
212 g_object_unref (G_OBJECT (mail_op));
216 modest_mail_operation_queue_num_elements (ModestMailOperationQueue *self)
218 ModestMailOperationQueuePrivate *priv;
221 g_return_val_if_fail (MODEST_IS_MAIL_OPERATION_QUEUE (self), 0);
223 priv = MODEST_MAIL_OPERATION_QUEUE_GET_PRIVATE(self);
225 g_mutex_lock (priv->queue_lock);
226 length = g_queue_get_length (priv->op_queue);
227 g_mutex_unlock (priv->queue_lock);
233 /* Utility function intended to be used with g_queue_foreach */
235 modest_mail_operation_queue_cancel_no_block_wrapper (ModestMailOperation *self,
236 ModestMailOperationQueue *op_queue)
238 modest_mail_operation_queue_cancel_no_block (op_queue, self);
242 modest_mail_operation_queue_cancel_no_block (ModestMailOperationQueue *self,
243 ModestMailOperation *mail_op)
245 if (modest_mail_operation_is_finished (mail_op))
248 /* TODO: the implementation is still empty */
249 modest_mail_operation_cancel (mail_op);
251 /* Remove from the queue */
252 modest_mail_operation_queue_remove (self, mail_op);
256 modest_mail_operation_queue_cancel (ModestMailOperationQueue *self,
257 ModestMailOperation *mail_op)
259 ModestMailOperationQueuePrivate *priv;
261 g_return_if_fail (MODEST_IS_MAIL_OPERATION_QUEUE (self));
262 g_return_if_fail (MODEST_IS_MAIL_OPERATION (mail_op));
264 priv = MODEST_MAIL_OPERATION_QUEUE_GET_PRIVATE(self);
266 g_mutex_lock (priv->queue_lock);
267 modest_mail_operation_queue_cancel_no_block (self, mail_op);
268 g_mutex_unlock (priv->queue_lock);
272 modest_mail_operation_queue_cancel_all (ModestMailOperationQueue *self)
274 ModestMailOperationQueuePrivate *priv;
276 g_return_if_fail (MODEST_IS_MAIL_OPERATION_QUEUE (self));
278 priv = MODEST_MAIL_OPERATION_QUEUE_GET_PRIVATE(self);
280 g_mutex_lock (priv->queue_lock);
281 g_queue_foreach (priv->op_queue,
282 (GFunc) modest_mail_operation_queue_cancel_no_block_wrapper,
284 g_mutex_unlock (priv->queue_lock);