-do not leave PPT timeout tasks behind
[oweals/gnunet.git] / src / transport / gnunet-service-transport_clients.h
index a8ae14a53adec40066eaa191e4d75ca6bb275a80..a7cfe781586d520e824edb6c37b23fd7a76b98fb 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 Christian Grothoff (and other contributing authors)
 
      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"
 
 
 /**
@@ -35,7 +37,7 @@
  *
  * @param server server used to accept clients from.
  */
-void 
+void
 GST_clients_start (struct GNUNET_SERVER_Handle *server);
 
 
@@ -47,123 +49,61 @@ GST_clients_stop (void);
 
 
 /**
- * Initialize a normal client.  We got a start message from this
- * client, add him to the list of clients for broadcasting of inbound
- * messages.
- *
- * @param cls unused
- * @param client the client
- * @param message the start message that was sent
- */
-void
-GST_clients_handle_start (void *cls,
-                         struct GNUNET_SERVER_Client *client,
-                         const struct GNUNET_MessageHeader *message);
-
-
-/**
- * Client sent us a HELLO.  Process the request.
- *
- * @param cls unused
- * @param client the client
- * @param message the HELLO message
- */
-void
-GST_clients_handle_hello (void *cls,
-                         struct GNUNET_SERVER_Client *client,
-                         const struct GNUNET_MessageHeader *message);
-
-
-/**
- * Client asked for transmission to a peer.  Process the request.
- *
- * @param cls unused
- * @param client the client
- * @param message the send message that was sent
- */
-void
-GST_clients_handle_send (void *cls,
-                        struct GNUNET_SERVER_Client *client,
-                        const struct GNUNET_MessageHeader *message);
-
-
-/**
- * Client asked for a quota change for a particular peer.  Process the request.
- *
- * @param cls unused
- * @param client the client
- * @param message the quota changing message
- */
-void
-GST_clients_handle_set_quota (void *cls,
-                             struct GNUNET_SERVER_Client *client,
-                             const struct GNUNET_MessageHeader *message);
-
-
-/**
- * Client asked to resolve an address.  Process the request.
- *
- * @param cls unused
- * @param client the client
- * @param message the resolution request
- */
-void
-GST_clients_handle_address_lookup (void *cls,
-                                  struct GNUNET_SERVER_Client *client,
-                                  const struct GNUNET_MessageHeader *message);
-
-
-/**
- * Client asked to obtain information about a peer's addresses.
- * Process the request.
+ * Broadcast the given message to all of our clients.
  *
- * @param cls unused
- * @param client the client
- * @param message the peer address information request
+ * @param msg message to broadcast
+ * @param may_drop #GNUNET_YES if the message can be dropped / is payload
  */
 void
-GST_clients_handle_peer_address_lookup (void *cls,
-                                       struct GNUNET_SERVER_Client *client,
-                                       const struct GNUNET_MessageHeader *message);
+GST_clients_broadcast (const struct GNUNET_MessageHeader *msg,
+                       int may_drop);
 
 
 /**
- * Client asked to obtain information about all addresses.
- * Process the request.
+ * Send the given message to a particular client
  *
- * @param cls unused
- * @param client the client
- * @param message the peer address information request
+ * @param client target of the message
+ * @param msg message to transmit
+ * @param may_drop #GNUNET_YES if the message can be dropped
  */
 void
-GST_clients_handle_address_iterate (void *cls,
-                                   struct GNUNET_SERVER_Client *client,
-                                   const struct GNUNET_MessageHeader *message);
+GST_clients_unicast (struct GNUNET_SERVER_Client *client,
+                     const struct GNUNET_MessageHeader *msg,
+                     int may_drop);
 
 
 /**
- * Broadcast the given message to all of our clients.
+ * Broadcast the new active address to all clients monitoring the peer.
  *
- * @param msg message to broadcast
- * @param may_drop GNUNET_YES if the message can be dropped
+ * @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 (const struct GNUNET_MessageHeader *msg,
-                      int may_drop);
+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);
 
 
 /**
- * Send the given message to a particular client
+ * Broadcast the new validation changes to all clients monitoring the peer.
  *
- * @param client target of the message
- * @param msg message to transmit
- * @param may_drop GNUNET_YES if the message can be dropped
+ * @param peer peer this update is about (never NULL)
+ * @param address address, NULL on disconnect
+ * @param last_validation point in time when last validation was performed
+ * @param valid_until point in time how long address is valid
+ * @param next_validation point in time when next validation will be performed
+ * @param state state of validation notification
  */
 void
-GST_clients_unicast (struct GNUNET_SERVER_Client *client,
-                    const struct GNUNET_MessageHeader *msg,
-                    int may_drop);
-
+GST_clients_broadcast_validation_notification (const struct GNUNET_PeerIdentity *peer,
+                                               const struct GNUNET_HELLO_Address *address,
+                                               struct GNUNET_TIME_Absolute last_validation,
+                                               struct GNUNET_TIME_Absolute valid_until,
+                                               struct GNUNET_TIME_Absolute next_validation,
+                                               enum GNUNET_TRANSPORT_ValidationState state);
 
 
 #endif