iterate_fountains.h (2173B)
1 /* 2 This file is part of TALER 3 Copyright (C) 2026 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/iterate_fountains.h 18 * @brief implementation of the iterate_fountains function for Postgres 19 * @author Bohdan Potuzhnyi 20 */ 21 #ifndef MERCHANT_DATABASE_ITERATE_FOUNTAINS_H 22 #define MERCHANT_DATABASE_ITERATE_FOUNTAINS_H 23 24 #include <taler/taler_util.h> 25 #include "merchantdb_lib.h" 26 27 28 struct TALER_MERCHANTDB_PostgresContext; 29 30 /** 31 * Typically called by `iterate_fountains`. 32 * 33 * @param cls a `json_t *` JSON array to build 34 * @param fountain_serial serial number used as pagination cursor 35 * @param fountain_id public identifier of the fountain 36 * @param description description of the fountain 37 */ 38 typedef void 39 (*TALER_MERCHANTDB_FountainsCallback)( 40 void *cls, 41 uint64_t fountain_serial, 42 const char *fountain_id, 43 const char *description); 44 45 46 /** 47 * Iterate over a page of fountains of an instance, ordered by serial. 48 * At most 100 entries are returned. 49 * 50 * @param pg database context 51 * @param instance_id instance to iterate fountains of 52 * @param offset exclusive serial cursor (at most INT64_MAX) 53 * @param limit signed page size; negative selects descending order 54 * @param cb function to call with each fountain 55 * @param cb_cls closure for @a cb 56 * @return database result code 57 */ 58 enum GNUNET_DB_QueryStatus 59 TALER_MERCHANTDB_iterate_fountains ( 60 struct TALER_MERCHANTDB_PostgresContext *pg, 61 const char *instance_id, 62 uint64_t offset, 63 int64_t limit, 64 TALER_MERCHANTDB_FountainsCallback cb, 65 void *cb_cls); 66 67 #endif