Commenting the "aggregator" CMD

This commit is contained in:
Marcello Stanisci 2018-05-26 10:46:45 +02:00
parent 199bca5e03
commit a53e825714
No known key found for this signature in database
GPG Key ID: 8D526861953F4C0F

View File

@ -30,31 +30,30 @@
#include "taler_testing_lib.h"
/**
* State for a "aggregator" CMD.
*/
struct AggregatorState
{
/**
* Process for the aggregator.
* Aggregator process.
*/
struct GNUNET_OS_Process *aggregator_proc;
/**
* Which configuration file should we pass to the process?
* Configuration file used by the aggregator.
*/
const char *config_filename;
};
/**
* Runs the command. Note that upon return, the interpreter
* will not automatically run the next command, as the command
* may continue asynchronously in other scheduler tasks. Thus,
* the command must ensure to eventually call
* #TALER_TESTING_interpreter_next() or
* #TALER_TESTING_interpreter_fail().
* Run the command. Use the `taler-exchange-aggregator' program.
*
* @param is interpreter state
* @param cls closure.
* @param cmd command being run.
* @param is interpreter state.
*/
static void
aggregator_run (void *cls,
@ -83,10 +82,11 @@ aggregator_run (void *cls,
/**
* Clean up after the command. Run during forced termination
* (CTRL-C) or test failure or test success.
* Free the state of a "aggregator" CMD, and possibly kill its
* process if it did not terminate correctly.
*
* @param cls closure
* @param cls closure.
* @param cmd the command being freed.
*/
static void
aggregator_cleanup (void *cls,
@ -108,15 +108,15 @@ aggregator_cleanup (void *cls,
/**
* Extract information from a command that is useful for other
* commands.
* Offer "aggregator" CMD internal data to other commands.
*
* @param cls closure
* @param ret[out] result (could be anything)
* @param trait name of the trait
* @param cls closure.
* @param ret[out] result (could be anything).
* @param trait name of the trait.
* @param selector more detailed information about which object
* to return in case there were multiple generated
* by the command
* by the command.
*
* @return #GNUNET_OK on success
*/
static int
@ -139,8 +139,13 @@ aggregator_traits (void *cls,
/**
* Execute taler-exchange-wirewatch process.
* Make a "aggregator" CMD.
*
* @param label command label.
* @param config_filename configuration file for the
* aggregator to use.
*
* @return the command.
*/
struct TALER_TESTING_Command
TALER_TESTING_cmd_exec_aggregator (const char *label,