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.h"
30 #include "gnunet-service-core_kx.h"
34 * Create a session, a key exchange was just completed.
36 * @param peer peer that is now connected
37 * @param kx key exchange that completed
40 GSC_SESSIONS_create (const struct GNUNET_PeerIdentity *peer,
41 struct GSC_KeyExchangeInfo *kx);
45 * End the session with the given peer (we are no longer
48 * @param pid identity of peer to kill session with
51 GSC_SESSIONS_end (const struct GNUNET_PeerIdentity *pid);
55 * Traffic is being solicited for the given peer. This means that the
56 * message queue on the transport-level (NEIGHBOURS subsystem) is now
57 * empty and it is now OK to transmit another (non-control) message.
59 * @param pid identity of peer ready to receive data
62 GSC_SESSIONS_solicit (const struct GNUNET_PeerIdentity *pid);
66 * Queue a request from a client for transmission to a particular peer.
68 * @param car request to queue; this handle is then shared between
69 * the caller (CLIENTS subsystem) and SESSIONS and must not
70 * be released by either until either 'GNUNET_SESSIONS_dequeue',
71 * or 'GNUNET_CLIENTS_failed'
72 * have been invoked on it
75 GSC_SESSIONS_queue_request (struct GSC_ClientActiveRequest *car);
79 * Dequeue a request from a client from transmission to a particular peer.
81 * @param car request to dequeue; this handle will then be 'owned' by
82 * the caller (CLIENTS sysbsystem)
85 GSC_SESSIONS_dequeue_request (struct GSC_ClientActiveRequest *car);
89 * Transmit a message to a particular peer.
91 * @param car original request that was queued and then solicited,
92 * ownership does not change (dequeue will be called soon).
93 * @param msg message to transmit
94 * @param cork is corking allowed?
97 GSC_SESSIONS_transmit (struct GSC_ClientActiveRequest *car,
98 const struct GNUNET_MessageHeader *msg, int cork);
102 * Broadcast a message to all neighbours.
104 * @param msg message to transmit
107 GSC_SESSIONS_broadcast (const struct GNUNET_MessageHeader *msg);
111 * We have a new client, notify it about all current sessions.
113 * @param client the new client
116 GSC_SESSIONS_notify_client_about_sessions (struct GSC_Client *client);
119 * We've received a typemap message from a peer, update ours.
120 * Notifies clients about the session.
122 * @param peer peer this is about
123 * @param msg typemap update message
126 GSC_SESSIONS_set_typemap (const struct GNUNET_PeerIdentity *peer,
127 const struct GNUNET_MessageHeader *msg);
131 * The given peer send a message of the specified type. Make sure the
132 * respective bit is set in its type-map and that clients are notified
135 * @param peer peer this is about
136 * @param type type of the message
139 GSC_SESSIONS_add_to_typemap (const struct GNUNET_PeerIdentity *peer,
144 * Handle CORE_ITERATE_PEERS request. For this request type, the client
145 * does not have to have transmitted an INIT request. All current peers
146 * are returned, regardless of which message types they accept.
149 * @param client client sending the iteration request
150 * @param message iteration request message
153 GSC_SESSIONS_handle_client_iterate_peers (void *cls,
154 struct GNUNET_SERVER_Client *client,
155 const struct GNUNET_MessageHeader
160 * Initialize sessions subsystem.
163 GSC_SESSIONS_init (void);
167 * Shutdown sessions subsystem.
170 GSC_SESSIONS_done (void);