git.maemo.org Git - modest/blob - src/modest-mail-operation-queue.h

   1 /* Copyright (c) 2006, Nokia Corporation
   2  * All rights reserved.
   3  *
   4  * Redistribution and use in source and binary forms, with or without
   5  * modification, are permitted provided that the following conditions are
   6  * met:
   7  *
   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.
  16  *
  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.
  28  */
  29
  30 /* modest-tny-platform-factory.h */
  31
  32 #ifndef __MODEST_MAIL_OPERATION_QUEUE_H__
  33 #define __MODEST_MAIL_OPERATION_QUEUE_H__
  34
  35 #include <glib-object.h>
  36 #include "modest-mail-operation.h"
  37
  38 G_BEGIN_DECLS
  39
  40 /* convenience macros */
  41 #define MODEST_TYPE_MAIL_OPERATION_QUEUE             (modest_mail_operation_queue_get_type())
  42 #define MODEST_MAIL_OPERATION_QUEUE(obj)             (G_TYPE_CHECK_INSTANCE_CAST((obj),MODEST_TYPE_MAIL_OPERATION_QUEUE,ModestMailOperationQueue))
  43 #define MODEST_MAIL_OPERATION_QUEUE_CLASS(klass)     (G_TYPE_CHECK_CLASS_CAST((klass),MODEST_TYPE_MAIL_OPERATION_QUEUE,GObject))
  44 #define MODEST_IS_MAIL_OPERATION_QUEUE(obj)          (G_TYPE_CHECK_INSTANCE_TYPE((obj),MODEST_TYPE_MAIL_OPERATION_QUEUE))
  45 #define MODEST_IS_MAIL_OPERATION_QUEUE_CLASS(klass)  (G_TYPE_CHECK_CLASS_TYPE((klass),MODEST_TYPE_MAIL_OPERATION_QUEUE))
  46 #define MODEST_MAIL_OPERATION_QUEUE_GET_CLASS(obj)   (G_TYPE_INSTANCE_GET_CLASS((obj),MODEST_TYPE_MAIL_OPERATION_QUEUE,ModestMailOperationQueueClass))
  47
  48 typedef enum _ModestMailOperationQueueNotification {
  49         MODEST_MAIL_OPERATION_QUEUE_OPERATION_ADDED,
  50         MODEST_MAIL_OPERATION_QUEUE_OPERATION_REMOVED
  51 } ModestMailOperationQueueNotification;
  52
  53 typedef struct _ModestMailOperationQueue      ModestMailOperationQueue;
  54 typedef struct _ModestMailOperationQueueClass ModestMailOperationQueueClass;
  55
  56 struct _ModestMailOperationQueue {
  57          GObject parent;
  58 };
  59
  60 struct _ModestMailOperationQueueClass {
  61         GObjectClass parent_class;
  62
  63         /* Signals */
  64         void (*queue_changed) (ModestMailOperationQueue *self,
  65                                ModestMailOperation *mail_op,
  66                                ModestMailOperationQueueNotification type);
  67
  68         void (*queue_empty) (ModestMailOperationQueue *self);
  69 };
  70
  71
  72 /* member functions */
  73 GType                   modest_mail_operation_queue_get_type      (void) G_GNUC_CONST;
  74
  75 ModestMailOperationQueue *    modest_mail_operation_queue_new  (void);
  76
  77 /**
  78  * modest_mail_operation_queue_add:
  79  * @op_queue: a #ModestMailOperationQueue
  80  * @mail_op: the #ModestMailOperation that will be added to the queue
  81  *
  82  * Adds a mail operation at the end of the queue. It also adds a
  83  * reference to the mail operation so the caller could free it
  84  **/
  85 void    modest_mail_operation_queue_add        (ModestMailOperationQueue *op_queue,
  86                                                 ModestMailOperation *mail_op);
  87
  88 /**
  89  * modest_mail_operation_queue_remove:
  90  * @op_queue: a #ModestMailOperationQueue
  91  * @mail_op: the #ModestMailOperation that will be removed from the queue
  92  *
  93  * Removes a mail operation from the queue. This method does not free
  94  * the mail operation
  95  **/
  96 void    modest_mail_operation_queue_remove     (ModestMailOperationQueue *op_queue,
  97                                                 ModestMailOperation *mail_op);
  98 /**
  99  * modest_mail_operation_queue_num_elements:
 100  * @op_queue:  a #ModestMailOperationQueue
 101  *
 102  * Gets the numeber of elements stored in #ModestMailOperationQueue.
 103  **/
 104 guint
 105 modest_mail_operation_queue_num_elements (ModestMailOperationQueue *self);
 106
 107 /**
 108  * modest_mail_operation_queue_cancel:
 109  * @op_queue:  a #ModestMailOperationQueue
 110  * @mail_op:  the #ModestMailOperation that will be canceled
 111  *
 112  * Cancels a #ModestMailOperation if it's not finished and removes it
 113  * from the queue
 114  **/
 115 void    modest_mail_operation_queue_cancel     (ModestMailOperationQueue *op_queue,
 116                                                 ModestMailOperation *mail_op);
 117 /**
 118  * modest_mail_operation_queue_cancel_all:
 119  * @op_queue:  a #ModestMailOperationQueue
 120  *
 121  * Cancels all the unfinished #ModestMailOperation of the queue
 122  **/
 123 void    modest_mail_operation_queue_cancel_all (ModestMailOperationQueue *op_queue);
 124
 125 /**
 126  * modest_mail_operation_queue_get_by_source:
 127  * @op_queue:  a #ModestMailOperationQueue
 128  * @source: the source of the operations
 129  *
 130  * Returns a list with the #ModestMailOperation that have the given
 131  * source. Each #ModestMailOperation is getting a new reference so you
 132  * MUST unref it when done
 133  **/
 134 GSList* modest_mail_operation_queue_get_by_source (ModestMailOperationQueue *op_queue, GObject *source);
 135
 136
 137 /**
 138  * modest_mail_operation_queue_queue_to_string:
 139  * @op_queue:  a #ModestMailOperationQueue
 140  *
 141  * Returns a string representation of the operation queue (for debugging)
 142  *
 143  * Returns: a newly allocated string, or NULL in case of error
 144  **/
 145 gchar* modest_mail_operation_queue_to_string (ModestMailOperationQueue *self);
 146
 147 /**
 148  * modest_mail_operation_queue_set_running_shutdown:
 149  * @self: a #ModestMailOperationQueue
 150  *
 151  * Mark the queue as running the final sync.
 152  *
 153  */
 154 void
 155 modest_mail_operation_queue_set_running_shutdown (ModestMailOperationQueue *self);
 156
 157 /**
 158  * modest_mail_operation_queue_running_shutdown:
 159  * @self: a #ModestMailOperationQueue
 160  *
 161  * Is the last operation queued a shutdown operation?
 162  *
 163  * Returns: a #gboolean, %TRUE if the last queued operation is
 164  * a shutdown, %FALSE otherwise
 165  */
 166 gboolean
 167 modest_mail_operation_queue_running_shutdown (ModestMailOperationQueue *self);
 168
 169 G_END_DECLS
 170
 171 #endif /* __MODEST_MAIL_OPERATION_QUEUE_H__ */