From 3261daf13b7df8f7f25c3e5e489a337ed20103bc Mon Sep 17 00:00:00 2001 From: Matthias Wachs Date: Wed, 30 Nov 2011 15:13:38 +0000 Subject: - doxygen --- src/transport/plugin_transport_http_server.c | 5 +++- src/transport/transport-testing.c | 14 +++++++++-- src/transport/transport-testing.h | 37 ++++++++++++++++++---------- 3 files changed, 40 insertions(+), 16 deletions(-) (limited to 'src/transport') diff --git a/src/transport/plugin_transport_http_server.c b/src/transport/plugin_transport_http_server.c index 2c180c5ff..24c27aced 100644 --- a/src/transport/plugin_transport_http_server.c +++ b/src/transport/plugin_transport_http_server.c @@ -47,10 +47,12 @@ struct ServerConnection * starts the task waiting for them. * @param plugin plugin * @param daemon_handle the MHD daemon handle + * @param now schedule now or with MHD delay * @return gnunet task identifier */ static GNUNET_SCHEDULER_TaskIdentifier -server_schedule (struct Plugin *plugin, struct MHD_Daemon *daemon_handle, +server_schedule (struct Plugin *plugin, + struct MHD_Daemon *daemon_handle, int now); static void @@ -238,6 +240,7 @@ server_load_certificate (struct Plugin *plugin) /** * Reschedule the execution of both IPv4 and IPv6 server * @param plugin the plugin + * @param server which server to schedule v4 or v6? * @param now GNUNET_YES to schedule execution immediately, GNUNET_NO to wait * until timeout */ diff --git a/src/transport/transport-testing.c b/src/transport/transport-testing.c index 9f7a99a7b..dcd95053b 100644 --- a/src/transport/transport-testing.c +++ b/src/transport/transport-testing.c @@ -253,9 +253,13 @@ try_connect (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc) /** * Start a peer with the given configuration + * @param tth the testing handle + * @param cfgname configuration file + * @param peer_id the peer_id * @param rec receive callback * @param nc connect callback * @param nd disconnect callback + * @param start_cb start callback * @param cb_cls closure for callback * @return the peer context */ @@ -352,6 +356,8 @@ GNUNET_TRANSPORT_TESTING_start_peer (struct GNUNET_TRANSPORT_TESTING_handle * @param tth testing handle * @param p the peer * @param cfgname the cfg file used to restart +* @param restart_cb callback to call when restarted +* @param cb_cls callback closure * @return GNUNET_OK in success otherwise GNUNET_SYSERR */ int @@ -460,6 +466,7 @@ fail: /** * shutdown the given peer + * @param tth testing handle * @param p the peer */ void @@ -563,7 +570,9 @@ GNUNET_TRANSPORT_TESTING_connect_peers (struct GNUNET_TRANSPORT_TESTING_handle /** * Cancel the request to connect two peers * Tou MUST cancel the request if you stop the peers before the peers connected succesfully - * @param cc a connect request handle + * + * @param tth transport testing handle + * @param ccr a connect request handle */ void GNUNET_TRANSPORT_TESTING_connect_peers_cancel (struct @@ -829,8 +838,9 @@ suc: /** * This function takes the filename (e.g. argv[0), removes a "lt-"-prefix and * if existing ".exe"-prefix and adds the peer-number + * * @param file filename of the test, e.g. argv[0] - * @param cfgname where to write the result + * @param dest where to write the filename * @param count peer number */ void diff --git a/src/transport/transport-testing.h b/src/transport/transport-testing.h index c77d79381..cc4974ff8 100644 --- a/src/transport/transport-testing.h +++ b/src/transport/transport-testing.h @@ -131,16 +131,18 @@ struct GNUNET_TRANSPORT_TESTING_handle }; - /** - * Start a peer with the given configuration - * @param rec receive callback - * @param nc connect callback - * @param nd disconnect callback - * @param cb_cls closure for callback - * if NULL passed the PeerContext * will be used! - * @return the peer context - */ +* Start a peer with the given configuration +* @param tth the testing handle +* @param cfgname configuration file +* @param peer_id the peer_id +* @param rec receive callback +* @param nc connect callback +* @param nd disconnect callback +* @param start_cb start callback +* @param cb_cls closure for callback +* @return the peer context +*/ struct PeerContext * GNUNET_TRANSPORT_TESTING_start_peer (struct GNUNET_TRANSPORT_TESTING_handle *tth, const char *cfgname, int peer_id, @@ -153,6 +155,7 @@ GNUNET_TRANSPORT_TESTING_start_peer (struct GNUNET_TRANSPORT_TESTING_handle /** * shutdown the given peer + * @param tth the testing handle * @param p the peer */ @@ -166,6 +169,8 @@ GNUNET_TRANSPORT_TESTING_stop_peer (struct GNUNET_TRANSPORT_TESTING_handle *tth, * @param tth testing handle * @param p the peer * @param cfgname the cfg file used to restart +* @param restart_cb restart callback +* @param cb_cls callback closure * @return GNUNET_OK in success otherwise GNUNET_SYSERR */ int @@ -173,12 +178,14 @@ GNUNET_TRANSPORT_TESTING_restart_peer (struct GNUNET_TRANSPORT_TESTING_handle *tth, struct PeerContext *p, const char *cfgname, GNUNET_TRANSPORT_TESTING_start_cb - start_cb, void *cb_cls); + restart_cb, void *cb_cls); /** * Connect the given peers and call the callback when both peers report the * inbound connection. Remarks: start_peer's notify_connect callback can be called * before. + * + * @param tth transport testing handle * @param p1 peer 1 * @param p2 peer 2 * @param cb the callback to call when both peers notified that they are connected @@ -195,12 +202,15 @@ GNUNET_TRANSPORT_TESTING_connect_peers (struct GNUNET_TRANSPORT_TESTING_handle /** * Cancel the request to connect two peers * Tou MUST cancel the request if you stop the peers before the peers connected succesfully + * @param tth testing * @param cc a connect request handle */ void GNUNET_TRANSPORT_TESTING_connect_peers_cancel (struct GNUNET_TRANSPORT_TESTING_handle - *, void *cc); + *tth, + GNUNET_TRANSPORT_TESTING_ConnectRequest + ccr); /** * Clean up the transport testing @@ -231,12 +241,13 @@ GNUNET_TRANSPORT_TESTING_get_test_name (const char *file, char **dest); /** * This function takes the filename (e.g. argv[0), removes a "lt-"-prefix and * if existing ".exe"-prefix and adds the peer-number + * * @param file filename of the test, e.g. argv[0] - * @param cfgname where to write the result + * @param dest where to write the filename * @param count peer number */ void -GNUNET_TRANSPORT_TESTING_get_config_name (const char *file, char **cfgname, +GNUNET_TRANSPORT_TESTING_get_config_name (const char *file, char **dest, int count); -- cgit v1.2.3