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 * Add an operation to a queue. An operation can be in multiple queues at
63 * once. Once the operation is inserted into all the queues
64 * GNUNET_TESTBED_operation_begin_wait_() has to be called to actually start
65 * waiting for the operation to become active.
67 * @param queue queue to add the operation to
68 * @param operation operation to add to the queue
71 GNUNET_TESTBED_operation_queue_insert_ (struct OperationQueue *queue,
72 struct GNUNET_TESTBED_Operation
77 * Marks the given operation as waiting on the queues. Once all queues permit
78 * the operation to become active, the operation will be activated. The actual
79 * activation will occur in a separate task (thus allowing multiple queue
80 * insertions to be made without having the first one instantly trigger the
81 * operation if the first queue has sufficient resources).
83 * @param operation the operation to marks as waiting
86 GNUNET_TESTBED_operation_begin_wait_ (struct GNUNET_TESTBED_Operation
91 * Remove an operation from a queue. This can be because the
92 * oeration was active and has completed (and the resources have
93 * been released), or because the operation was cancelled and
94 * thus scheduling the operation is no longer required.
96 * @param queue queue to add the operation to
97 * @param operation operation to add to the queue
100 GNUNET_TESTBED_operation_queue_remove_ (struct OperationQueue *queue,
101 struct GNUNET_TESTBED_Operation
107 * Function to call to start an operation once all
108 * queues the operation is part of declare that the
109 * operation can be activated.
111 * @param cls the closure from GNUNET_TESTBED_operation_create_()
113 typedef void (*OperationStart) (void *cls);
117 * Function to call to cancel an operation (release all associated
118 * resources). This can be because of a call to
119 * "GNUNET_TESTBED_operation_cancel" (before the operation generated
120 * an event) or AFTER the operation generated an event due to a call
121 * to "GNUNET_TESTBED_operation_done". Thus it is not guaranteed that
122 * a callback to the 'OperationStart' preceeds the call to
123 * 'OperationRelease'. Implementations of this function are expected
124 * to clean up whatever state is in 'cls' and release all resources
125 * associated with the operation.
127 * @param cls the closure from GNUNET_TESTBED_operation_create_()
129 typedef void (*OperationRelease) (void *cls);
133 * Create an 'operation' to be performed.
135 * @param cls closure for the callbacks
136 * @param start function to call to start the operation
137 * @param release function to call to close down the operation
138 * @return handle to the operation
140 struct GNUNET_TESTBED_Operation *
141 GNUNET_TESTBED_operation_create_ (void *cls, OperationStart start,
142 OperationRelease release);
146 * An operation is 'done' (was cancelled or finished); remove
147 * it from the queues and release associated resources.
149 * @param operation operation that finished
152 GNUNET_TESTBED_operation_release_ (struct GNUNET_TESTBED_Operation *operation);
156 /* end of testbed_api_operations.h */