1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
|
/*
This file is part of GNUnet.
Copyright (C) 2009, 2010, 2011 GNUnet e.V.
GNUnet is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published
by the Free Software Foundation; either version 3, or (at your
option) any later version.
GNUnet is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
General Public License for more details.
You should have received a copy of the GNU General Public License
along with GNUnet; see the file COPYING. If not, write to the
Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
Boston, MA 02110-1301, USA.
*/
/**
* @file core/gnunet-service-core.h
* @brief Globals for gnunet-service-core
* @author Christian Grothoff
*/
#ifndef GNUNET_SERVICE_CORE_H
#define GNUNET_SERVICE_CORE_H
#include "gnunet_statistics_service.h"
#include "gnunet_core_service.h"
#include "core.h"
#include "gnunet-service-core_typemap.h"
/**
* Opaque handle to a client.
*/
struct GSC_Client;
/**
* Record kept for each request for transmission issued by a
* client that is still pending. (This struct is used by
* both the 'CLIENTS' and 'SESSIONS' subsystems.)
*/
struct GSC_ClientActiveRequest
{
/**
* Active requests are kept in a doubly-linked list of
* the respective target peer.
*/
struct GSC_ClientActiveRequest *next;
/**
* Active requests are kept in a doubly-linked list of
* the respective target peer.
*/
struct GSC_ClientActiveRequest *prev;
/**
* Handle to the client.
*/
struct GSC_Client *client_handle;
/**
* Which peer is the message going to be for?
*/
struct GNUNET_PeerIdentity target;
/**
* At what time did we first see this request?
*/
struct GNUNET_TIME_Absolute received_time;
/**
* By what time would the client want to see this message out?
*/
struct GNUNET_TIME_Absolute deadline;
/**
* How important is this request.
*/
enum GNUNET_CORE_Priority priority;
/**
* Has this request been solicited yet?
*/
int was_solicited;
/**
* How many bytes does the client intend to send?
*/
uint16_t msize;
/**
* Unique request ID (in big endian).
*/
uint16_t smr_id;
};
/**
* Tell a client that we are ready to receive the message.
*
* @param car request that is now ready; the responsibility
* for the handle remains shared between CLIENTS
* and SESSIONS after this call.
*/
void
GSC_CLIENTS_solicit_request (struct GSC_ClientActiveRequest *car);
/**
* We will never be ready to transmit the given message in (disconnect
* or invalid request). Frees resources associated with @a car. We
* don't explicitly tell the client, he'll learn with the disconnect
* (or violated the protocol).
*
* @param car request that now permanently failed; the
* responsibility for the handle is now returned
* to CLIENTS (SESSIONS is done with it).
* @param drop_client #GNUNET_YES if the client violated the protocol
* and we should thus drop the connection
*/
void
GSC_CLIENTS_reject_request (struct GSC_ClientActiveRequest *car,
int drop_client);
/**
* Notify a particular client about a change to existing connection to
* one of our neighbours (check if the client is interested). Called
* from #GSC_SESSIONS_notify_client_about_sessions().
*
* @param client client to notify
* @param neighbour identity of the neighbour that changed status
* @param tmap_old previous type map for the neighbour, NULL for connect
* @param tmap_new updated type map for the neighbour, NULL for disconnect
*/
void
GSC_CLIENTS_notify_client_about_neighbour (struct GSC_Client *client,
const struct GNUNET_PeerIdentity *neighbour,
const struct GSC_TypeMap *tmap_old,
const struct GSC_TypeMap *tmap_new);
/**
* Deliver P2P message to interested clients. Caller must have checked
* that the sending peer actually lists the given message type as one
* of its types.
*
* @param sender peer who sent us the message
* @param msg the message
* @param msize number of bytes to transmit
* @param options options for checking which clients should
* receive the message
*/
void
GSC_CLIENTS_deliver_message (const struct GNUNET_PeerIdentity *sender,
const struct GNUNET_MessageHeader *msg,
uint16_t msize,
uint32_t options);
/**
* Notify all clients about a change to existing session.
* Called from SESSIONS whenever there is a change in sessions
* or types processed by the respective peer.
*
* @param neighbour identity of the neighbour that changed status
* @param tmap_old previous type map for the neighbour, NULL for connect
* @param tmap_new updated type map for the neighbour, NULL for disconnect
*/
void
GSC_CLIENTS_notify_clients_about_neighbour (const struct GNUNET_PeerIdentity *neighbour,
const struct GSC_TypeMap *tmap_old,
const struct GSC_TypeMap *tmap_new);
/**
* Our configuration.
*/
extern const struct GNUNET_CONFIGURATION_Handle *GSC_cfg;
/**
* For creating statistics.
*/
extern struct GNUNET_STATISTICS_Handle *GSC_stats;
/**
* Our identity.
*/
extern struct GNUNET_PeerIdentity GSC_my_identity;
#endif
|
