src/core/gnunet-service-core_clients.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_clients.h
  23  * @brief code for managing interactions with clients of core service
  24  * @author Christian Grothoff
  25  */
  26 #ifndef GNUNET_SERVICE_CORE_CLIENTS_H
  27 #define GNUNET_SERVICE_CORE_CLIENTS_H
  28
  29 #include "gnunet_util_lib.h"
  30 #include "gnunet_service_core.h"
  31
  32
  33 /**
  34  * Notify a particular client about a change to existing connection to
  35  * one of our neighbours (check if the client is interested).  Called
  36  * from 'GSC_SESSIONS_notify_client_about_sessions'.
  37  *
  38  * @param client client to notify
  39  * @param neighbour identity of the neighbour that changed status
  40  * @param tmap_old previous type map for the neighbour, NULL for disconnect
  41  * @param tmap_new updated type map for the neighbour, NULL for disconnect
  42  */
  43 void
  44 GDS_CLIENTS_notify_client_about_neighbour (struct GSC_Client *client,
  45                                            const struct GNUNET_PeerIdentity *neighbour,
  46                                            const struct GSC_TypeMap *tmap_old,
  47                                            const struct GSC_TypeMap *tmap_new);
  48
  49
  50 /**
  51  * Notify client about a change to existing connection to one of our neighbours.
  52  *
  53  * @param neighbour identity of the neighbour that changed status
  54  * @param tmap_old previous type map for the neighbour, NULL for disconnect
  55  * @param tmap_new updated type map for the neighbour, NULL for disconnect
  56  */
  57 void
  58 GDS_CLIENTS_notify_clients_about_neighbour (const struct GNUNET_PeerIdentity *neighbour,
  59                                             const struct GSC_TypeMap *tmap_old,
  60                                             const struct GSC_TypeMap *tmap_new);
  61
  62
  63 /**
  64  * Deliver P2P message to interested clients.
  65  *
  66  * @param sender peer who sent us the message
  67  * @param m the message
  68  */
  69 void
  70 GSC_CLIENTS_deliver_message (const struct GNUNET_PeerIdentity *sender,
  71                              const struct GNUNET_MessageHeader *m);
  72
  73
  74 /**
  75  * Tell a client that we are ready to receive the message.
  76  *
  77  * @param car request that is now ready; the responsibility
  78  *        for the handle remains shared between CLIENTS
  79  *        and SESSIONS after this call.
  80  */
  81 void
  82 GSC_CLIENTS_solicit_request (struct GSC_ClientActiveRequest *car);
  83
  84
  85 /**
  86  * Tell a client that we will never be ready to receive the
  87  * given message in time (disconnect or timeout).
  88  *
  89  * @param car request that now permanently failed; the
  90  *        responsibility for the handle is now returned
  91  *        to CLIENTS (SESSIONS is done with it).
  92  */
  93 void
  94 GSC_CLIENTS_reject_request (struct GSC_ClientActiveRequest *car);
  95
  96
  97 /**
  98  * Initialize clients subsystem.
  99  *
 100  * @param server handle to server clients connect to
 101  */
 102 void
 103 GSC_CLIENTS_init (struct GNUNET_SERVER_Handle *server);
 104
 105
 106 /**
 107  * Shutdown clients subsystem.
 108  */
 109 void
 110 GSC_CLIENTS_done (void);
 111
 112 #endif
 113 /* end of gnunet-service-core_clients.h */