aboutsummaryrefslogtreecommitdiffstats
path: root/camel/camel-op-queue.c
blob: 100a3df89e860cc72b860ad1ee315daa7b1ef8cd (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
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
/* -*- Mode: C; tab-width: 8; indent-tabs-mode: t; c-basic-offset: 8 -*- */

/* 
 * Copyright (C) 1999 Bertrand Guiheneuf <Bertrand.Guiheneuf@aful.org> .
 *
 * This program is free software; you can redistribute it and/or 
 * modify it under the terms of the GNU General Public License as 
 * published by the Free Software Foundation; either version 2 of the
 * License, or (at your option) any later version.
 *
 * 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
 */


/* MT safe */


#include "camel-op-queue.h"

#define NB_OP_CHUNKS 20
static GMemChunk *op_chunk=NULL;

static GStaticMutex op_queue_mutex = G_STATIC_MUTEX_INIT;



/**
 * camel_op_queue_new: create a new operation queue
 * 
 * Create a new operation queue. 
 *
 * Return value: the newly allcated object
 **/
CamelOpQueue *
camel_op_queue_new ()
{
    CamelOpQueue *op_queue;

    g_static_mutex_lock (&op_queue_mutex);
    if (!op_chunk)
        op_chunk = g_mem_chunk_create (CamelOp, 
                           NB_OP_CHUNKS,
                           G_ALLOC_AND_FREE);
    g_static_mutex_unlock (&op_queue_mutex);

    op_queue = g_new (CamelOpQueue, 1);
    op_queue->ops_tail = NULL;
    op_queue->ops_head = NULL;
    
}


/**
 * camel_op_queue_push_op: Add an operation to the queue
 * @queue: queue object
 * @op: operation to add
 * 
 * Add an operation to an operation queue. 
 * The queue is a FIFO queue. 
 **/
void
camel_op_queue_push_op (CamelOpQueue *queue, CamelOp *op)
{
    GList *new_op;

    g_assert (queue);
    g_static_mutex_lock (&op_queue_mutex);
    if (!queue->ops_tail) {
        queue->ops_head = g_list_prepend (NULL, op);
        queue->ops_tail = queue->ops_head;
    } else 
        queue->ops_head = g_list_prepend (queue->ops_head, op); 
    g_static_mutex_unlock (&op_queue_mutex);
}


/**
 * camel_op_queue_pop_op: Pop the next operation pending in the queue
 * @queue: queue object
 * 
 * Pop the next operation pending in the queue.
 * 
 * Return value: 
 **/
CamelOp *
camel_op_queue_pop_op (CamelOpQueue *queue)
{
    GList *op_list;
    CamelOp *op;

    g_assert (queue);

    g_static_mutex_lock (&op_queue_mutex);
    op_list = queue->ops_tail;
    queue->ops_tail = queue->ops_tail->prev;
    op = (CamelOp *)op_list->data;
    g_static_mutex_unlock (&op_queue_mutex);

    return op;
}


/**
 * camel_op_queue_run_next_op: run the next pending operation
 * @queue: queue object
 * 
 * Run the next pending operation in the queue.
 * 
 * Return value: TRUE if an operation was launched FALSE if there was no operation pending in the queue.
 **/
gboolean
camel_op_queue_run_next_op (CamelOpQueue *queue)
{
    CamelOp *op;

    op = camel_op_queue_pop_op (queue);
    if (!op) return FALSE;

    

    return FALSE;
}

/**
 * camel_op_queue_set_service_availability: set the service availability for an operation queue
 * @queue: queue object
 * @available: availability flag
 * 
 * set the service availability
 **/
void
camel_op_queue_set_service_availability (CamelOpQueue *queue, gboolean available)
{
    g_static_mutex_lock (&op_queue_mutex);
    queue->service_available = available;
    g_static_mutex_unlock (&op_queue_mutex);
}

/**
 * camel_op_queue_get_service_availability: determine if an operation queue service is available 
 * @queue: queue object
 * 
 * Determine if the service associated to an operation queue is available.
 * 
 * Return value: service availability.
 **/
gboolean
camel_op_queue_get_service_availability (CamelOpQueue *queue)
{
    gboolean available;
    g_static_mutex_lock (&op_queue_mutex);
    available = queue->service_available;
    g_static_mutex_unlock (&op_queue_mutex);
    return available;
}

/**
 * camel_op_new: return a new CamelOp object 
 * 
 * The obtained object must be destroyed with 
 * camel_op_free ()
 * 
 * Return value: the newly allocated CamelOp object
 **/
CamelOp *
camel_op_new (CamelFuncDef *func_def)
{
    CamelOp *op;

    op = g_chunk_new (CamelOp, op_chunk);
    op->func_def = func_def;
    op->params = g_new (GtkArg, func_def->n_params);
    
    return op;  
}

/**
 * camel_op_free: free a CamelOp object allocated with camel_op_new
 * @op: CamelOp object to free
 * 
 * Free a CamelOp object allocated with camel_op_new ()
 * this routine won't work with CamelOp objects allocated 
 * with other allocators.
 **/
void 
camel_op_free (CamelOp *op)
{
    g_free (op->params);
    g_chunk_free (op, op_chunk);
}


/**
 * camel_op_run: run an operation 
 * @op: the opertaion object
 * 
 * run an operation 
 * 
 * Return value: 
 **/
gboolean
camel_op_run (CamelOp *op)
{
    GtkArg  *params;
    gboolean error;
    
    g_assert (op);
    g_assert (op->func_def);
    g_assert (op->params);

    return  (op->func_def->marshal (op->func_def->func, op->params));
}