documentation
[oweals/gnunet.git] / src / experimentation / gnunet-daemon-experimentation.h
1 /*
2      This file is part of GNUnet.
3      (C) 2009 Christian Grothoff (and other contributing authors)
4
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.
9
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.
14
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.
19 */
20
21 /**
22  * @file experimentation/gnunet-daemon-experimentation.h
23  * @brief experimentation daemon
24  * @author Christian Grothoff
25  * @author Matthias Wachs
26  */
27 #include "platform.h"
28 #include "gnunet_getopt_lib.h"
29 #include "gnunet_util_lib.h"
30 #include "gnunet_core_service.h"
31 #include "gnunet_statistics_service.h"
32
33
34 /**
35  * Timeout between request and expected response
36  */
37 #define EXP_RESPONSE_TIMEOUT GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, 10)
38
39
40 /**
41  * A experimentation node
42  */
43 struct Node
44 {
45         /**
46          * Peer id
47          */
48         struct GNUNET_PeerIdentity id;
49
50         /**
51          * Task for response timeout
52          */
53         GNUNET_SCHEDULER_TaskIdentifier timeout_task;
54
55         /**
56          * Core transmission handle
57          */
58         struct GNUNET_CORE_TransmitHandle *cth;
59 };
60
61 /**
62  * Experimentation request message
63  * Used to detect experimentation capability
64  */
65 struct Experimentation_Request
66 {
67         struct GNUNET_MessageHeader msg;
68 };
69
70 /**
71  * Experimentation response message
72  * Sent if peer is running the daemon
73  */
74 struct Experimentation_Response
75 {
76         struct GNUNET_MessageHeader msg;
77 };
78
79
80 /**
81  * Start the nodes management
82  *
83  * @param cfg configuration handle
84  */
85 void
86 GNUNET_EXPERIMENTATION_nodes_start (const struct GNUNET_CONFIGURATION_Handle *cfg);
87
88
89 /**
90  * Stop the nodes management
91  */
92 void
93 GNUNET_EXPERIMENTATION_nodes_stop ();
94
95 /* end of gnunet-daemon-experimentation.h */