2 This file is part of GNUnet.
3 (C) 2009 Christian Grothoff (and other contributing authors)
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.
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.
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.
22 * @file include/gnunet_core_service.h
23 * @brief core service; this is the main API for encrypted P2P
25 * @author Christian Grothoff
28 #ifndef GNUNET_CORE_SERVICE_H
29 #define GNUNET_CORE_SERVICE_H
34 #if 0 /* keep Emacsens' auto-indent happy */
39 #include "gnunet_util_lib.h"
42 * Version number of GNUnet-core API.
44 #define GNUNET_CORE_VERSION 0x00000000
48 * Opaque handle to the service.
50 struct GNUNET_CORE_Handle;
54 * Method called whenever a given peer either connects or
55 * disconnects (or list of connections was requested).
58 * @param peer peer identity this notification is about
60 typedef void (*GNUNET_CORE_ClientEventHandler) (void *cls,
62 GNUNET_PeerIdentity * peer);
66 * Type of a send callback to fill up buffers.
68 * @param receiver the receiver of the message
69 * @param position is the reference to the
70 * first unused position in the buffer where GNUnet is building
72 * @param padding is the number of bytes left in that buffer.
73 * @return the number of bytes written to
74 * that buffer (must be a positive number).
77 (*GNUNET_CORE_BufferFillCallback) (void *cls,
78 const struct GNUNET_PeerIdentity *
80 void *position, unsigned int padding);
84 * Functions with this signature are called whenever a message is
85 * received or transmitted.
88 * @param peer the other peer involved (sender or receiver, NULL
89 * for loopback messages where we are both sender and receiver)
90 * @param message the actual message
91 * @return GNUNET_OK to keep the connection open,
92 * GNUNET_SYSERR to close it (signal serious error)
95 (*GNUNET_CORE_MessageCallback) (void *cls,
96 const struct GNUNET_PeerIdentity * other,
97 const struct GNUNET_MessageHeader *
102 * Message handler. Each struct specifies how to handle on particular
103 * type of message received.
105 struct GNUNET_CORE_MessageHandler
108 * Function to call for messages of "type".
110 GNUNET_CORE_MessageCallback callback;
113 * Type of the message this handler covers.
118 * Expected size of messages of this type. Use 0 for variable-size.
119 * If non-zero, messages of the given type will be discarded if they
120 * do not have the right size.
122 uint16_t expected_size;
128 * Function called after GNUNET_CORE_connect has succeeded
129 * (or failed for good). Note that the private key of the
130 * peer is intentionally not exposed here; if you need it,
131 * your process should try to read the private key file
132 * directly (which should work if you are authorized...).
135 * @param server handle to the server, NULL if we failed
136 * @param my_identity ID of this peer, NULL if we failed
137 * @param publicKey public key of this peer, NULL if we failed
140 (*GNUNET_CORE_StartupCallback) (void *cls,
141 struct GNUNET_CORE_Handle * server,
142 const struct GNUNET_PeerIdentity *
145 GNUNET_CRYPTO_RsaPublicKeyBinaryEncoded *
150 * Connect to the core service. Note that the connection may
151 * complete (or fail) asynchronously.
153 * @param sched scheduler to use
154 * @param cfg configuration to use
155 * @param timeout after how long should we give up trying to connect to the core service?
156 * @param cls closure for the various callbacks that follow (including handlers in the handlers array)
157 * @param init callback to call on timeout or once we have successfully
158 * connected to the core service
159 * @param connects function to call on peer connect, can be NULL
160 * @param disconnects function to call on peer disconnect / timeout, can be NULL
161 * @param bfc function to call to fill up spare bandwidth, can be NULL
162 * @param inbound_notify function to call for all inbound messages, can be NULL
163 * @param inbound_hdr_only set to GNUNET_YES if inbound_notify will only read the
164 * GNUNET_MessageHeader and hence we do not need to give it the full message;
165 * can be used to improve efficiency, ignored if inbound_notify is NULLL
166 * @param outbound_notify function to call for all outbound messages, can be NULL
167 * @param outbound_hdr_only set to GNUNET_YES if outbound_notify will only read the
168 * GNUNET_MessageHeader and hence we do not need to give it the full message
169 * can be used to improve efficiency, ignored if outbound_notify is NULLL
170 * @param handlers callbacks for messages we care about, NULL-terminated
173 GNUNET_CORE_connect (struct GNUNET_SCHEDULER_Handle *sched,
174 const struct GNUNET_CONFIGURATION_Handle *cfg,
175 struct GNUNET_TIME_Relative timeout,
177 GNUNET_CORE_StartupCallback init,
178 GNUNET_CORE_ClientEventHandler connects,
179 GNUNET_CORE_ClientEventHandler disconnects,
180 GNUNET_CORE_BufferFillCallback bfc,
181 GNUNET_CORE_MessageCallback inbound_notify,
182 int inbound_hdr_only,
183 GNUNET_CORE_MessageCallback outbound_notify,
184 int outbound_hdr_only,
185 const struct GNUNET_CORE_MessageHandler *handlers);
189 * Disconnect from the core service.
191 * @param handle connection to core to disconnect
193 void GNUNET_CORE_disconnect (struct GNUNET_CORE_Handle *handle);
197 * Function called with statistics about the given peer.
199 * @param peer identifies the peer
200 * @param latency current latency estimate, "FOREVER" if we have been
202 * @param bpm_in set to the current bandwidth limit (receiving) for this peer
203 * @param bpm_out set to the current bandwidth limit (sending) for this peer
204 * @param amount set to the amount that was actually reserved or unreserved
205 * @param preference current traffic preference for the given peer
208 (*GNUNET_CORE_PeerConfigurationInfoCallback) (void *cls,
210 GNUNET_PeerIdentity * peer,
212 unsigned int bpm_out,
213 struct GNUNET_TIME_Relative
215 unsigned long long preference);
219 * Obtain statistics and/or change preferences for the given peer.
221 * @param handle connection to core to use
222 * @param peer identifies the peer
223 * @param timeout after how long should we give up (and call "info" with NULL
224 * for "peer" to signal an error)?
225 * @param bpm_out set to the current bandwidth limit (sending) for this peer,
226 * caller should set "bpm_out" to "-1" to avoid changing
227 * the current value; otherwise "bpm_out" will be lowered to
228 * the specified value; passing a pointer to "0" can be used to force
229 * us to disconnect from the peer; "bpm_out" might not increase
230 * as specified since the upper bound is generally
231 * determined by the other peer!
232 * @param amount reserve N bytes for receiving, negative
233 * amounts can be used to undo a (recent) reservation;
234 * @param preference increase incoming traffic share preference by this amount;
235 * in the absence of "amount" reservations, we use this
236 * preference value to assign proportional bandwidth shares
237 * to all connected peers
238 * @param info function to call with the resulting configuration information
239 * @param info_cls closure for info
242 GNUNET_CORE_peer_configure (struct GNUNET_CORE_Handle *handle,
243 const struct GNUNET_PeerIdentity *peer,
244 struct GNUNET_TIME_Relative timeout,
245 unsigned int bpm_out,
247 unsigned long long preference,
248 GNUNET_CORE_PeerConfigurationInfoCallback info,
253 * Handle for a transmission request.
255 struct GNUNET_CORE_TransmitHandle;
259 * Ask the core to call "notify" once it is ready to transmit the
260 * given number of bytes to the specified "target". If we are not yet
261 * connected to the specified peer, a call to this function will cause
262 * us to try to establish a connection.
264 * @param handle connection to core service
265 * @param priority how important is the message?
266 * @param maxdelay how long can the message wait?
267 * @param target who should receive the message,
268 * use NULL for this peer (loopback)
269 * @param notify_size how many bytes of buffer space does notify want?
270 * @param notify function to call when buffer space is available
271 * @param notify_cls closure for notify
272 * @return non-NULL if the notify callback was queued,
273 * NULL if we can not even queue the request (insufficient
274 * memory); if NULL is returned, "notify" will NOT be called.
276 struct GNUNET_CORE_TransmitHandle *
277 GNUNET_CORE_notify_transmit_ready (struct
292 GNUNET_NETWORK_TransmitReadyNotify
299 * Cancel the specified transmission-ready notification.
301 * @param h handle that was returned by "notify_transmit_ready".
304 GNUNET_CORE_notify_transmit_ready_cancel (struct GNUNET_CORE_TransmitHandle
308 #if 0 /* keep Emacsens' auto-indent happy */
315 /* ifndef GNUNET_CORE_SERVICE_H */
317 /* end of gnunet_core_service.h */