2 This file is part of GNUnet.
3 (C) 2009, 2010, 2011 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 3, 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 core/gnunet-service-core_neighbours.h
23 * @brief code for managing of 'encrypted' sessions (key exchange done)
24 * @author Christian Grothoff
26 #ifndef GNUNET_SERVICE_CORE_SESSIONS_H
27 #define GNUNET_SERVICE_CORE_SESSIONS_H
29 #include "gnunet_service_core_kx.h"
30 #include "gnunet_service_core_sessions.h"
34 * End the session with the given peer (we are no longer
37 * @param pid identity of peer to kill session with
40 GSC_SESSIONS_end (const struct GNUNET_PeerIdentity *pid);
44 * Traffic is being solicited for the given peer. This means that the
45 * message queue on the transport-level (NEIGHBOURS subsystem) is now
46 * empty and it is now OK to transmit another (non-control) message.
48 * @param pid identity of peer ready to receive data
51 GSC_SESSIONS_solicit (const struct GNUNET_PeerIdentity *pid);
55 * Queue a request from a client for transmission to a particular peer.
57 * @param car request to queue; this handle is then shared between
58 * the caller (CLIENTS subsystem) and SESSIONS and must not
59 * be released by either until either 'GNUNET_SESSIONS_dequeue',
60 * or 'GNUNET_CLIENTS_failed'
61 * have been invoked on it
64 GSC_SESSIONS_queue_request (struct GSC_ClientActiveRequest *car);
68 * Dequeue a request from a client from transmission to a particular peer.
70 * @param car request to dequeue; this handle will then be 'owned' by
71 * the caller (CLIENTS sysbsystem)
74 GSC_SESSIONS_dequeue_request (struct GSC_ClientActiveRequest *car);
78 * Transmit a message to a particular peer.
80 * @param car original request that was queued and then solicited,
81 * ownership does not change (dequeue will be called soon).
82 * @param msg message to transmit
85 GSC_SESSIONS_transmit (struct GSC_ClientActiveRequest *car,
86 const struct GNUNET_MessageHeader *msg);
90 * Broadcast a message to all neighbours.
92 * @param msg message to transmit
95 GSC_SESSIONS_broadcast (const struct GNUNET_MessageHeader *msg);
99 * We have a new client, notify it about all current sessions.
101 * @param client the new client
104 GSC_SESSIONS_notify_client_about_sessions (struct GSC_Client *client);
108 * Handle CORE_ITERATE_PEERS request. For this request type, the client
109 * does not have to have transmitted an INIT request. All current peers
110 * are returned, regardless of which message types they accept.
113 * @param client client sending the iteration request
114 * @param message iteration request message
117 GSC_SESSIONS_handle_client_iterate_peers (void *cls, struct GNUNET_SERVER_Client *client,
118 const struct GNUNET_MessageHeader *message);
122 * Handle CORE_PEER_CONNECTED request. Notify client about connection
123 * to the given neighbour. For this request type, the client does not
124 * have to have transmitted an INIT request. All current peers are
125 * returned, regardless of which message types they accept.
128 * @param client client sending the iteration request
129 * @param message iteration request message
132 GSC_SESSIONS_handle_client_have_peer (void *cls, struct GNUNET_SERVER_Client *client,
133 const struct GNUNET_MessageHeader *message);
137 * Handle REQUEST_INFO request. For this request type, the client must have
138 * transmitted an INIT first.
141 * @param client client sending the request
142 * @param message iteration request message
145 GSC_SESSIONS_handle_client_request_info (void *cls, struct GNUNET_SERVER_Client *client,
146 const struct GNUNET_MessageHeader *message);
150 * Create a session, a key exchange was just completed.
153 GSC_SESSIONS_create (const struct GNUNET_PeerIdentity *peer);
156 * Update information about a session.
158 * @param peer peer who's session should be updated
159 * @param bw_out new outbound bandwidth limit for the peer
160 * @param atsi performance information
161 * @param atsi_count number of performance records supplied
164 GSC_SESSIONS_update (const struct GNUNET_PeerIdentity *peer,
165 struct GNUNET_BANDWIDTH_Value32NBO bw_out,
166 const struct GNUNET_TRANSPORT_ATS_Information *atsi,
167 uint32_t atsi_count);
172 * Initialize sessions subsystem.
175 GSC_SESSIONS_init (void);
179 * Shutdown sessions subsystem.
182 GSC_SESSIONS_done (void);