diff options
author | Matthias Wachs <wachs@net.in.tum.de> | 2014-01-16 14:03:36 +0000 |
---|---|---|
committer | Matthias Wachs <wachs@net.in.tum.de> | 2014-01-16 14:03:36 +0000 |
commit | c98e2e920ee8c27d3b319217056116c4f13d1c6a (patch) | |
tree | f958d954022da7a79d13902c6d922fcdbaa5e3a0 /src | |
parent | 8a5993b15da336afade45be6ee4619a39561956a (diff) | |
download | gnunet-c98e2e920ee8c27d3b319217056116c4f13d1c6a.tar.gz gnunet-c98e2e920ee8c27d3b319217056116c4f13d1c6a.zip |
more fixed documentation
Diffstat (limited to 'src')
-rw-r--r-- | src/ats/gnunet-service-ats_addresses.c | 1 | ||||
-rw-r--r-- | src/transport/gnunet-service-transport_clients.c | 8 | ||||
-rw-r--r-- | src/transport/gnunet-service-transport_clients.h | 11 | ||||
-rw-r--r-- | src/transport/gnunet-service-transport_manipulation.c | 4 | ||||
-rw-r--r-- | src/transport/gnunet-service-transport_manipulation.h | 4 | ||||
-rw-r--r-- | src/transport/gnunet-service-transport_neighbours.c | 1 | ||||
-rw-r--r-- | src/transport/gnunet-service-transport_validation.c | 2 | ||||
-rw-r--r-- | src/transport/gnunet-service-transport_validation.h | 3 | ||||
-rw-r--r-- | src/transport/plugin_transport_tcp.c | 2 | ||||
-rw-r--r-- | src/transport/plugin_transport_udp.c | 3 | ||||
-rw-r--r-- | src/transport/plugin_transport_unix.c | 6 | ||||
-rw-r--r-- | src/transport/plugin_transport_wlan.c | 2 | ||||
-rw-r--r-- | src/transport/transport_api_monitoring.c | 4 |
13 files changed, 31 insertions, 20 deletions
diff --git a/src/ats/gnunet-service-ats_addresses.c b/src/ats/gnunet-service-ats_addresses.c index a8c859450..61d76e770 100644 --- a/src/ats/gnunet-service-ats_addresses.c +++ b/src/ats/gnunet-service-ats_addresses.c | |||
@@ -472,6 +472,7 @@ free_address (struct ATS_Address *addr) | |||
472 | * @param plugin_name plugin | 472 | * @param plugin_name plugin |
473 | * @param plugin_addr address | 473 | * @param plugin_addr address |
474 | * @param plugin_addr_len address length | 474 | * @param plugin_addr_len address length |
475 | * @param local_address_info additional local info for the address | ||
475 | * @param session_id session | 476 | * @param session_id session |
476 | * @return the ATS_Address | 477 | * @return the ATS_Address |
477 | */ | 478 | */ |
diff --git a/src/transport/gnunet-service-transport_clients.c b/src/transport/gnunet-service-transport_clients.c index 7b47bb6f5..653becf39 100644 --- a/src/transport/gnunet-service-transport_clients.c +++ b/src/transport/gnunet-service-transport_clients.c | |||
@@ -1379,12 +1379,14 @@ GST_clients_broadcast_peer_notification (const struct GNUNET_PeerIdentity *peer, | |||
1379 | } | 1379 | } |
1380 | 1380 | ||
1381 | /** | 1381 | /** |
1382 | * Broadcast the new active address to all clients monitoring the peer. | 1382 | * Broadcast the new validation changes to all clients monitoring the peer. |
1383 | * | 1383 | * |
1384 | * @param peer peer this update is about (never NULL) | 1384 | * @param peer peer this update is about (never NULL) |
1385 | * @param address address, NULL on disconnect | 1385 | * @param address address, NULL on disconnect |
1386 | * @param state the current state of the peer | 1386 | * @param last_validation point in time when last validation was performed |
1387 | * @param state_timeout the time out for the state | 1387 | * @param valid_until point in time how long address is valid |
1388 | * @param next_validation point in time when next validation will be performed | ||
1389 | * @param state state of validation notification | ||
1388 | */ | 1390 | */ |
1389 | void | 1391 | void |
1390 | GST_clients_broadcast_validation_notification ( | 1392 | GST_clients_broadcast_validation_notification ( |
diff --git a/src/transport/gnunet-service-transport_clients.h b/src/transport/gnunet-service-transport_clients.h index 29c46c06b..f6d95eacc 100644 --- a/src/transport/gnunet-service-transport_clients.h +++ b/src/transport/gnunet-service-transport_clients.h | |||
@@ -85,6 +85,17 @@ GST_clients_broadcast_peer_notification (const struct GNUNET_PeerIdentity *peer, | |||
85 | enum GNUNET_TRANSPORT_PeerState state, | 85 | enum GNUNET_TRANSPORT_PeerState state, |
86 | struct GNUNET_TIME_Absolute state_timeout); | 86 | struct GNUNET_TIME_Absolute state_timeout); |
87 | 87 | ||
88 | |||
89 | /** | ||
90 | * Broadcast the new validation changes to all clients monitoring the peer. | ||
91 | * | ||
92 | * @param peer peer this update is about (never NULL) | ||
93 | * @param address address, NULL on disconnect | ||
94 | * @param last_validation point in time when last validation was performed | ||
95 | * @param valid_until point in time how long address is valid | ||
96 | * @param next_validation point in time when next validation will be performed | ||
97 | * @param state state of validation notification | ||
98 | */ | ||
88 | void | 99 | void |
89 | GST_clients_broadcast_validation_notification ( | 100 | GST_clients_broadcast_validation_notification ( |
90 | const struct GNUNET_PeerIdentity *peer, | 101 | const struct GNUNET_PeerIdentity *peer, |
diff --git a/src/transport/gnunet-service-transport_manipulation.c b/src/transport/gnunet-service-transport_manipulation.c index 06171d306..bb90e1892 100644 --- a/src/transport/gnunet-service-transport_manipulation.c +++ b/src/transport/gnunet-service-transport_manipulation.c | |||
@@ -521,11 +521,9 @@ GST_manipulation_manipulate_metrics(const struct GNUNET_PeerIdentity *peer, | |||
521 | * manipulation delays for next send. | 521 | * manipulation delays for next send. |
522 | * | 522 | * |
523 | * @param cls the closure for transport | 523 | * @param cls the closure for transport |
524 | * @param peer the peer the message was received from | 524 | * @param address the address and the peer the message was received from |
525 | * @param message the message received | 525 | * @param message the message received |
526 | * @param session the session the message was received on | 526 | * @param session the session the message was received on |
527 | * @param sender_address the sender address | ||
528 | * @param sender_address_len the length of the sender address | ||
529 | * @return manipulated delay for next receive | 527 | * @return manipulated delay for next receive |
530 | */ | 528 | */ |
531 | struct GNUNET_TIME_Relative | 529 | struct GNUNET_TIME_Relative |
diff --git a/src/transport/gnunet-service-transport_manipulation.h b/src/transport/gnunet-service-transport_manipulation.h index 3b6beb8b7..668e91716 100644 --- a/src/transport/gnunet-service-transport_manipulation.h +++ b/src/transport/gnunet-service-transport_manipulation.h | |||
@@ -70,11 +70,9 @@ GST_manipulation_send (const struct GNUNET_PeerIdentity *target, | |||
70 | * manipulation delays for next send. | 70 | * manipulation delays for next send. |
71 | * | 71 | * |
72 | * @param cls the closure for transport | 72 | * @param cls the closure for transport |
73 | * @param peer the peer the message was received from | 73 | * @param address the address and the peer the message was received from |
74 | * @param message the message received | 74 | * @param message the message received |
75 | * @param session the session the message was received on | 75 | * @param session the session the message was received on |
76 | * @param sender_address the sender address | ||
77 | * @param sender_address_len the length of the sender address | ||
78 | * @return manipulated delay for next receive | 76 | * @return manipulated delay for next receive |
79 | */ | 77 | */ |
80 | struct GNUNET_TIME_Relative | 78 | struct GNUNET_TIME_Relative |
diff --git a/src/transport/gnunet-service-transport_neighbours.c b/src/transport/gnunet-service-transport_neighbours.c index fbd524f3b..ad649ec0a 100644 --- a/src/transport/gnunet-service-transport_neighbours.c +++ b/src/transport/gnunet-service-transport_neighbours.c | |||
@@ -659,7 +659,6 @@ set_timeout (struct NeighbourMapEntry *n, | |||
659 | * address must be setup) | 659 | * address must be setup) |
660 | * @param bandwidth_in inbound quota to be used when connection is up | 660 | * @param bandwidth_in inbound quota to be used when connection is up |
661 | * @param bandwidth_out outbound quota to be used when connection is up | 661 | * @param bandwidth_out outbound quota to be used when connection is up |
662 | * @param is_active #GNUNET_YES to mark this as the active address with ATS | ||
663 | */ | 662 | */ |
664 | static void | 663 | static void |
665 | set_alternative_address (struct NeighbourMapEntry *n, | 664 | set_alternative_address (struct NeighbourMapEntry *n, |
diff --git a/src/transport/gnunet-service-transport_validation.c b/src/transport/gnunet-service-transport_validation.c index e18412588..8596c1f8d 100644 --- a/src/transport/gnunet-service-transport_validation.c +++ b/src/transport/gnunet-service-transport_validation.c | |||
@@ -863,6 +863,8 @@ process_peerinfo_hello (void *cls, const struct GNUNET_PeerIdentity *peer, | |||
863 | /** | 863 | /** |
864 | * Start the validation subsystem. | 864 | * Start the validation subsystem. |
865 | * | 865 | * |
866 | * @param cb callback to call with changes to valdidation entries | ||
867 | * @param cb_cls cls for the callback | ||
866 | * @param max_fds maximum number of fds to use | 868 | * @param max_fds maximum number of fds to use |
867 | */ | 869 | */ |
868 | void | 870 | void |
diff --git a/src/transport/gnunet-service-transport_validation.h b/src/transport/gnunet-service-transport_validation.h index 179070454..71c095c1b 100644 --- a/src/transport/gnunet-service-transport_validation.h +++ b/src/transport/gnunet-service-transport_validation.h | |||
@@ -51,9 +51,12 @@ typedef void (*GST_ValidationChangedCallback) (void *cls, | |||
51 | struct GNUNET_TIME_Absolute next_validation, | 51 | struct GNUNET_TIME_Absolute next_validation, |
52 | enum GNUNET_TRANSPORT_ValidationState state); | 52 | enum GNUNET_TRANSPORT_ValidationState state); |
53 | 53 | ||
54 | |||
54 | /** | 55 | /** |
55 | * Start the validation subsystem. | 56 | * Start the validation subsystem. |
56 | * | 57 | * |
58 | * @param cb callback to call with changes to valdidation entries | ||
59 | * @param cb_cls cls for the callback | ||
57 | * @param max_fds maximum number of fds to use | 60 | * @param max_fds maximum number of fds to use |
58 | */ | 61 | */ |
59 | void | 62 | void |
diff --git a/src/transport/plugin_transport_tcp.c b/src/transport/plugin_transport_tcp.c index 011b112c0..657043c24 100644 --- a/src/transport/plugin_transport_tcp.c +++ b/src/transport/plugin_transport_tcp.c | |||
@@ -877,7 +877,7 @@ reschedule_session_timeout (struct Session *s) | |||
877 | * Create a new session. Also queues a welcome message. | 877 | * Create a new session. Also queues a welcome message. |
878 | * | 878 | * |
879 | * @param plugin the plugin | 879 | * @param plugin the plugin |
880 | * @param target peer to connect to | 880 | * @param address the address to create the session for |
881 | * @param client client to use, reference counter must have already been increased | 881 | * @param client client to use, reference counter must have already been increased |
882 | * @param is_nat this a NAT session, we should wait for a client to | 882 | * @param is_nat this a NAT session, we should wait for a client to |
883 | * connect to us from an address, then assign that to | 883 | * connect to us from an address, then assign that to |
diff --git a/src/transport/plugin_transport_udp.c b/src/transport/plugin_transport_udp.c index e7ab1a818..e44a32e44 100644 --- a/src/transport/plugin_transport_udp.c +++ b/src/transport/plugin_transport_udp.c | |||
@@ -1385,7 +1385,6 @@ udp_get_network (void *cls, struct Session *session) | |||
1385 | * | 1385 | * |
1386 | * @param cls the plugin | 1386 | * @param cls the plugin |
1387 | * @param address the address | 1387 | * @param address the address |
1388 | * @param inbound look for inbound session | ||
1389 | * @return the session or NULL of max connections exceeded | 1388 | * @return the session or NULL of max connections exceeded |
1390 | */ | 1389 | */ |
1391 | static struct Session * | 1390 | static struct Session * |
@@ -1758,7 +1757,7 @@ udp_plugin_send (void *cls, struct Session *s, const char *msgbuf, | |||
1758 | * @param cls closure, the 'struct LocalAddrList' | 1757 | * @param cls closure, the 'struct LocalAddrList' |
1759 | * @param add_remove GNUNET_YES to mean the new public IP address, GNUNET_NO to mean | 1758 | * @param add_remove GNUNET_YES to mean the new public IP address, GNUNET_NO to mean |
1760 | * the previous (now invalid) one | 1759 | * the previous (now invalid) one |
1761 | * @param address either the previous or the new public IP address | 1760 | * @param addr either the previous or the new public IP address |
1762 | * @param addrlen actual lenght of the address | 1761 | * @param addrlen actual lenght of the address |
1763 | */ | 1762 | */ |
1764 | static void | 1763 | static void |
diff --git a/src/transport/plugin_transport_unix.c b/src/transport/plugin_transport_unix.c index 384787ae9..9fc4ba735 100644 --- a/src/transport/plugin_transport_unix.c +++ b/src/transport/plugin_transport_unix.c | |||
@@ -499,9 +499,7 @@ lookup_session_it (void *cls, | |||
499 | * Find an existing session by address. | 499 | * Find an existing session by address. |
500 | * | 500 | * |
501 | * @param plugin the plugin | 501 | * @param plugin the plugin |
502 | * @param sender for which peer should the session be? | 502 | * @param address the address to find |
503 | * @param ua address to look for | ||
504 | * @param ua_len length of the address | ||
505 | * @return NULL if session was not found | 503 | * @return NULL if session was not found |
506 | */ | 504 | */ |
507 | static struct Session * | 505 | static struct Session * |
@@ -1503,7 +1501,7 @@ address_notification (void *cls, | |||
1503 | /** | 1501 | /** |
1504 | * Increment session timeout due to activity | 1502 | * Increment session timeout due to activity |
1505 | * | 1503 | * |
1506 | * @param res session for which the timeout should be moved | 1504 | * @param s session for which the timeout should be rescheduled |
1507 | */ | 1505 | */ |
1508 | static void | 1506 | static void |
1509 | reschedule_session_timeout (struct Session *s) | 1507 | reschedule_session_timeout (struct Session *s) |
diff --git a/src/transport/plugin_transport_wlan.c b/src/transport/plugin_transport_wlan.c index 77bb28ebc..e3dd24fdb 100644 --- a/src/transport/plugin_transport_wlan.c +++ b/src/transport/plugin_transport_wlan.c | |||
@@ -1060,7 +1060,7 @@ macendpoint_timeout (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc) | |||
1060 | * Find (or create) a MacEndpoint with a specific MAC address | 1060 | * Find (or create) a MacEndpoint with a specific MAC address |
1061 | * | 1061 | * |
1062 | * @param plugin pointer to the plugin struct | 1062 | * @param plugin pointer to the plugin struct |
1063 | * @param addr the MAC address of the endpoint | 1063 | * @param mac the MAC address of the endpoint |
1064 | * @return handle to our data structure for this MAC | 1064 | * @return handle to our data structure for this MAC |
1065 | */ | 1065 | */ |
1066 | static struct MacEndpoint * | 1066 | static struct MacEndpoint * |
diff --git a/src/transport/transport_api_monitoring.c b/src/transport/transport_api_monitoring.c index 49520797d..810bca0cb 100644 --- a/src/transport/transport_api_monitoring.c +++ b/src/transport/transport_api_monitoring.c | |||
@@ -304,7 +304,7 @@ send_peer_mon_request (struct GNUNET_TRANSPORT_PeerMonitoringContext *pal_ctx) | |||
304 | /** | 304 | /** |
305 | * Send our subscription request to the service. | 305 | * Send our subscription request to the service. |
306 | * | 306 | * |
307 | * @param pal_ctx our context | 307 | * @param val_ctx our context |
308 | */ | 308 | */ |
309 | static void | 309 | static void |
310 | send_val_mon_request (struct GNUNET_TRANSPORT_ValidationMonitoringContext *val_ctx) | 310 | send_val_mon_request (struct GNUNET_TRANSPORT_ValidationMonitoringContext *val_ctx) |
@@ -382,7 +382,7 @@ do_val_connect (void *cls, | |||
382 | /** | 382 | /** |
383 | * Cut the existing connection and reconnect. | 383 | * Cut the existing connection and reconnect. |
384 | * | 384 | * |
385 | * @param pal_ctx our context | 385 | * @param val_ctx our context |
386 | */ | 386 | */ |
387 | static void | 387 | static void |
388 | reconnect_val_ctx (struct GNUNET_TRANSPORT_ValidationMonitoringContext *val_ctx) | 388 | reconnect_val_ctx (struct GNUNET_TRANSPORT_ValidationMonitoringContext *val_ctx) |