-fix (C) notices
[oweals/gnunet.git] / src / core / gnunet-service-core.h
1 /*
2      This file is part of GNUnet.
3      Copyright (C) 2009, 2010, 2011 GNUnet e.V.
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., 51 Franklin Street, Fifth Floor,
18      Boston, MA 02110-1301, USA.
19 */
20
21 /**
22  * @file core/gnunet-service-core.h
23  * @brief Globals for gnunet-service-core
24  * @author Christian Grothoff
25  */
26 #ifndef GNUNET_SERVICE_CORE_H
27 #define GNUNET_SERVICE_CORE_H
28
29 #include "gnunet_statistics_service.h"
30 #include "gnunet_core_service.h"
31 #include "core.h"
32
33 /**
34  * Opaque handle to a client.
35  */
36 struct GSC_Client;
37
38
39 /**
40  * Record kept for each request for transmission issued by a
41  * client that is still pending. (This struct is used by
42  * both the 'CLIENTS' and 'SESSIONS' subsystems.)
43  */
44 struct GSC_ClientActiveRequest
45 {
46
47   /**
48    * Active requests are kept in a doubly-linked list of
49    * the respective target peer.
50    */
51   struct GSC_ClientActiveRequest *next;
52
53   /**
54    * Active requests are kept in a doubly-linked list of
55    * the respective target peer.
56    */
57   struct GSC_ClientActiveRequest *prev;
58
59   /**
60    * Handle to the client.
61    */
62   struct GSC_Client *client_handle;
63
64   /**
65    * Which peer is the message going to be for?
66    */
67   struct GNUNET_PeerIdentity target;
68
69   /**
70    * At what time did we first see this request?
71    */
72   struct GNUNET_TIME_Absolute received_time;
73
74   /**
75    * By what time would the client want to see this message out?
76    */
77   struct GNUNET_TIME_Absolute deadline;
78
79   /**
80    * How important is this request.
81    */
82   enum GNUNET_CORE_Priority priority;
83
84   /**
85    * Has this request been solicited yet?
86    */
87   int was_solicited;
88
89   /**
90    * How many bytes does the client intend to send?
91    */
92   uint16_t msize;
93
94   /**
95    * Unique request ID (in big endian).
96    */
97   uint16_t smr_id;
98
99 };
100
101
102 /**
103  * Our configuration.
104  */
105 extern const struct GNUNET_CONFIGURATION_Handle *GSC_cfg;
106
107 /**
108  * For creating statistics.
109  */
110 extern struct GNUNET_STATISTICS_Handle *GSC_stats;
111
112 /**
113  * Our identity.
114  */
115 extern struct GNUNET_PeerIdentity GSC_my_identity;
116
117
118 #endif