src/transport/gnunet-service-transport_clients.h

   1 /*
   2      This file is part of GNUnet.
   3      (C) 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 transport/gnunet-service-transport_clients.h
  23  * @brief plugin management API
  24  * @author Christian Grothoff
  25  */
  26 #ifndef GNUNET_SERVICE_TRANSPORT_CLIENTS_H
  27 #define GNUNET_SERVICE_TRANSPORT_CLIENTS_H
  28
  29 #include "gnunet_statistics_service.h"
  30 #include "gnunet_util_lib.h"
  31 #include "gnunet_hello_lib.h"
  32
  33
  34 /**
  35  * Start handling requests from clients.
  36  *
  37  * @param server server used to accept clients from.
  38  */
  39 void
  40 GST_clients_start (struct GNUNET_SERVER_Handle *server);
  41
  42
  43 /**
  44  * Stop processing clients.
  45  */
  46 void
  47 GST_clients_stop (void);
  48
  49
  50 /**
  51  * Broadcast the given message to all of our clients.
  52  *
  53  * @param msg message to broadcast
  54  * @param may_drop GNUNET_YES if the message can be dropped / is payload
  55  */
  56 void
  57 GST_clients_broadcast (const struct GNUNET_MessageHeader *msg, int may_drop);
  58
  59
  60 /**
  61  * Send the given message to a particular client
  62  *
  63  * @param client target of the message
  64  * @param msg message to transmit
  65  * @param may_drop GNUNET_YES if the message can be dropped
  66  */
  67 void
  68 GST_clients_unicast (struct GNUNET_SERVER_Client *client,
  69                      const struct GNUNET_MessageHeader *msg, int may_drop);
  70
  71
  72 /**
  73  * Broadcast the new active address to all clients monitoring the peer.
  74  *
  75  * @param peer peer this update is about (never NULL)
  76  * @param address address, NULL on disconnect
  77  */
  78 void
  79 GST_clients_broadcast_address_notification (const struct GNUNET_PeerIdentity
  80                                             *peer,
  81                                             const struct GNUNET_HELLO_Address
  82                                             *address);
  83
  84
  85 #endif
  86 /* end of file gnunet-service-transport_clients.h */