- fix coverity
[oweals/gnunet.git] / src / transport / gnunet-service-transport_clients.h
index 25d075864bbff9b6a436241a0be5d967147a7329..d85e1e34048f3708f722bccda4a62a2aaed84f34 100644 (file)
@@ -1,6 +1,6 @@
 /*
      This file is part of GNUnet.
-     (C) 2010,2011 Christian Grothoff (and other contributing authors)
+     Copyright (C) 2010,2011 GNUnet e.V.
 
      GNUnet is free software; you can redistribute it and/or modify
      it under the terms of the GNU General Public License as published
 
      You should have received a copy of the GNU General Public License
      along with GNUnet; see the file COPYING.  If not, write to the
-     Free Software Foundation, Inc., 59 Temple Place - Suite 330,
-     Boston, MA 02111-1307, USA.
+     Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
+     Boston, MA 02110-1301, USA.
 */
 
 /**
  * @file transport/gnunet-service-transport_clients.h
- * @brief plugin management API
+ * @brief client management API
  * @author Christian Grothoff
  */
 #ifndef GNUNET_SERVICE_TRANSPORT_CLIENTS_H
 #define GNUNET_SERVICE_TRANSPORT_CLIENTS_H
 
+#include "gnunet_transport_service.h"
 #include "gnunet_statistics_service.h"
 #include "gnunet_util_lib.h"
 #include "gnunet_hello_lib.h"
 
 
-
 /**
  * Start handling requests from clients.
  *
@@ -52,10 +52,11 @@ GST_clients_stop (void);
  * Broadcast the given message to all of our clients.
  *
  * @param msg message to broadcast
- * @param may_drop GNUNET_YES if the message can be dropped / is payload
+ * @param may_drop #GNUNET_YES if the message can be dropped / is payload
  */
 void
-GST_clients_broadcast (const struct GNUNET_MessageHeader *msg, int may_drop);
+GST_clients_broadcast (const struct GNUNET_MessageHeader *msg,
+                       int may_drop);
 
 
 /**
@@ -63,11 +64,12 @@ GST_clients_broadcast (const struct GNUNET_MessageHeader *msg, int may_drop);
  *
  * @param client target of the message
  * @param msg message to transmit
- * @param may_drop GNUNET_YES if the message can be dropped
+ * @param may_drop #GNUNET_YES if the message can be dropped
  */
 void
 GST_clients_unicast (struct GNUNET_SERVER_Client *client,
-                     const struct GNUNET_MessageHeader *msg, int may_drop);
+                     const struct GNUNET_MessageHeader *msg,
+                     int may_drop);
 
 
 /**
@@ -75,12 +77,24 @@ GST_clients_unicast (struct GNUNET_SERVER_Client *client,
  *
  * @param peer peer this update is about (never NULL)
  * @param address address, NULL on disconnect
+ * @param state the current state of the peer
+ * @param state_timeout the time out for the state
+ */
+void
+GST_clients_broadcast_peer_notification (const struct GNUNET_PeerIdentity *peer,
+                                         const struct GNUNET_HELLO_Address *address,
+                                         enum GNUNET_TRANSPORT_PeerState state,
+                                         struct GNUNET_TIME_Absolute state_timeout);
+
+
+/**
+ * Notify all clients about a disconnect, and cancel
+ * pending SEND_OK messages for this peer.
+ *
+ * @param peer peer that disconnected
  */
 void
-GST_clients_broadcast_address_notification (const struct GNUNET_PeerIdentity
-                                            *peer,
-                                            const struct GNUNET_HELLO_Address
-                                            *address);
+GST_clients_broadcast_disconnect (const struct GNUNET_PeerIdentity *peer);
 
 
 #endif