2 This file is part of GNUnet
3 (C) 2008--2012 Christian Grothoff (and other contributing authors)
5 GNUnet is free software; you can redistribute it and/or modify
6 it under the terms of the GNU General Public License as published
7 by the Free Software Foundation; either version 3, or (at your
8 option) any later version.
10 GNUnet is distributed in the hope that it will be useful, but
11 WITHOUT ANY WARRANTY; without even the implied warranty of
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 General Public License for more details.
15 You should have received a copy of the GNU General Public License
16 along with GNUnet; see the file COPYING. If not, write to the
17 Free Software Foundation, Inc., 59 Temple Place - Suite 330,
18 Boston, MA 02111-1307, USA.
22 * @file testbed/testbed_api_operations.h
23 * @brief internal API to access the 'operations' subsystem
24 * @author Christian Grothoff
26 #ifndef NEW_TESTING_API_OPERATIONS_H
27 #define NEW_TESTING_API_OPERATIONS_H
29 #include "gnunet_testbed_service.h"
30 #include "gnunet_helper_lib.h"
34 * Queue of operations where we can only support a certain
35 * number of concurrent operations of a particular type.
37 struct OperationQueue;
41 * Create an operation queue.
43 * @param max_active maximum number of operations in this
44 * queue that can be active in parallel at the same time
45 * @return handle to the queue
47 struct OperationQueue *
48 GNUNET_TESTBED_operation_queue_create_ (unsigned int max_active);
52 * Destroy an operation queue. The queue MUST be empty
55 * @param queue queue to destroy
58 GNUNET_TESTBED_operation_queue_destroy_ (struct OperationQueue *queue);
62 * Function to reset the maximum number of operations in the given queue. If
63 * max_active is lesser than the number of currently active operations, the
64 * active operations are not stopped immediately.
66 * @param queue the operation queue which has to be modified
67 * @param max_active the new maximum number of active operations
70 GNUNET_TESTBED_operation_queue_reset_max_active_ (struct OperationQueue *queue,
71 unsigned int max_active);
75 * Add an operation to a queue. An operation can be in multiple queues at
76 * once. Once the operation is inserted into all the queues
77 * GNUNET_TESTBED_operation_begin_wait_() has to be called to actually start
78 * waiting for the operation to become active.
80 * @param queue queue to add the operation to
81 * @param operation operation to add to the queue
82 * @param nres the number of units of the resources of queue needed by the
83 * operation. Should be greater than 0.
86 GNUNET_TESTBED_operation_queue_insert2_ (struct OperationQueue *queue,
87 struct GNUNET_TESTBED_Operation
88 *operation, unsigned int nres);
92 * Add an operation to a queue. An operation can be in multiple queues at
93 * once. Once the operation is inserted into all the queues
94 * GNUNET_TESTBED_operation_begin_wait_() has to be called to actually start
95 * waiting for the operation to become active.
97 * @param queue queue to add the operation to
98 * @param operation operation to add to the queue
101 GNUNET_TESTBED_operation_queue_insert_ (struct OperationQueue *queue,
102 struct GNUNET_TESTBED_Operation
107 * Marks the given operation as waiting on the queues. Once all queues permit
108 * the operation to become active, the operation will be activated. The actual
109 * activation will occur in a separate task (thus allowing multiple queue
110 * insertions to be made without having the first one instantly trigger the
111 * operation if the first queue has sufficient resources).
113 * @param operation the operation to marks as waiting
116 GNUNET_TESTBED_operation_begin_wait_ (struct GNUNET_TESTBED_Operation
121 * Remove an operation from a queue. This can be because the
122 * oeration was active and has completed (and the resources have
123 * been released), or because the operation was cancelled and
124 * thus scheduling the operation is no longer required.
126 * @param queue queue to add the operation to
127 * @param operation operation to add to the queue
130 GNUNET_TESTBED_operation_queue_remove_ (struct OperationQueue *queue,
131 struct GNUNET_TESTBED_Operation
137 * Function to call to start an operation once all
138 * queues the operation is part of declare that the
139 * operation can be activated.
141 * @param cls the closure from GNUNET_TESTBED_operation_create_()
143 typedef void (*OperationStart) (void *cls);
147 * Function to call to cancel an operation (release all associated
148 * resources). This can be because of a call to
149 * "GNUNET_TESTBED_operation_cancel" (before the operation generated
150 * an event) or AFTER the operation generated an event due to a call
151 * to "GNUNET_TESTBED_operation_done". Thus it is not guaranteed that
152 * a callback to the 'OperationStart' preceeds the call to
153 * 'OperationRelease'. Implementations of this function are expected
154 * to clean up whatever state is in 'cls' and release all resources
155 * associated with the operation.
157 * @param cls the closure from GNUNET_TESTBED_operation_create_()
159 typedef void (*OperationRelease) (void *cls);
163 * Create an 'operation' to be performed.
165 * @param cls closure for the callbacks
166 * @param start function to call to start the operation
167 * @param release function to call to close down the operation
168 * @return handle to the operation
170 struct GNUNET_TESTBED_Operation *
171 GNUNET_TESTBED_operation_create_ (void *cls, OperationStart start,
172 OperationRelease release);
176 * An operation is 'done' (was cancelled or finished); remove
177 * it from the queues and release associated resources.
179 * @param operation operation that finished
182 GNUNET_TESTBED_operation_release_ (struct GNUNET_TESTBED_Operation *operation);
186 /* end of testbed_api_operations.h */