gnunet_curl_lib.h

Go to the documentation of this file.

/*
   This file is part of GNUnet
   Copyright (C) 2014, 2015, 2016 GNUnet e.V.
 
   GNUnet is free software: you can redistribute it and/or modify it
   under the terms of the GNU Affero General Public License as published
   by the Free Software Foundation, either version 3 of the License,
   or (at your option) any later version.
 
   GNUnet 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
   Affero General Public License for more details.
 
   You should have received a copy of the GNU Affero General Public License
   along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
     SPDX-License-Identifier: AGPL3.0-or-later
 */
#ifndef GNUNET_CURL_LIB_H
#define GNUNET_CURL_LIB_H
 
#include <curl/curl.h>
#include "gnunet_util_lib.h"
 
 
typedef void
(*GNUNET_CURL_RescheduleCallback)(void *cls);
 
struct GNUNET_CURL_DownloadBuffer
{
  void *buf;
 
  size_t buf_size;
 
  int eno;
};
 
 
typedef void *
(*GNUNET_CURL_RawParser) (struct GNUNET_CURL_DownloadBuffer *db,
                          CURL *eh,
                          long *response_code);
 
typedef void
(*GNUNET_CURL_ResponseCleaner) (void *response);
 
struct GNUNET_CURL_Context *
GNUNET_CURL_init (GNUNET_CURL_RescheduleCallback cb,
                  void *cb_cls);
 
 
void
GNUNET_CURL_get_select_info (struct GNUNET_CURL_Context *ctx,
                             fd_set *read_fd_set,
                             fd_set *write_fd_set,
                             fd_set *except_fd_set,
                             int *max_fd,
                             long *timeout);
 
 
enum GNUNET_GenericReturnValue
GNUNET_CURL_append_header (struct GNUNET_CURL_Context *ctx,
                           const char *header);
 
void
GNUNET_CURL_perform (struct GNUNET_CURL_Context *ctx);
 
 
void
GNUNET_CURL_perform2 (struct GNUNET_CURL_Context *ctx,
                      GNUNET_CURL_RawParser rp,
                      GNUNET_CURL_ResponseCleaner rc);
 
void
GNUNET_CURL_fini (struct GNUNET_CURL_Context *ctx);
 
 
struct GNUNET_CURL_Job;
 
typedef void
(*GNUNET_CURL_JobCompletionCallback)(void *cls,
                                     long response_code,
                                     const void *response);
 
 
typedef void
(*GNUNET_CURL_RawJobCompletionCallback)(void *cls,
                                        long response_code,
                                        const void *body,
                                        size_t body_size);
 
 
typedef enum GNUNET_GenericReturnValue
(*GNUNET_CURL_StreamHeaderCallback)(void *cls,
                                    const char *line,
                                    size_t line_size);
 
 
#define GNUNET_CURL_STREAM_PAUSE CURL_WRITEFUNC_PAUSE
 
 
typedef size_t
(*GNUNET_CURL_StreamCallback)(void *cls,
                              const void *data,
                              size_t data_size);
 
 
struct GNUNET_CURL_StreamHandlers
{
  GNUNET_CURL_StreamHeaderCallback hcb;
 
  void *hcb_cls;
 
  GNUNET_CURL_StreamCallback scb;
 
  void *scb_cls;
 
  GNUNET_CURL_RawJobCompletionCallback jcc;
 
  void *jcc_cls;
};
 
 
struct GNUNET_CURL_Job *
GNUNET_CURL_job_add_stream (struct GNUNET_CURL_Context *ctx,
                            CURL *eh,
                            const struct curl_slist *job_headers,
                            const struct GNUNET_CURL_StreamHandlers *sh);
 
 
void
GNUNET_CURL_job_set_paused (struct GNUNET_CURL_Job *job,
                            bool recv_paused,
                            bool send_paused);
 
 
struct GNUNET_CURL_Job *
GNUNET_CURL_job_add (struct GNUNET_CURL_Context *ctx,
                     CURL *eh,
                     GNUNET_CURL_JobCompletionCallback jcc,
                     void *jcc_cls);
 
 
struct GNUNET_CURL_Job *
GNUNET_CURL_job_add_with_ct_json (struct GNUNET_CURL_Context *ctx,
                                  CURL *eh,
                                  GNUNET_CURL_JobCompletionCallback jcc,
                                  void *jcc_cls);
 
 
void
GNUNET_CURL_set_userpass (struct GNUNET_CURL_Context *ctx,
                          const char *userpass);
 
 
void
GNUNET_CURL_set_tlscert (struct GNUNET_CURL_Context *ctx,
                         const char *certtype,
                         const char *certfile,
                         const char *keyfile,
                         const char *keypass);
 
 
struct GNUNET_CURL_Job *
GNUNET_CURL_job_add2 (struct GNUNET_CURL_Context *ctx,
                      CURL *eh,
                      const struct curl_slist *job_headers,
                      GNUNET_CURL_JobCompletionCallback jcc,
                      void *jcc_cls);
 
 
struct GNUNET_CURL_Job *
GNUNET_CURL_job_add_raw (struct GNUNET_CURL_Context *ctx,
                         CURL *eh,
                         const struct curl_slist *job_headers,
                         GNUNET_CURL_RawJobCompletionCallback jcc,
                         void *jcc_cls);
 
 
void
GNUNET_CURL_extend_headers (struct GNUNET_CURL_Job *job,
                            const struct curl_slist *extra_headers);
 
 
void
GNUNET_CURL_job_cancel (struct GNUNET_CURL_Job *job);
 
 
/* ******* GNUnet SCHEDULER integration ************ */
 
 
struct GNUNET_CURL_RescheduleContext;
 
 
struct GNUNET_CURL_RescheduleContext *
GNUNET_CURL_gnunet_rc_create (struct GNUNET_CURL_Context *ctx);
 
struct GNUNET_CURL_RescheduleContext *
GNUNET_CURL_gnunet_rc_create_with_parser (struct GNUNET_CURL_Context *ctx,
                                          GNUNET_CURL_RawParser rp,
                                          GNUNET_CURL_ResponseCleaner rc);
 
 
void
GNUNET_CURL_gnunet_rc_destroy (struct GNUNET_CURL_RescheduleContext *rc);
 
 
void
GNUNET_CURL_gnunet_scheduler_reschedule (void *cls);
 
 
void
GNUNET_CURL_enable_async_scope_header (struct GNUNET_CURL_Context *ctx,
                                       const char *header_name);
 
 
enum GNUNET_GenericReturnValue
GNUNET_CURL_is_valid_scope_id (const char *scope_id);
 
 
#endif
 
 
/* end of gnunet_curl_lib.h */