Commenting the "reserve status" CMD.

This commit is contained in:
Marcello Stanisci 2018-05-28 13:45:19 +02:00
parent 26be8717c5
commit 25ca8f90ad
No known key found for this signature in database
GPG Key ID: 8D526861953F4C0F

View File

@ -27,6 +27,10 @@
#include "exchange_api_handle.h" #include "exchange_api_handle.h"
#include "taler_testing_lib.h" #include "taler_testing_lib.h"
/**
* State for a "status" CMD.
*/
struct StatusState struct StatusState
{ {
/** /**
@ -36,7 +40,7 @@ struct StatusState
const char *reserve_reference; const char *reserve_reference;
/** /**
* Handle to a /reserve/status operation. * Handle to the "reserve status" operation.
*/ */
struct TALER_EXCHANGE_ReserveStatusHandle *rsh; struct TALER_EXCHANGE_ReserveStatusHandle *rsh;
@ -51,7 +55,7 @@ struct StatusState
unsigned int expected_response_code; unsigned int expected_response_code;
/** /**
* Handle to the exchange. * Connection handle to the exchange.
*/ */
struct TALER_EXCHANGE_Handle *exchange; struct TALER_EXCHANGE_Handle *exchange;
@ -63,19 +67,16 @@ struct StatusState
/** /**
* Check exchange returned expected values. * Check that the reserve balance and HTTP response code are
* both acceptable.
* *
* @param cls closure * @param cls closure.
* @param http_status HTTP response code, #MHD_HTTP_OK (200) for * @param http_status HTTP response code.
* successful status request 0 if the exchange's reply is * @param ec taler-specific error code.
* bogus (fails to follow the protocol) * @param balance current balance in the reserve, NULL on error.
* @param ec taler-specific error code, #TALER_EC_NONE on success
* @param[in] json original response in JSON format (useful only
* for diagnostics)
* @param balance current balance in the reserve, NULL on error
* @param history_length number of entries in the transaction * @param history_length number of entries in the transaction
* history, 0 on error * history, 0 on error.
* @param history detailed transaction history, NULL on error * @param history detailed transaction history, NULL on error.
*/ */
static void static void
reserve_status_cb reserve_status_cb
@ -136,9 +137,9 @@ reserve_status_cb
/** /**
* Run the command. * Run the command.
* *
* @param cls closure, typically a #struct WireState. * @param cls closure.
* @param cmd the command to execute, a /wire one. * @param cmd the command being executed.
* @param i the interpreter state. * @param is the interpreter state.
*/ */
static void static void
status_run (void *cls, status_run (void *cls,
@ -185,9 +186,10 @@ status_run (void *cls,
/** /**
* Cleanup the state. * Cleanup the state from a "reserve status" CMD, and possibly
* cancel a pending operation thereof.
* *
* @param cls closure, typically a #struct WireState. * @param cls closure.
* @param cmd the command which is being cleaned up. * @param cmd the command which is being cleaned up.
*/ */
static void static void
@ -210,15 +212,15 @@ status_cleanup (void *cls,
/** /**
* Create a /reserve/status command. * Create a "reserve status" command.
* *
* @param label the command label. * @param label the command label.
* @param exchange the exchange to connect to. * @param exchange the exchange to connect to.
* @param reserve_reference reference to the reserve to check. * @param reserve_reference reference to the reserve to check.
* @param expected_balance balance expected to be at the referenced reserve. * @param expected_balance expected balance for the reserve.
* @param expected_response_code expected HTTP response code. * @param expected_response_code expected HTTP response code.
* *
* @return the command to be executed by the interpreter. * @return the command.
*/ */
struct TALER_TESTING_Command struct TALER_TESTING_Command
TALER_TESTING_cmd_status (const char *label, TALER_TESTING_cmd_status (const char *label,