gnunet-svn
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

[GNUnet-SVN] r31933 - in gnunet/src: ats transport


From: gnunet
Subject: [GNUnet-SVN] r31933 - in gnunet/src: ats transport
Date: Thu, 16 Jan 2014 15:03:36 +0100

Author: wachs
Date: 2014-01-16 15:03:36 +0100 (Thu, 16 Jan 2014)
New Revision: 31933

Modified:
   gnunet/src/ats/gnunet-service-ats_addresses.c
   gnunet/src/transport/gnunet-service-transport_clients.c
   gnunet/src/transport/gnunet-service-transport_clients.h
   gnunet/src/transport/gnunet-service-transport_manipulation.c
   gnunet/src/transport/gnunet-service-transport_manipulation.h
   gnunet/src/transport/gnunet-service-transport_neighbours.c
   gnunet/src/transport/gnunet-service-transport_validation.c
   gnunet/src/transport/gnunet-service-transport_validation.h
   gnunet/src/transport/plugin_transport_tcp.c
   gnunet/src/transport/plugin_transport_udp.c
   gnunet/src/transport/plugin_transport_unix.c
   gnunet/src/transport/plugin_transport_wlan.c
   gnunet/src/transport/transport_api_monitoring.c
Log:
more fixed documentation


Modified: gnunet/src/ats/gnunet-service-ats_addresses.c
===================================================================
--- gnunet/src/ats/gnunet-service-ats_addresses.c       2014-01-16 12:29:57 UTC 
(rev 31932)
+++ gnunet/src/ats/gnunet-service-ats_addresses.c       2014-01-16 14:03:36 UTC 
(rev 31933)
@@ -472,6 +472,7 @@
  * @param plugin_name plugin
  * @param plugin_addr address
  * @param plugin_addr_len address length
+ * @param local_address_info additional local info for the address
  * @param session_id session
  * @return the ATS_Address
  */

Modified: gnunet/src/transport/gnunet-service-transport_clients.c
===================================================================
--- gnunet/src/transport/gnunet-service-transport_clients.c     2014-01-16 
12:29:57 UTC (rev 31932)
+++ gnunet/src/transport/gnunet-service-transport_clients.c     2014-01-16 
14:03:36 UTC (rev 31933)
@@ -1379,12 +1379,14 @@
 }
 
 /**
- * Broadcast the new active address to all clients monitoring the peer.
+ * Broadcast the new validation changes to all clients monitoring the peer.
  *
  * @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
+ * @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_broadcast_validation_notification (

Modified: gnunet/src/transport/gnunet-service-transport_clients.h
===================================================================
--- gnunet/src/transport/gnunet-service-transport_clients.h     2014-01-16 
12:29:57 UTC (rev 31932)
+++ gnunet/src/transport/gnunet-service-transport_clients.h     2014-01-16 
14:03:36 UTC (rev 31933)
@@ -85,6 +85,17 @@
     enum GNUNET_TRANSPORT_PeerState state,
     struct GNUNET_TIME_Absolute state_timeout);
 
+
+/**
+ * Broadcast the new validation changes to all clients monitoring the peer.
+ *
+ * @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_broadcast_validation_notification (
     const struct GNUNET_PeerIdentity *peer,

Modified: gnunet/src/transport/gnunet-service-transport_manipulation.c
===================================================================
--- gnunet/src/transport/gnunet-service-transport_manipulation.c        
2014-01-16 12:29:57 UTC (rev 31932)
+++ gnunet/src/transport/gnunet-service-transport_manipulation.c        
2014-01-16 14:03:36 UTC (rev 31933)
@@ -521,11 +521,9 @@
  * manipulation delays for next send.
  *
  * @param cls the closure for transport
- * @param peer the peer the message was received from
+ * @param address the address and the peer the message was received from
  * @param message the message received
  * @param session the session the message was received on
- * @param sender_address the sender address
- * @param sender_address_len the length of the sender address
  * @return manipulated delay for next receive
  */
 struct GNUNET_TIME_Relative

Modified: gnunet/src/transport/gnunet-service-transport_manipulation.h
===================================================================
--- gnunet/src/transport/gnunet-service-transport_manipulation.h        
2014-01-16 12:29:57 UTC (rev 31932)
+++ gnunet/src/transport/gnunet-service-transport_manipulation.h        
2014-01-16 14:03:36 UTC (rev 31933)
@@ -70,11 +70,9 @@
  * manipulation delays for next send.
  *
  * @param cls the closure for transport
- * @param peer the peer the message was received from
+ * @param address the address and the peer the message was received from
  * @param message the message received
  * @param session the session the message was received on
- * @param sender_address the sender address
- * @param sender_address_len the length of the sender address
  * @return manipulated delay for next receive
  */
 struct GNUNET_TIME_Relative

Modified: gnunet/src/transport/gnunet-service-transport_neighbours.c
===================================================================
--- gnunet/src/transport/gnunet-service-transport_neighbours.c  2014-01-16 
12:29:57 UTC (rev 31932)
+++ gnunet/src/transport/gnunet-service-transport_neighbours.c  2014-01-16 
14:03:36 UTC (rev 31933)
@@ -659,7 +659,6 @@
  *        address must be setup)
  * @param bandwidth_in inbound quota to be used when connection is up
  * @param bandwidth_out outbound quota to be used when connection is up
- * @param is_active #GNUNET_YES to mark this as the active address with ATS
  */
 static void
 set_alternative_address (struct NeighbourMapEntry *n,

Modified: gnunet/src/transport/gnunet-service-transport_validation.c
===================================================================
--- gnunet/src/transport/gnunet-service-transport_validation.c  2014-01-16 
12:29:57 UTC (rev 31932)
+++ gnunet/src/transport/gnunet-service-transport_validation.c  2014-01-16 
14:03:36 UTC (rev 31933)
@@ -863,6 +863,8 @@
 /**
  * Start the validation subsystem.
  *
+ * @param cb callback to call with changes to valdidation entries
+ * @param cb_cls cls for the callback
  * @param max_fds maximum number of fds to use
  */
 void

Modified: gnunet/src/transport/gnunet-service-transport_validation.h
===================================================================
--- gnunet/src/transport/gnunet-service-transport_validation.h  2014-01-16 
12:29:57 UTC (rev 31932)
+++ gnunet/src/transport/gnunet-service-transport_validation.h  2014-01-16 
14:03:36 UTC (rev 31933)
@@ -51,9 +51,12 @@
     struct GNUNET_TIME_Absolute next_validation,
     enum GNUNET_TRANSPORT_ValidationState state);
 
+
 /**
  * Start the validation subsystem.
  *
+ * @param cb callback to call with changes to valdidation entries
+ * @param cb_cls cls for the callback
  * @param max_fds maximum number of fds to use
  */
 void

Modified: gnunet/src/transport/plugin_transport_tcp.c
===================================================================
--- gnunet/src/transport/plugin_transport_tcp.c 2014-01-16 12:29:57 UTC (rev 
31932)
+++ gnunet/src/transport/plugin_transport_tcp.c 2014-01-16 14:03:36 UTC (rev 
31933)
@@ -877,7 +877,7 @@
  * Create a new session.  Also queues a welcome message.
  *
  * @param plugin the plugin
- * @param target peer to connect to
+ * @param address the address to create the session for
  * @param client client to use, reference counter must have already been 
increased
  * @param is_nat this a NAT session, we should wait for a client to
  *               connect to us from an address, then assign that to

Modified: gnunet/src/transport/plugin_transport_udp.c
===================================================================
--- gnunet/src/transport/plugin_transport_udp.c 2014-01-16 12:29:57 UTC (rev 
31932)
+++ gnunet/src/transport/plugin_transport_udp.c 2014-01-16 14:03:36 UTC (rev 
31933)
@@ -1385,7 +1385,6 @@
  *
  * @param cls the plugin
  * @param address the address
- * @param inbound look for inbound session
  * @return the session or NULL of max connections exceeded
  */
 static struct Session *
@@ -1758,7 +1757,7 @@
  * @param cls closure, the 'struct LocalAddrList'
  * @param add_remove GNUNET_YES to mean the new public IP address, GNUNET_NO 
to mean
  *     the previous (now invalid) one
- * @param address either the previous or the new public IP address
+ * @param addr either the previous or the new public IP address
  * @param addrlen actual lenght of the address
  */
 static void

Modified: gnunet/src/transport/plugin_transport_unix.c
===================================================================
--- gnunet/src/transport/plugin_transport_unix.c        2014-01-16 12:29:57 UTC 
(rev 31932)
+++ gnunet/src/transport/plugin_transport_unix.c        2014-01-16 14:03:36 UTC 
(rev 31933)
@@ -499,9 +499,7 @@
  * Find an existing session by address.
  *
  * @param plugin the plugin
- * @param sender for which peer should the session be?
- * @param ua address to look for
- * @param ua_len length of the address
+ * @param address the address to find
  * @return NULL if session was not found
  */
 static struct Session *
@@ -1503,7 +1501,7 @@
 /**
  * Increment session timeout due to activity
  *
- * @param res session for which the timeout should be moved
+ * @param s session for which the timeout should be rescheduled
  */
 static void
 reschedule_session_timeout (struct Session *s)

Modified: gnunet/src/transport/plugin_transport_wlan.c
===================================================================
--- gnunet/src/transport/plugin_transport_wlan.c        2014-01-16 12:29:57 UTC 
(rev 31932)
+++ gnunet/src/transport/plugin_transport_wlan.c        2014-01-16 14:03:36 UTC 
(rev 31933)
@@ -1060,7 +1060,7 @@
  * Find (or create) a MacEndpoint with a specific MAC address
  *
  * @param plugin pointer to the plugin struct
- * @param addr the MAC address of the endpoint
+ * @param mac the MAC address of the endpoint
  * @return handle to our data structure for this MAC
  */
 static struct MacEndpoint *

Modified: gnunet/src/transport/transport_api_monitoring.c
===================================================================
--- gnunet/src/transport/transport_api_monitoring.c     2014-01-16 12:29:57 UTC 
(rev 31932)
+++ gnunet/src/transport/transport_api_monitoring.c     2014-01-16 14:03:36 UTC 
(rev 31933)
@@ -304,7 +304,7 @@
 /**
  * Send our subscription request to the service.
  *
- * @param pal_ctx our context
+ * @param val_ctx our context
  */
 static void
 send_val_mon_request (struct GNUNET_TRANSPORT_ValidationMonitoringContext 
*val_ctx)
@@ -382,7 +382,7 @@
 /**
  * Cut the existing connection and reconnect.
  *
- * @param pal_ctx our context
+ * @param val_ctx our context
  */
 static void
 reconnect_val_ctx (struct GNUNET_TRANSPORT_ValidationMonitoringContext 
*val_ctx)




reply via email to

[Prev in Thread] Current Thread [Next in Thread]