4d0a505ab7830b354d3b00c0c9c01003ea731643
[oweals/gnunet.git] / src / hostlist / hostlist-client.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 2, 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 hostlist/hostlist-client.h
23  * @brief hostlist support.  Downloads HELLOs via HTTP.
24  * @author Christian Grothoff
25  */
26
27 #ifndef HOSTLIST_CLIENT_H
28 #define HOSTLIST_CLIENT_H
29
30 #include "gnunet_core_service.h"
31 #include "gnunet_statistics_service.h"
32 #include "gnunet_util_lib.h"
33 #include "gnunet_time_lib.h"
34
35 #define MAX_NUMBER_HOSTLISTS 30
36 #define MAX_HELLO_PER_HOSTLISTS 0
37 #define SAVING_INTERVALL GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_MINUTES, 30)
38 #define TESTING_INTERVALL GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, 3)
39
40 /*
41  * Defines concerning the hostlist quality metric
42  */
43
44 #define HOSTLIST_INITIAL 10000
45 #define HOSTLIST_FAILED_DOWNLOAD 100
46 #define HOSTLIST_SUCCESSFUL_DOWNLOAD 100
47 #define HOSTLIST_SUCCESSFUL_HELLO 1
48
49
50
51 /**
52  * Start downloading hostlists from hostlist servers as necessary.
53  *
54  * @param c the configuration to use
55  * @param s the scheduler to use
56  * @param st hande for publishing statistics
57  * @param ch set to handler for connect notifications
58  * @param dh set to handler for disconnect notifications
59  * @param msgh set to handler for message handler notifications
60  * @param learn set if client is learning new hostlists
61  * @return GNUNET_OK on success
62  */
63 int
64 GNUNET_HOSTLIST_client_start (const struct GNUNET_CONFIGURATION_Handle *c,
65                               struct GNUNET_SCHEDULER_Handle *s,
66                               struct GNUNET_STATISTICS_Handle *st,
67                               GNUNET_CORE_ConnectEventHandler *ch,
68                               GNUNET_CORE_DisconnectEventHandler *dh,
69                               GNUNET_CORE_MessageCallback *msgh,
70                               int learn);
71
72
73 /**
74  * Stop downloading hostlists from hostlist servers as necessary.
75  */
76 void
77 GNUNET_HOSTLIST_client_stop (void);
78
79
80 #endif
81 /* end of hostlist-client.h */