merchant

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

lookup_pending_webhooks.h (3914B)


      1 /*
      2    This file is part of TALER
      3    Copyright (C) 2023 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_pending_webhooks.h
     18  * @brief implementation of the lookup_pending_webhooks function for Postgres
     19  * @author Iván Ávalos
     20  */
     21 #ifndef MERCHANT_DATABASE_LOOKUP_PENDING_WEBHOOKS_H
     22 #define MERCHANT_DATABASE_LOOKUP_PENDING_WEBHOOKS_H
     23 
     24 #include <taler/taler_util.h>
     25 #include <taler/taler_json_lib.h>
     26 #include "merchantdb_lib.h"
     27 
     28 
     29 struct TALER_MERCHANTDB_PostgresContext;
     30 /* Callback typedefs */
     31 /**
     32  * Typically called by `lookup_pending_webhooks`.
     33  *
     34  * @param cls a `json_t *` JSON array to build
     35  * @param webhook_pending_serial reference to the configured webhook template.
     36  * @param next_attempt is the time we should make the next request to the webhook.
     37  * @param retries how often have we tried this request to the webhook.
     38  * @param url to make request to
     39  * @param http_method use for the webhook
     40  * @param header of the webhook
     41  * @param body of the webhook
     42  */
     43 typedef void
     44 (*TALER_MERCHANTDB_PendingWebhooksCallback)(
     45   void *cls,
     46   uint64_t webhook_pending_serial,
     47   struct GNUNET_TIME_Absolute
     48   next_attempt,
     49   uint32_t retries,
     50   const char *url,
     51   const char *http_method,
     52   const char *header,
     53   const char *body);
     54 
     55 /**
     56  * Lookup the webhook that need to be send in priority.
     57  * send.
     58  *
     59  * @param pg database context
     60  * @param cb pending webhook callback
     61  * @param cb_cls callback closure
     62  */
     63 // WHERE next_attempt <= now ORDER BY next_attempt ASC
     64 enum GNUNET_DB_QueryStatus
     65 TALER_MERCHANTDB_lookup_pending_webhooks (struct TALER_MERCHANTDB_PostgresContext *pg,
     66                                           TALER_MERCHANTDB_PendingWebhooksCallback cb,
     67                                           void *cb_cls);
     68 
     69 
     70 /**
     71  * Lookup future webhook in the pending webhook that need to be send.
     72  * With that we can know how long the system can 'sleep'.
     73  *
     74  * @param pg database context
     75  * @param cb pending webhook callback
     76  * @param cb_cls callback closure
     77  */
     78 // ORDER BY next_attempt ASC LIMIT 1
     79 enum GNUNET_DB_QueryStatus
     80 TALER_MERCHANTDB_lookup_future_webhook (struct TALER_MERCHANTDB_PostgresContext *pg,
     81                                         TALER_MERCHANTDB_PendingWebhooksCallback cb,
     82                                         void *cb_cls);
     83 
     84 
     85 /**
     86    * Lookup all the webhooks in the pending webhook.
     87    * Use by the administrator
     88    *
     89    * @param pg database context
     90    * @param instance_id to lookup webhooks for this instance particularly
     91    * @param min_row to see the list of the pending webhook that it is started with this minimum row.
     92    * @param max_results to see the list of the pending webhook that it is end with this max results.
     93    * @param cb pending webhook callback
     94    * @param cb_cls callback closure
     95    */
     96 // WHERE webhook_pending_serial > min_row ORDER BY webhook_pending_serial ASC LIMIT max_results
     97 enum GNUNET_DB_QueryStatus
     98 TALER_MERCHANTDB_lookup_all_webhooks (struct TALER_MERCHANTDB_PostgresContext *pg,
     99                                       const char *instance_id,
    100                                       uint64_t min_row,
    101                                       uint32_t max_results,
    102                                       TALER_MERCHANTDB_PendingWebhooksCallback cb,
    103                                       void *cb_cls);
    104 
    105 #endif