2 This file is part of GNUnet
3 Copyright (C) 2008--2013 GNUnet e.V.
5 GNUnet is free software: you can redistribute it and/or modify it
6 under the terms of the GNU Affero General Public License as published
7 by the Free Software Foundation, either version 3 of the License,
8 or (at your 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 Affero General Public License for more details.
15 You should have received a copy of the GNU Affero General Public License
16 along with this program. If not, see <http://www.gnu.org/licenses/>.
20 * @file testbed/testbed_api_services.c
21 * @brief convenience functions for accessing services
22 * @author Christian Grothoff
25 #include "testbed_api.h"
26 #include "testbed_api_peers.h"
27 #include "testbed_api_operations.h"
31 * States for Service connect operations
41 * The configuration request has been sent
46 * connected to service
53 * Data accessed during service connections
55 struct ServiceConnectData
58 * helper function callback to establish the connection
60 GNUNET_TESTBED_ConnectAdapter ca;
63 * helper function callback to close the connection
65 GNUNET_TESTBED_DisconnectAdapter da;
68 * Closure to the above callbacks
78 * Closure for operation event
83 * The operation which created this structure
85 struct GNUNET_TESTBED_Operation *operation;
88 * The operation context from GNUNET_TESTBED_forward_operation_msg_()
90 struct OperationContext *opc;
95 struct GNUNET_TESTBED_Peer *peer;
98 * The acquired configuration of the peer
100 struct GNUNET_CONFIGURATION_Handle *cfg;
103 * The op_result pointer from ConnectAdapter
108 * The operation completion callback
110 GNUNET_TESTBED_ServiceConnectCompletionCallback cb;
113 * The closure for operation completion callback
126 * Type of a function to call when we receive a message
129 * @param cls ServiceConnectData
130 * @param msg message received, NULL on timeout or fatal error
133 configuration_receiver (void *cls, const struct GNUNET_MessageHeader *msg)
135 struct ServiceConnectData *data = cls;
136 struct GNUNET_TESTBED_Controller *c;
138 struct GNUNET_TESTBED_EventInformation info;
141 c = data->peer->controller;
142 mtype = ntohs (msg->type);
144 info.type = GNUNET_TESTBED_ET_OPERATION_FINISHED;
145 info.op = data->operation;
146 info.op_cls = data->op_cls;
147 if (GNUNET_MESSAGE_TYPE_TESTBED_OPERATION_FAIL_EVENT == mtype)
150 GNUNET_TESTBED_parse_error_string_ ((const struct
151 GNUNET_TESTBED_OperationFailureEventMessage
154 emsg = "Unknown error";
155 info.details.operation_finished.emsg = emsg;
156 info.details.operation_finished.generic = NULL;
159 data->cfg = GNUNET_TESTBED_extract_config_ (msg);
160 GNUNET_assert (NULL == data->op_result);
161 data->op_result = data->ca (data->cada_cls, data->cfg);
162 info.details.operation_finished.emsg = NULL;
163 info.details.operation_finished.generic = data->op_result;
164 data->state = SERVICE_CONNECTED;
167 if ((0 != (GNUNET_TESTBED_ET_OPERATION_FINISHED & c->event_mask)) &&
169 c->cc (c->cc_cls, &info);
170 if (NULL != data->cb)
171 data->cb (data->cb_cls, data->operation, data->op_result, emsg);
176 * Function called when a service connect operation is ready
178 * @param cls the closure from GNUNET_TESTBED_operation_create_()
181 opstart_service_connect (void *cls)
183 struct ServiceConnectData *data = cls;
184 struct GNUNET_TESTBED_PeerGetConfigurationMessage *msg;
185 struct GNUNET_TESTBED_Controller *c;
188 GNUNET_assert (NULL != data);
189 GNUNET_assert (NULL != data->peer);
190 c = data->peer->controller;
191 op_id = GNUNET_TESTBED_get_next_op_id (c);
193 GNUNET_TESTBED_generate_peergetconfig_msg_ (data->peer->unique_id, op_id);
195 GNUNET_TESTBED_forward_operation_msg_ (c, op_id, &msg->header,
196 &configuration_receiver, data);
198 data->state = CFG_REQUEST_QUEUED;
203 * Callback which will be called when service connect type operation is
206 * @param cls the closure from GNUNET_TESTBED_operation_create_()
209 oprelease_service_connect (void *cls)
211 struct ServiceConnectData *data = cls;
217 case CFG_REQUEST_QUEUED:
218 GNUNET_assert (NULL != data->opc);
219 GNUNET_TESTBED_forward_operation_msg_cancel_ (data->opc);
221 case SERVICE_CONNECTED:
222 GNUNET_assert (NULL != data->cfg);
223 GNUNET_CONFIGURATION_destroy (data->cfg);
224 if (NULL != data->da)
225 data->da (data->cada_cls, data->op_result);
233 * Connect to a service offered by the given peer. Will ensure that
234 * the request is queued to not overwhelm our ability to create and
235 * maintain connections with other systems. The actual service
236 * handle is then returned via the 'op_result' member in the event
237 * callback. The 'ca' callback is used to create the connection
238 * when the time is right; the 'da' callback will be used to
239 * destroy the connection (upon 'GNUNET_TESTBED_operation_done').
240 * 'GNUNET_TESTBED_operation_done' can be used to abort this
241 * operation until the event callback has been called.
243 * @param op_cls closure to pass in operation event
244 * @param peer peer that runs the service
245 * @param service_name name of the service to connect to
246 * @param cb the callback to call when this operation finishes
247 * @param cb_cls closure for the above callback
248 * @param ca helper function to establish the connection
249 * @param da helper function to close the connection
250 * @param cada_cls closure for ca and da
251 * @return handle for the operation
253 struct GNUNET_TESTBED_Operation *
254 GNUNET_TESTBED_service_connect (void *op_cls, struct GNUNET_TESTBED_Peer *peer,
255 const char *service_name,
256 GNUNET_TESTBED_ServiceConnectCompletionCallback
258 GNUNET_TESTBED_ConnectAdapter ca,
259 GNUNET_TESTBED_DisconnectAdapter da,
262 struct ServiceConnectData *data;
264 data = GNUNET_new (struct ServiceConnectData);
267 data->cada_cls = cada_cls;
268 data->op_cls = op_cls;
272 data->cb_cls = cb_cls;
274 GNUNET_TESTBED_operation_create_ (data, &opstart_service_connect,
275 &oprelease_service_connect);
276 GNUNET_TESTBED_operation_queue_insert_ (peer->
277 controller->opq_parallel_service_connections,
279 GNUNET_TESTBED_operation_queue_insert_ (peer->
280 controller->opq_parallel_operations,
282 GNUNET_TESTBED_operation_begin_wait_ (data->operation);
283 return data->operation;
286 /* end of testbed_api_services.c */