src/transport/gnunet-service-transport_clients.h

   1 /*
   2      This file is part of GNUnet.
   3      Copyright (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., 51 Franklin Street, Fifth Floor,
  18      Boston, MA 02110-1301, USA.
  19 */
  20
  21 /**
  22  * @file transport/gnunet-service-transport_clients.h
  23  * @brief client 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_transport_service.h"
  30 #include "gnunet_statistics_service.h"
  31 #include "gnunet_util_lib.h"
  32 #include "gnunet_hello_lib.h"
  33
  34
  35 /**
  36  * Start handling requests from clients.
  37  *
  38  * @param server server used to accept clients from.
  39  */
  40 void
  41 GST_clients_start (struct GNUNET_SERVER_Handle *server);
  42
  43
  44 /**
  45  * Stop processing clients.
  46  */
  47 void
  48 GST_clients_stop (void);
  49
  50
  51 /**
  52  * Broadcast the given message to all of our clients.
  53  *
  54  * @param msg message to broadcast
  55  * @param may_drop #GNUNET_YES if the message can be dropped / is payload
  56  */
  57 void
  58 GST_clients_broadcast (const struct GNUNET_MessageHeader *msg,
  59                        int may_drop);
  60
  61
  62 /**
  63  * Send the given message to a particular client
  64  *
  65  * @param client target of the message
  66  * @param msg message to transmit
  67  * @param may_drop #GNUNET_YES if the message can be dropped
  68  */
  69 void
  70 GST_clients_unicast (struct GNUNET_SERVER_Client *client,
  71                      const struct GNUNET_MessageHeader *msg,
  72                      int may_drop);
  73
  74
  75 /**
  76  * Broadcast the new active address to all clients monitoring the peer.
  77  *
  78  * @param peer peer this update is about (never NULL)
  79  * @param address address, NULL on disconnect
  80  * @param state the current state of the peer
  81  * @param state_timeout the time out for the state
  82  */
  83 void
  84 GST_clients_broadcast_peer_notification (const struct GNUNET_PeerIdentity *peer,
  85                                          const struct GNUNET_HELLO_Address *address,
  86                                          enum GNUNET_TRANSPORT_PeerState state,
  87                                          struct GNUNET_TIME_Absolute state_timeout);
  88
  89
  90 /**
  91  * Broadcast the new validation changes to all clients monitoring the peer.
  92  *
  93  * @param peer peer this update is about (never NULL)
  94  * @param address address, NULL on disconnect
  95  * @param last_validation point in time when last validation was performed
  96  * @param valid_until point in time how long address is valid
  97  * @param next_validation point in time when next validation will be performed
  98  * @param state state of validation notification
  99  */
 100 void
 101 GST_clients_broadcast_validation_notification (const struct GNUNET_PeerIdentity *peer,
 102                                                const struct GNUNET_HELLO_Address *address,
 103                                                struct GNUNET_TIME_Absolute last_validation,
 104                                                struct GNUNET_TIME_Absolute valid_until,
 105                                                struct GNUNET_TIME_Absolute next_validation,
 106                                                enum GNUNET_TRANSPORT_ValidationState state);
 107
 108
 109 #endif
 110 /* end of file gnunet-service-transport_clients.h */