GNUnet  0.19.2
gnunet_curl_lib.h
Go to the documentation of this file.
1 /*
2  This file is part of GNUnet
3  Copyright (C) 2014, 2015, 2016 GNUnet e.V.
4 
5  GNUnet is free software: you can redistribute it and/or modify it
6  under the terms of the GNU Affero General Public License as published
7  by the Free Software Foundation, either version 3 of the License,
8  or (at your option) any later version.
9 
10  GNUnet is distributed in the hope that it will be useful, but
11  WITHOUT ANY WARRANTY; without even the implied warranty of
12  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13  Affero General Public License for more details.
14 
15  You should have received a copy of the GNU Affero General Public License
16  along with this program. If not, see <http://www.gnu.org/licenses/>.
17 
18  SPDX-License-Identifier: AGPL3.0-or-later
19  */
33 #ifndef GNUNET_CURL_LIB_H
34 #define GNUNET_CURL_LIB_H
35 
36 #include <curl/curl.h>
37 #include "gnunet_util_lib.h"
38 
39 
48 typedef void
49 (*GNUNET_CURL_RescheduleCallback)(void *cls);
50 
56 {
60  void *buf;
61 
65  size_t buf_size;
66 
71  int eno;
72 };
73 
74 
83 typedef void *
84 (*GNUNET_CURL_RawParser) (struct GNUNET_CURL_DownloadBuffer *db,
85  CURL *eh,
86  long *response_code);
87 
93 typedef void
95 
104 struct GNUNET_CURL_Context *
106  void *cb_cls);
107 
108 
135 void
137  fd_set *read_fd_set,
138  fd_set *write_fd_set,
139  fd_set *except_fd_set,
140  int *max_fd,
141  long *timeout);
142 
143 
153  const char *header);
154 
160 void
162 
163 
172 void
176 
184 void
186 
187 
191 struct GNUNET_CURL_Job;
192 
200 typedef void
202  long response_code,
203  const void *response);
204 
205 
214 typedef void
216  long response_code,
217  const void *body,
218  size_t body_size);
219 
220 
233 struct GNUNET_CURL_Job *
235  CURL *eh,
237  void *jcc_cls);
238 
239 
255 struct GNUNET_CURL_Job *
257  CURL *eh,
259  void *jcc_cls);
260 
261 
270 void
272  const char *userpass);
273 
274 
289 void
291  const char *certtype,
292  const char *certfile,
293  const char *keyfile,
294  const char *keypass);
295 
296 
313 struct GNUNET_CURL_Job *
315  CURL *eh,
316  const struct curl_slist *job_headers,
318  void *jcc_cls);
319 
320 
335 struct GNUNET_CURL_Job *
337  CURL *eh,
338  const struct curl_slist *job_headers,
340  void *jcc_cls);
341 
342 
349 void
351  const struct curl_slist *extra_headers);
352 
353 
360 void
362 
363 
364 /* ******* GNUnet SCHEDULER integration ************ */
365 
366 
371 
372 
381 
392 
393 
399 void
401 
402 
412 void
414 
415 
422 void
424  const char *header_name);
425 
426 
436 int
437 GNUNET_CURL_is_valid_scope_id (const char *scope_id);
438 
439 
440 #endif /* end of group */
442  /* end of group addition to lib_extra */
444 
445 /* end of gnunet_curl_lib.h */
static struct GNUNET_TIME_Relative timeout
Desired timeout for the lookup (default is no timeout).
Definition: gnunet-abd.c:61
static struct GNUNET_SCHEDULER_Task * job
Task for main job.
Definition: gnunet-cadet.c:137
static struct MHD_Response * response
Our canonical response.
static char * rp
Relying party.
static struct GNUNET_FS_DirectoryBuilder * db
Definition: gnunet-search.c:97
static struct GNUNET_DNSSTUB_Context * ctx
Context for DNS resolution.
void GNUNET_CURL_set_tlscert(struct GNUNET_CURL_Context *ctx, const char *certtype, const char *certfile, const char *keyfile, const char *keypass)
Force use of the provided TLS client certificate for client authentication for all operations perform...
Definition: curl.c:219
void GNUNET_CURL_gnunet_scheduler_reschedule(void *cls)
Implementation of the GNUNET_CURL_RescheduleCallback for GNUnet's scheduler.
void(* GNUNET_CURL_RawJobCompletionCallback)(void *cls, long response_code, const void *body, size_t body_size)
Function to call upon completion of a raw job.
void(* GNUNET_CURL_JobCompletionCallback)(void *cls, long response_code, const void *response)
Function to call upon completion of a job.
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)
Obtain the information for a select() call to wait until GNUNET_CURL_perform() is ready again.
Definition: curl.c:795
void GNUNET_CURL_fini(struct GNUNET_CURL_Context *ctx)
Cleanup library initialisation resources.
Definition: curl.c:828
void(* GNUNET_CURL_ResponseCleaner)(void *response)
Deallocate the response.
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)
Schedule a CURL request to be executed and call the given jcc upon its completion.
Definition: curl.c:503
void GNUNET_CURL_extend_headers(struct GNUNET_CURL_Job *job, const struct curl_slist *extra_headers)
Add extra_headers to the HTTP headers for job.
Definition: curl.c:461
struct GNUNET_CURL_Job * GNUNET_CURL_job_add(struct GNUNET_CURL_Context *ctx, CURL *eh, GNUNET_CURL_JobCompletionCallback jcc, void *jcc_cls)
Schedule a CURL request to be executed and call the given jcc upon its completion.
Definition: curl.c:576
struct GNUNET_CURL_Context * GNUNET_CURL_init(GNUNET_CURL_RescheduleCallback cb, void *cb_cls)
Initialise this library.
Definition: curl.c:241
void GNUNET_CURL_perform2(struct GNUNET_CURL_Context *ctx, GNUNET_CURL_RawParser rp, GNUNET_CURL_ResponseCleaner rc)
Run the main event loop for the HTTP interaction.
Definition: curl.c:732
void GNUNET_CURL_job_cancel(struct GNUNET_CURL_Job *job)
Cancel a job.
Definition: curl.c:590
void GNUNET_CURL_perform(struct GNUNET_CURL_Context *ctx)
Run the main event loop for the CURL interaction.
Definition: curl.c:786
struct GNUNET_CURL_RescheduleContext * GNUNET_CURL_gnunet_rc_create(struct GNUNET_CURL_Context *ctx)
Initialize reschedule context.
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)
Schedule a CURL request to be executed and call the given jcc upon its completion.
Definition: curl.c:554
void GNUNET_CURL_set_userpass(struct GNUNET_CURL_Context *ctx, const char *userpass)
Force use of the provided username and password for client authentication for all operations performe...
Definition: curl.c:209
int GNUNET_CURL_is_valid_scope_id(const char *scope_id)
Return GNUNET_YES if given a valid scope ID and GNUNET_NO otherwise.
Definition: curl.c:284
struct GNUNET_CURL_RescheduleContext * GNUNET_CURL_gnunet_rc_create_with_parser(struct GNUNET_CURL_Context *ctx, GNUNET_CURL_RawParser rp, GNUNET_CURL_ResponseCleaner rc)
Initialize reschedule context; with custom response parser.
void *(* GNUNET_CURL_RawParser)(struct GNUNET_CURL_DownloadBuffer *db, CURL *eh, long *response_code)
Parses the raw response we got from the Web server.
enum GNUNET_GenericReturnValue GNUNET_CURL_append_header(struct GNUNET_CURL_Context *ctx, const char *header)
Add custom request header.
Definition: curl.c:719
void(* GNUNET_CURL_RescheduleCallback)(void *cls)
Function called by the context to ask for the event loop to be rescheduled, that is the application s...
void GNUNET_CURL_gnunet_rc_destroy(struct GNUNET_CURL_RescheduleContext *rc)
Destroy reschedule context.
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)
Schedule a CURL request to be executed and call the given jcc upon its completion.
Definition: curl.c:479
void GNUNET_CURL_enable_async_scope_header(struct GNUNET_CURL_Context *ctx, const char *header_name)
Enable sending the async scope ID as a header.
Definition: curl.c:276
GNUNET_GenericReturnValue
Named constants for return values.
Context.
Definition: curl.c:135
void * cb_cls
Closure for cb.
Definition: curl.c:176
GNUNET_CURL_RescheduleCallback cb
Function we need to call whenever the event loop's socket set changed.
Definition: curl.c:171
Buffer data structure we use to buffer the HTTP download before giving it to the JSON parser.
void * buf
Download buffer.
size_t buf_size
The size of the download buffer.
int eno
Error code (based on libc errno) if we failed to download (e.g.
Jobs are CURL requests running within a struct GNUNET_CURL_Context.
Definition: curl.c:77
struct curl_slist * job_headers
Headers used for this job, the list needs to be freed after the job has finished.
Definition: curl.c:127
GNUNET_CURL_JobCompletionCallback jcc
Function to call upon completion.
Definition: curl.c:101
void * jcc_cls
Closure for jcc.
Definition: curl.c:106
Closure for GNUNET_CURL_gnunet_scheduler_reschedule().