merchant

Merchant backend to process payments, run by merchants
Log | Files | Refs | Submodules | README | LICENSE

lookup_statistics_counter_by_interval.h (2589B)


      1 /*
      2    This file is part of TALER
      3    Copyright (C) 2025 Taler Systems SA
      4 
      5    TALER is free software; you can redistribute it and/or modify it under the
      6    terms of the GNU General Public License as published by the Free Software
      7    Foundation; either version 3, or (at your option) any later version.
      8 
      9    TALER is distributed in the hope that it will be useful, but WITHOUT ANY
     10    WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
     11    A PARTICULAR PURPOSE.  See the GNU General Public License for more details.
     12 
     13    You should have received a copy of the GNU General Public License along with
     14    TALER; see the file COPYING.  If not, see <http://www.gnu.org/licenses/>
     15  */
     16 /**
     17  * @file src/include/merchant-database/lookup_statistics_counter_by_interval.h
     18  * @brief implementation of the lookup_statistics_by_interval function for Postgres
     19  * @author Martin Schanzenbach
     20  */
     21 #ifndef MERCHANT_DATABASE_LOOKUP_STATISTICS_COUNTER_BY_INTERVAL_H
     22 #define MERCHANT_DATABASE_LOOKUP_STATISTICS_COUNTER_BY_INTERVAL_H
     23 
     24 #include <taler/taler_util.h>
     25 #include <taler/taler_json_lib.h>
     26 #include "merchantdb_lib.h"
     27 
     28 
     29 /**
     30  * Details about a statistic with counter.
     31  */
     32 struct TALER_MERCHANTDB_StatisticsCounterByIntervalDetails
     33 {
     34   /**
     35    * Start time of the interval.
     36    * The interval always ends at the response generation time.
     37    */
     38   struct GNUNET_TIME_Timestamp start_time;
     39 
     40   /**
     41    * Sum of all counters falling under the given
     42    * SLUG within this timeframe
     43    */
     44   uint64_t cumulative_counter;
     45 };
     46 
     47 
     48 /**
     49  * Function returning integer-valued statistics for a time interval.
     50  * Called by `lookup_statistics_counter_by_interval`.
     51  *
     52  * @param cls closure
     53  * @param description description of the statistic
     54  * @param interval_start start time of the interval
     55  * @param cumulative_counter counter value
     56  */
     57 typedef void
     58 (*TALER_MERCHANTDB_CounterByIntervalStatisticsCallback)(
     59   void *cls,
     60   const char *description,
     61   struct GNUNET_TIME_Timestamp interval_start,
     62   uint64_t cumulative_counter);
     63 
     64 /**
     65  * Lookup statistics where the values are counters.
     66  *
     67  * @param pg database context
     68  * @param instance_id instance to lookup statistics for
     69  * @param slug slug to lookup statistics for
     70  * @param cb function to call on all statistics found
     71  * @param cb_cls closure for @a cb
     72  * @return database result code
     73  */
     74 enum GNUNET_DB_QueryStatus
     75 TALER_MERCHANTDB_lookup_statistics_counter_by_interval (
     76   struct TALER_MERCHANTDB_PostgresContext *pg,
     77   const char *instance_id,
     78   const char *slug,
     79   TALER_MERCHANTDB_CounterByIntervalStatisticsCallback cb,
     80   void *cb_cls);
     81 
     82 #endif