2 This file is part of GNUnet.
3 Copyright (C) 2010,2011 GNUnet e.V.
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., 51 Franklin Street, Fifth Floor,
18 Boston, MA 02110-1301, USA.
22 * @file transport/gnunet-service-transport_clients.h
23 * @brief client management API
24 * @author Christian Grothoff
26 #ifndef GNUNET_SERVICE_TRANSPORT_CLIENTS_H
27 #define GNUNET_SERVICE_TRANSPORT_CLIENTS_H
29 #include "gnunet_transport_service.h"
30 #include "gnunet_statistics_service.h"
31 #include "gnunet_util_lib.h"
32 #include "gnunet_hello_lib.h"
36 * Start handling requests from clients.
38 * @param server server used to accept clients from.
41 GST_clients_start (struct GNUNET_SERVER_Handle *server);
45 * Stop processing clients.
48 GST_clients_stop (void);
52 * Broadcast the given message to all of our clients.
54 * @param msg message to broadcast
55 * @param may_drop #GNUNET_YES if the message can be dropped / is payload
58 GST_clients_broadcast (const struct GNUNET_MessageHeader *msg,
63 * Send the given message to a particular client
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
70 GST_clients_unicast (struct GNUNET_SERVER_Client *client,
71 const struct GNUNET_MessageHeader *msg,
76 * Broadcast the new active address to all clients monitoring the peer.
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
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);
91 * Notify all clients about a disconnect, and cancel
92 * pending SEND_OK messages for this peer.
94 * @param peer peer that disconnected
97 GST_clients_broadcast_disconnect (const struct GNUNET_PeerIdentity *peer);
101 * Broadcast the new validation changes to all clients monitoring the peer.
103 * @param peer peer this update is about (never NULL)
104 * @param address address, NULL on disconnect
105 * @param last_validation point in time when last validation was performed
106 * @param valid_until point in time how long address is valid
107 * @param next_validation point in time when next validation will be performed
108 * @param state state of validation notification
111 GST_clients_broadcast_validation_notification (const struct GNUNET_PeerIdentity *peer,
112 const struct GNUNET_HELLO_Address *address,
113 struct GNUNET_TIME_Absolute last_validation,
114 struct GNUNET_TIME_Absolute valid_until,
115 struct GNUNET_TIME_Absolute next_validation,
116 enum GNUNET_TRANSPORT_ValidationState state);
120 /* end of file gnunet-service-transport_clients.h */