src/core/gnunet-service-core_sessions.h

   1 /*
   2      This file is part of GNUnet.
   3      (C) 2009, 2010, 2011 Christian Grothoff (and other contributing authors)
   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., 59 Temple Place - Suite 330,
  18      Boston, MA 02111-1307, USA.
  19 */
  20
  21 /**
  22  * @file core/gnunet-service-core_neighbours.h
  23  * @brief code for managing of 'encrypted' sessions (key exchange done)
  24  * @author Christian Grothoff
  25  */
  26 #ifndef GNUNET_SERVICE_CORE_SESSIONS_H
  27 #define GNUNET_SERVICE_CORE_SESSIONS_H
  28
  29 #include "gnunet-service-core.h"
  30 #include "gnunet-service-core_kx.h"
  31
  32
  33 /**
  34  * Create a session, a key exchange was just completed.
  35  *
  36  * @param peer peer that is now connected
  37  * @param kx key exchange that completed
  38  */
  39 void
  40 GSC_SESSIONS_create (const struct GNUNET_PeerIdentity *peer,
  41                      struct GSC_KeyExchangeInfo *kx);
  42
  43
  44 /**
  45  * End the session with the given peer (we are no longer
  46  * connected).
  47  *
  48  * @param pid identity of peer to kill session with
  49  */
  50 void
  51 GSC_SESSIONS_end (const struct GNUNET_PeerIdentity *pid);
  52
  53
  54 /**
  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.
  58  *
  59  * @param pid identity of peer ready to receive data
  60  */
  61 void
  62 GSC_SESSIONS_solicit (const struct GNUNET_PeerIdentity *pid);
  63
  64
  65 /**
  66  * Queue a request from a client for transmission to a particular peer.
  67  *
  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
  73  */
  74 void
  75 GSC_SESSIONS_queue_request (struct GSC_ClientActiveRequest *car);
  76
  77
  78 /**
  79  * Dequeue a request from a client from transmission to a particular peer.
  80  *
  81  * @param car request to dequeue; this handle will then be 'owned' by
  82  *        the caller (CLIENTS sysbsystem)
  83  */
  84 void
  85 GSC_SESSIONS_dequeue_request (struct GSC_ClientActiveRequest *car);
  86
  87
  88 /**
  89  * Transmit a message to a particular peer.
  90  *
  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?
  95  */
  96 void
  97 GSC_SESSIONS_transmit (struct GSC_ClientActiveRequest *car,
  98                        const struct GNUNET_MessageHeader *msg,
  99                        int cork);
 100
 101
 102 /**
 103  * Broadcast a message to all neighbours.
 104  *
 105  * @param msg message to transmit
 106  */
 107 void
 108 GSC_SESSIONS_broadcast (const struct GNUNET_MessageHeader *msg);
 109
 110
 111 /**
 112  * We have a new client, notify it about all current sessions.
 113  *
 114  * @param client the new client
 115  */
 116 void
 117 GSC_SESSIONS_notify_client_about_sessions (struct GSC_Client *client);
 118
 119 /**
 120  * We've received a typemap message from a peer, update ours.
 121  * Notifies clients about the session.
 122  *
 123  * @param peer peer this is about
 124  * @param msg typemap update message
 125  */
 126 void
 127 GSC_SESSIONS_set_typemap (const struct GNUNET_PeerIdentity *peer,
 128                           const struct GNUNET_MessageHeader *msg);
 129
 130
 131 /**
 132  * The given peer send a message of the specified type.  Make sure the
 133  * respective bit is set in its type-map and that clients are notified
 134  * about the session.
 135  *
 136  * @param peer peer this is about
 137  * @param type type of the message
 138  */
 139 void
 140 GSC_SESSIONS_add_to_typemap (const struct GNUNET_PeerIdentity *peer,
 141                              uint16_t type);
 142
 143
 144 /**
 145  * Handle CORE_ITERATE_PEERS request.  For this request type, the client
 146  * does not have to have transmitted an INIT request.  All current peers
 147  * are returned, regardless of which message types they accept.
 148  *
 149  * @param cls unused
 150  * @param client client sending the iteration request
 151  * @param message iteration request message
 152  */
 153 void
 154 GSC_SESSIONS_handle_client_iterate_peers (void *cls, struct GNUNET_SERVER_Client *client,
 155                                           const struct GNUNET_MessageHeader *message);
 156
 157
 158 /**
 159  * Handle CORE_PEER_CONNECTED request.  Notify client about connection
 160  * to the given neighbour.  For this request type, the client does not
 161  * have to have transmitted an INIT request.  All current peers are
 162  * returned, regardless of which message types they accept.
 163  *
 164  * @param cls unused
 165  * @param client client sending the iteration request
 166  * @param message iteration request message
 167  */
 168 void
 169 GSC_SESSIONS_handle_client_have_peer (void *cls, struct GNUNET_SERVER_Client *client,
 170                                       const struct GNUNET_MessageHeader *message);
 171
 172
 173
 174 /**
 175  * Initialize sessions subsystem.
 176  */
 177 void
 178 GSC_SESSIONS_init (void);
 179
 180
 181 /**
 182  * Shutdown sessions subsystem.
 183  */
 184 void
 185 GSC_SESSIONS_done (void);
 186
 187
 188
 189 #endif