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 <glib-object.h>
32 #include <tny-send-queue.h>
33 #include <tny-camel-send-queue.h>
35 #include <tny-camel-transport-account.h>
37 #ifndef __MODEST_TNY_SEND_QUEUE_H__
38 #define __MODEST_TNY_SEND_QUEUE_H__
42 /* convenience macros */
43 #define MODEST_TYPE_TNY_SEND_QUEUE (modest_tny_send_queue_get_type())
44 #define MODEST_TNY_SEND_QUEUE(obj) (G_TYPE_CHECK_INSTANCE_CAST((obj),MODEST_TYPE_TNY_SEND_QUEUE,ModestTnySendQueue))
45 #define MODEST_TNY_SEND_QUEUE_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST((klass),MODEST_TYPE_TNY_SEND_QUEUE,TnySendQueue))
46 #define MODEST_IS_TNY_SEND_QUEUE(obj) (G_TYPE_CHECK_INSTANCE_TYPE((obj),MODEST_TYPE_TNY_SEND_QUEUE))
47 #define MODEST_IS_TNY_SEND_QUEUE_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE((klass),MODEST_TYPE_TNY_SEND_QUEUE))
48 #define MODEST_TNY_SEND_QUEUE_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS((obj),MODEST_TYPE_TNY_SEND_QUEUE,ModestTnySendQueueClass))
50 typedef struct _ModestTnySendQueue ModestTnySendQueue;
51 typedef struct _ModestTnySendQueueClass ModestTnySendQueueClass;
54 MODEST_TNY_SEND_QUEUE_UNKNOWN,
55 MODEST_TNY_SEND_QUEUE_WAITING,
56 MODEST_TNY_SEND_QUEUE_SUSPENDED,
57 MODEST_TNY_SEND_QUEUE_SENDING,
58 MODEST_TNY_SEND_QUEUE_FAILED
59 } ModestTnySendQueueStatus;
61 struct _ModestTnySendQueue {
62 TnyCamelSendQueue parent;
65 struct _ModestTnySendQueueClass {
66 TnyCamelSendQueueClass parent_class;
69 void (*status_changed)(ModestTnySendQueue *self, const gchar *msg_id, ModestTnySendQueueStatus status);
73 * modest_tny_send_queue_get_type:
75 * get the #GType for #ModestTnySendQueue
79 GType modest_tny_send_queue_get_type (void) G_GNUC_CONST;
83 * modest_tny_send_queue_new:
84 * @account: a valid camel transport account
86 * create a new modest #ModestTnySendQueue object.
88 * Returns: a new #ModestTnySendQueue instance, or NULL in case
91 ModestTnySendQueue* modest_tny_send_queue_new (TnyCamelTransportAccount *account);
95 * modest_tny_send_queue_sending_in_progress:
96 * @self: a valid #ModestTnySendQueue instance
98 * Checks if sending operation is currently in progress on @self send queue.
100 gboolean modest_tny_send_queue_sending_in_progress (ModestTnySendQueue* self);
103 * modest_tny_send_queue_msg_is_being_sent:
104 * @self: a valid #ModestTnySendQueue instance
105 * @msg_id: the message id ti check.
107 * Checks if message identifies with @msg_id is currently being sent.
109 gboolean modest_tny_send_queue_msg_is_being_sent (ModestTnySendQueue* self, const gchar *msg_id);
112 * modest_tny_send_queue_get_msg_status:
113 * @self: a valid #ModestTnySendQueue instance
114 * @msg_id: The message id to check
116 * Returns the status of the message identified with @msg_id. The status tells
117 * whether the message is currently being sent, is waiting for being sent or
118 * sending the message failed.
120 ModestTnySendQueueStatus
121 modest_tny_send_queue_get_msg_status (ModestTnySendQueue *self, const gchar *msg_id);
124 modest_tny_send_queue_get_msg_id (TnyHeader *header);
127 * modest_tny_all_send_queues_get_msg_status:
128 * @header: a #TnyHeader
130 * obtain status of message (searching for it in all queues)
132 * Returns: a #ModestTnySendQueueStatus
134 ModestTnySendQueueStatus
135 modest_tny_all_send_queues_get_msg_status (TnyHeader *header);
139 * modest_tny_send_queue_to_string:
140 * @self: a valid #ModestTnySendQueue instance
142 * get a string representation of a send queue (for debugging)
144 * Returns: a newly allocated string, or NULL in case of error
146 gchar* modest_tny_send_queue_to_string (ModestTnySendQueue *self);
149 * modest_tny_send_queue_wakeup:
150 * @self: a valid #ModestTnySendQueue instance
152 * Wakes up all suspended messages in the send queue. This means that
153 * the send queue will try to send them again. Note that you'd
154 * probably need a tny_send_queue_flush to force it
156 void modest_tny_send_queue_wakeup (ModestTnySendQueue *self);
159 * modest_tny_send_queue_get_requested_send_receive:
160 * @self: a #ModestTnySendQueue
162 * gets if the last request to send queue was an interactive send
165 * Returns: %TRUE if last request was an interactive send receive,
168 gboolean modest_tny_send_queue_get_requested_send_receive (ModestTnySendQueue *self);
171 * modest_tny_send_queue_set_requested_send_receive:
172 * @self: a #ModestTnySendQueue
173 * @requested_send_receive: mode.
175 * this should be called on each call to process the queue, to distinguish if the
176 * action was an interactive send receive.
178 void modest_tny_send_queue_set_requested_send_receive (ModestTnySendQueue *self, gboolean requested_send_receive);
183 #endif /* __MODEST_TNY_SEND_QUEUE_H__ */