exchange/src/exchange-lib/exchange_api_handle.h

72 lines
2.0 KiB
C
Raw Normal View History

/*
This file is part of TALER
2016-01-19 14:39:00 +01:00
Copyright (C) 2014, 2015 GNUnet e.V.
TALER is free software; you can redistribute it and/or modify it under the
terms of the GNU General Public License as published by the Free Software
Foundation; either version 3, or (at your option) any later version.
TALER is distributed in the hope that it will be useful, but WITHOUT ANY
WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
A PARTICULAR PURPOSE. See the GNU General Public License for more details.
You should have received a copy of the GNU General Public License along with
2016-07-07 17:55:25 +02:00
TALER; see the file COPYING. If not, see
<http://www.gnu.org/licenses/>
*/
/**
2016-03-01 15:35:04 +01:00
* @file exchange-lib/exchange_api_handle.h
* @brief Internal interface to the handle part of the exchange's HTTP API
* @author Christian Grothoff
*/
#include "platform.h"
#include <gnunet/gnunet_curl_lib.h>
2016-03-01 15:35:04 +01:00
#include "taler_exchange_service.h"
/**
2016-03-01 15:35:04 +01:00
* Get the context of a exchange.
*
2016-03-01 15:35:04 +01:00
* @param h the exchange handle to query
* @return ctx context to execute jobs in
*/
struct GNUNET_CURL_Context *
2016-03-01 15:35:04 +01:00
MAH_handle_to_context (struct TALER_EXCHANGE_Handle *h);
/**
* Check if the handle is ready to process requests.
*
2016-03-01 15:35:04 +01:00
* @param h the exchange handle to query
* @return #GNUNET_YES if we are ready, #GNUNET_NO if not
*/
int
2016-03-01 15:35:04 +01:00
MAH_handle_is_ready (struct TALER_EXCHANGE_Handle *h);
/**
* Obtain the URL to use for an API request.
*
2016-03-01 15:35:04 +01:00
* @param h the exchange handle to query
2015-09-19 22:08:49 +02:00
* @param path Taler API path (i.e. "/reserve/withdraw")
2018-01-30 01:38:04 +01:00
* @return the full URL to use with cURL
*/
char *
2016-03-01 15:35:04 +01:00
MAH_path_to_url (struct TALER_EXCHANGE_Handle *h,
const char *path);
2017-04-20 07:49:56 +02:00
2016-06-13 16:36:10 +02:00
/**
* Obtain the URL to use for an API request.
*
* @param base_url base URL of the exchange (i.e. "http://exchange/")
* @param path Taler API path (i.e. "/reserve/withdraw")
2018-01-30 01:38:04 +01:00
* @return the full URL to use with cURL
2016-06-13 16:36:10 +02:00
*/
char *
MAH_path_to_url2 (const char *base_url,
const char *path);
2016-03-01 15:35:04 +01:00
/* end of exchange_api_handle.h */