GNUnet  0.10.x
Data Structures | Typedefs | Functions
CURL integration library

Download JSON using libcurl. More...

Data Structures

struct  GNUNET_CURL_DownloadBuffer
 Buffer data structure we use to buffer the HTTP download before giving it to the JSON parser. More...
 

Typedefs

typedef void(* GNUNET_CURL_RescheduleCallback) (void *cls)
 Function called by the context to ask for the event loop to be rescheduled, that is the application should call GNUNET_CURL_get_select_info() as the set of sockets we care about just changed. More...
 
typedef void *(* GNUNET_CURL_RawParser) (struct GNUNET_CURL_DownloadBuffer *db, CURL *eh, long *response_code)
 Parses the raw response we got from the Web server. More...
 
typedef void(* GNUNET_CURL_ResponseCleaner) (void *response)
 Deallocate the response. More...
 
typedef void(* GNUNET_CURL_JobCompletionCallback) (void *cls, long response_code, const void *response)
 Function to call upon completion of a job. More...
 

Functions

struct GNUNET_CURL_ContextGNUNET_CURL_init (GNUNET_CURL_RescheduleCallback cb, void *cb_cls)
 Initialise this library. More...
 
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. More...
 
int GNUNET_CURL_append_header (struct GNUNET_CURL_Context *ctx, const char *header)
 Add custom request header. More...
 
void GNUNET_CURL_perform (struct GNUNET_CURL_Context *ctx)
 Run the main event loop for the CURL interaction. More...
 
void GNUNET_CURL_perform2 (struct GNUNET_CURL_Context *ctx, GNUNET_CURL_RawParser rp, GNUNET_CURL_ResponseCleaner rc)
 Run the main event loop for the Taler interaction. More...
 
void GNUNET_CURL_fini (struct GNUNET_CURL_Context *ctx)
 Cleanup library initialisation resources. More...
 
struct GNUNET_CURL_JobGNUNET_CURL_job_add (struct GNUNET_CURL_Context *ctx, CURL *eh, int add_json, GNUNET_CURL_JobCompletionCallback jcc, void *jcc_cls)
 Schedule a CURL request to be executed and call the given jcc upon its completion. More...
 
struct GNUNET_CURL_JobGNUNET_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. More...
 
void GNUNET_CURL_job_cancel (struct GNUNET_CURL_Job *job)
 Cancel a job. More...
 
struct GNUNET_CURL_RescheduleContextGNUNET_CURL_gnunet_rc_create (struct GNUNET_CURL_Context *ctx)
 Initialize reschedule context. More...
 
struct GNUNET_CURL_RescheduleContextGNUNET_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. More...
 
void GNUNET_CURL_gnunet_rc_destroy (struct GNUNET_CURL_RescheduleContext *rc)
 Destroy reschedule context. More...
 
void GNUNET_CURL_gnunet_scheduler_reschedule (void *cls)
 Implementation of the GNUNET_CURL_RescheduleCallback for GNUnet's scheduler. More...
 
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. More...
 

Detailed Description

Download JSON using libcurl.

Typedef Documentation

◆ GNUNET_CURL_RescheduleCallback

typedef void(* GNUNET_CURL_RescheduleCallback) (void *cls)

Function called by the context to ask for the event loop to be rescheduled, that is the application should call GNUNET_CURL_get_select_info() as the set of sockets we care about just changed.

Parameters
clsclosure

Definition at line 51 of file gnunet_curl_lib.h.

◆ GNUNET_CURL_RawParser

typedef void*(* GNUNET_CURL_RawParser) (struct GNUNET_CURL_DownloadBuffer *db, CURL *eh, long *response_code)

Parses the raw response we got from the Web server.

Parameters
dbthe raw data
ehhandle
response_codeHTTP response code
Returns
the parsed object

Definition at line 88 of file gnunet_curl_lib.h.

◆ GNUNET_CURL_ResponseCleaner

typedef void(* GNUNET_CURL_ResponseCleaner) (void *response)

Deallocate the response.

Parameters
responseobject to clean

Definition at line 98 of file gnunet_curl_lib.h.

◆ GNUNET_CURL_JobCompletionCallback

typedef void(* GNUNET_CURL_JobCompletionCallback) (void *cls, long response_code, const void *response)

Function to call upon completion of a job.

Parameters
clsclosure
response_codeHTTP response code from server, 0 on hard error
jsonresponse, NULL if response was not in JSON format

Definition at line 205 of file gnunet_curl_lib.h.

Function Documentation

◆ GNUNET_CURL_init()

struct GNUNET_CURL_Context* GNUNET_CURL_init ( GNUNET_CURL_RescheduleCallback  cb,
void *  cb_cls 
)

Initialise this library.

This function should be called before using any of the following functions.

Parameters
cbfunction to call when rescheduling is required
cb_clsclosure for cb
Returns
library context

Definition at line 175 of file curl.c.

References GNUNET_CURL_Context::cb, GNUNET_CURL_Context::cb_cls, GNUNET_CURL_Job::ctx, curl_fail, GNUNET_ERROR_TYPE_ERROR, GNUNET_log, GNUNET_new, GNUNET_CURL_Context::multi, multi, and GNUNET_CURL_Context::share.

176 {
177  struct GNUNET_CURL_Context *ctx;
178  CURLM *multi;
179  CURLSH *share;
180 
181  if (curl_fail)
182  {
183  GNUNET_log (GNUNET_ERROR_TYPE_ERROR, "Curl was not initialised properly\n");
184  return NULL;
185  }
186  if (NULL == (multi = curl_multi_init ()))
187  {
189  "Failed to create a Curl multi handle\n");
190  return NULL;
191  }
192  if (NULL == (share = curl_share_init ()))
193  {
195  "Failed to create a Curl share handle\n");
196  return NULL;
197  }
198  ctx = GNUNET_new (struct GNUNET_CURL_Context);
199  ctx->cb = cb;
200  ctx->cb_cls = cb_cls;
201  ctx->multi = multi;
202  ctx->share = share;
203  return ctx;
204 }
#define GNUNET_new(type)
Allocate a struct or union of the given type.
GNUNET_CURL_RescheduleCallback cb
Function we need to call whenever the event loop's socket set changed.
Definition: curl.c:157
static struct GNUNET_DNSSTUB_Context * ctx
Context for DNS resolution.
static CURLM * multi
Current multi-CURL handle.
CURLSH * share
Curl share handle.
Definition: curl.c:130
static int curl_fail
Failsafe flag.
Definition: curl.c:66
Context.
Definition: curl.c:120
CURLM * multi
Curl multi handle.
Definition: curl.c:125
void * cb_cls
Closure for cb.
Definition: curl.c:162
#define GNUNET_log(kind,...)

◆ GNUNET_CURL_get_select_info()

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.

Basically, a client should use this API to prepare for select(), then block on select(), then call GNUNET_CURL_perform() and then start again until the work with the context is done.

This function will NOT zero out the sets and assumes that max_fd and timeout are already set to minimal applicable values. It is safe to give this API FD-sets and max_fd and timeout that are already initialized to some other descriptors that need to go into the select() call.

Parameters
ctxcontext to get the event loop information for
read_fd_setwill be set for any pending read operations
write_fd_setwill be set for any pending write operations
except_fd_setis here because curl_multi_fdset() has this argument
max_fdset to the highest FD included in any set; if the existing sets have no FDs in it, the initial value should be "-1". (Note that max_fd + 1 will need to be passed to select().)
timeoutset to the timeout in milliseconds (!); -1 means no timeout (NULL, blocking forever is OK), 0 means to proceed immediately with GNUNET_CURL_perform().

Note that calling any other GNUNET_CURL-API may also imply that the library is again ready for GNUNET_CURL_perform().

Basically, a client should use this API to prepare for select(), then block on select(), then call GNUNET_CURL_perform() and then start again until the work with the context is done.

This function will NOT zero out the sets and assumes that max_fd and timeout are already set to minimal applicable values. It is safe to give this API FD-sets and max_fd and timeout that are already initialized to some other descriptors that need to go into the select() call.

Parameters
ctxcontext to get the event loop information for
read_fd_setwill be set for any pending read operations
write_fd_setwill be set for any pending write operations
except_fd_setis here because curl_multi_fdset() has this argument
max_fdset to the highest FD included in any set; if the existing sets have no FDs in it, the initial value should be "-1". (Note that max_fd + 1 will need to be passed to select().)
timeoutset to the timeout in milliseconds (!); -1 means no timeout (NULL, blocking forever is OK), 0 means to proceed immediately with GNUNET_CURL_perform().

Definition at line 659 of file curl.c.

References GNUNET_assert, GNUNET_MAX, GNUNET_CURL_Context::jobs_head, m, GNUNET_CURL_Context::multi, and timeout.

Referenced by context_task().

665 {
666  long to;
667  int m;
668 
669  m = -1;
670  GNUNET_assert (CURLM_OK == curl_multi_fdset (ctx->multi,
671  read_fd_set,
672  write_fd_set,
673  except_fd_set,
674  &m));
675  to = *timeout;
676  *max_fd = GNUNET_MAX (m, *max_fd);
677  GNUNET_assert (CURLM_OK == curl_multi_timeout (ctx->multi, &to));
678 
679  /* Only if what we got back from curl is smaller than what we
680  already had (-1 == infinity!), then update timeout */
681  if ((to < *timeout) && (-1 != to))
682  *timeout = to;
683  if ((-1 == (*timeout)) && (NULL != ctx->jobs_head))
684  *timeout = to;
685 }
#define GNUNET_assert(cond)
Use this for fatal errors that cannot be handled.
static struct GNUNET_ARM_MonitorHandle * m
Monitor connection with ARM.
Definition: gnunet-arm.c:99
static struct GNUNET_TIME_Relative timeout
User defined timestamp for completing operations.
Definition: gnunet-arm.c:114
struct GNUNET_CURL_Job * jobs_head
We keep jobs in a DLL.
Definition: curl.c:135
#define GNUNET_MAX(a, b)
Definition: gnunet_common.h:85
CURLM * multi
Curl multi handle.
Definition: curl.c:125
Here is the caller graph for this function:

◆ GNUNET_CURL_append_header()

int GNUNET_CURL_append_header ( struct GNUNET_CURL_Context ctx,
const char *  header 
)

Add custom request header.

Parameters
ctxcURL context.
headerheader string; will be given to the context AS IS.
Returns
GNUNET_OK if no errors occurred, GNUNET_SYSERR otherwise.

Definition at line 502 of file curl.c.

References GNUNET_CURL_Context::common_headers, GNUNET_OK, and GNUNET_SYSERR.

503 {
504  ctx->common_headers = curl_slist_append (ctx->common_headers, header);
505  if (NULL == ctx->common_headers)
506  return GNUNET_SYSERR;
507 
508  return GNUNET_OK;
509 }
#define GNUNET_OK
Named constants for return values.
Definition: gnunet_common.h:78
#define GNUNET_SYSERR
Definition: gnunet_common.h:79
struct curl_slist * common_headers
Headers common for all requests in the context.
Definition: curl.c:145

◆ GNUNET_CURL_perform()

void GNUNET_CURL_perform ( struct GNUNET_CURL_Context ctx)

Run the main event loop for the CURL interaction.

Parameters
ctxthe library context

Run the main event loop for the CURL interaction.

Parameters
ctxthe library context

Definition at line 622 of file curl.c.

References GNUNET_CURL_download_get_result_(), and GNUNET_CURL_perform2().

623 {
626  (GNUNET_CURL_ResponseCleaner) &json_decref);
627 }
void(* GNUNET_CURL_ResponseCleaner)(void *response)
Deallocate the response.
void GNUNET_CURL_perform2(struct GNUNET_CURL_Context *ctx, GNUNET_CURL_RawParser rp, GNUNET_CURL_ResponseCleaner rc)
Run the main event loop for the Taler interaction.
Definition: curl.c:521
void * GNUNET_CURL_download_get_result_(struct GNUNET_CURL_DownloadBuffer *db, CURL *eh, long *response_code)
Obtain information about the final result about the HTTP download.
Definition: curl.c:434
Here is the call graph for this function:

◆ GNUNET_CURL_perform2()

void GNUNET_CURL_perform2 ( struct GNUNET_CURL_Context ctx,
GNUNET_CURL_RawParser  rp,
GNUNET_CURL_ResponseCleaner  rc 
)

Run the main event loop for the Taler interaction.

Parameters
ctxthe library context
rpparses the raw response returned from the Web server.
rccleans/frees the response

Definition at line 521 of file curl.c.

References UrlRequestData::bytes_received, UrlRequestData::bytes_sent, UrlRequestData::count, get_url_benchmark_data(), GNUNET_assert, GNUNET_break, GNUNET_CURL_job_cancel(), GNUNET_TIME_relative_add(), GNUNET_TIME_relative_max(), job, GNUNET_CURL_Context::multi, GNUNET_TIME_Relative::rel_value_us, response, rp, UrlRequestData::time, and UrlRequestData::time_max.

Referenced by context_task(), and GNUNET_CURL_perform().

524 {
525  CURLMsg *cmsg;
526  int n_running;
527  int n_completed;
528 
529  (void) curl_multi_perform (ctx->multi, &n_running);
530  while (NULL != (cmsg = curl_multi_info_read (ctx->multi, &n_completed)))
531  {
532  struct GNUNET_CURL_Job *job;
533  long response_code;
534  void *response;
535 
536  /* Only documented return value is CURLMSG_DONE */
537  GNUNET_break (CURLMSG_DONE == cmsg->msg);
538  GNUNET_assert (CURLE_OK == curl_easy_getinfo (cmsg->easy_handle,
539  CURLINFO_PRIVATE,
540  (char **) &job));
541  GNUNET_assert (job->ctx == ctx);
542  response_code = 0;
543  response = rp (&job->db, job->easy_handle, &response_code);
544 #if ENABLE_BENCHMARK
545  {
546  char *url = NULL;
547  double total_as_double = 0;
548  struct GNUNET_TIME_Relative total;
549  struct UrlRequestData *urd;
550  /* Some care required, as curl is using data types (long vs curl_off_t vs
551  * double) inconsistently to store byte count. */
552  curl_off_t size_curl = 0;
553  long size_long = 0;
554  uint64_t bytes_sent = 0;
555  uint64_t bytes_received = 0;
556 
557  GNUNET_break (CURLE_OK == curl_easy_getinfo (cmsg->easy_handle,
558  CURLINFO_TOTAL_TIME,
559  &total_as_double));
560  total.rel_value_us = total_as_double * 1000 * 1000;
561 
562  GNUNET_break (CURLE_OK == curl_easy_getinfo (cmsg->easy_handle,
563  CURLINFO_EFFECTIVE_URL,
564  &url));
565 
566  /* HEADER_SIZE + SIZE_DOWNLOAD_T is hopefully the total
567  number of bytes received, not clear from curl docs. */
568 
569  GNUNET_break (CURLE_OK == curl_easy_getinfo (cmsg->easy_handle,
570  CURLINFO_HEADER_SIZE,
571  &size_long));
572  bytes_received += size_long;
573 
574  GNUNET_break (CURLE_OK == curl_easy_getinfo (cmsg->easy_handle,
575  CURLINFO_SIZE_DOWNLOAD_T,
576  &size_curl));
577  bytes_received += size_curl;
578 
579  /* REQUEST_SIZE + SIZE_UPLOAD_T is hopefully the total number of bytes
580  sent, again docs are not completely clear. */
581 
582  GNUNET_break (CURLE_OK == curl_easy_getinfo (cmsg->easy_handle,
583  CURLINFO_REQUEST_SIZE,
584  &size_long));
585  bytes_sent += size_long;
586 
587  /* We obtain this value to check an invariant, but never use it otherwise. */
588  GNUNET_break (CURLE_OK == curl_easy_getinfo (cmsg->easy_handle,
589  CURLINFO_SIZE_UPLOAD_T,
590  &size_curl));
591 
592  /* CURLINFO_SIZE_UPLOAD_T <= CURLINFO_REQUEST_SIZE should
593  be an invariant.
594  As verified with
595  curl -w "foo%{size_request} -XPOST --data "ABC" $URL
596  the CURLINFO_REQUEST_SIZE should be the whole size of the request
597  including headers and body.
598  */
599  GNUNET_break (size_curl <= size_long);
600 
601  urd = get_url_benchmark_data (url, (unsigned int) response_code);
602  urd->count++;
603  urd->time = GNUNET_TIME_relative_add (urd->time, total);
604  urd->time_max = GNUNET_TIME_relative_max (total, urd->time_max);
605  urd->bytes_sent += bytes_sent;
607  }
608 #endif
609  job->jcc (job->jcc_cls, response_code, response);
610  rc (response);
612  }
613 }
struct GNUNET_TIME_Relative GNUNET_TIME_relative_max(struct GNUNET_TIME_Relative t1, struct GNUNET_TIME_Relative t2)
Return the maximum of two relative time values.
Definition: time.c:286
#define GNUNET_assert(cond)
Use this for fatal errors that cannot be handled.
Struct for benchmark data for one URL.
Definition: benchmark.h:61
struct GNUNET_TIME_Relative time_max
Slowest time to response.
Definition: benchmark.h:96
void GNUNET_CURL_job_cancel(struct GNUNET_CURL_Job *job)
Cancel a job.
Definition: curl.c:401
#define GNUNET_break(cond)
Use this for internal assertion violations that are not fatal (can be handled) but should not occur...
uint64_t count
How often was the URL requested?
Definition: benchmark.h:76
void * jcc_cls
Closure for jcc.
Definition: curl.c:102
GNUNET_CURL_JobCompletionCallback jcc
Function to call upon completion.
Definition: curl.c:97
uint64_t bytes_sent
How many bytes were sent in total to request the URL.
Definition: benchmark.h:81
struct GNUNET_TIME_Relative time
Total time spent requesting this URL.
Definition: benchmark.h:91
CURLM * multi
Curl multi handle.
Definition: curl.c:125
uint64_t bytes_received
How many bytes were received in total as response to requesting this URL.
Definition: benchmark.h:86
CURL * easy_handle
Easy handle of the job.
Definition: curl.c:87
static struct GNUNET_SCHEDULER_Task * job
Task for main job.
Definition: gnunet-cadet.c:137
struct GNUNET_TIME_Relative GNUNET_TIME_relative_add(struct GNUNET_TIME_Relative a1, struct GNUNET_TIME_Relative a2)
Add relative times together.
Definition: time.c:576
Jobs are CURL requests running within a struct GNUNET_CURL_Context.
Definition: curl.c:71
static char * rp
Relying party.
static struct MHD_Response * response
Our canonical response.
struct GNUNET_CURL_DownloadBuffer db
Buffer for response received from CURL.
Definition: curl.c:107
struct UrlRequestData * get_url_benchmark_data(char *url, unsigned int status)
Get benchmark data for a URL.
Definition: benchmark.c:236
struct GNUNET_CURL_Context * ctx
Context this job runs in.
Definition: curl.c:92
Time for relative time used by GNUnet, in microseconds.
Here is the call graph for this function:
Here is the caller graph for this function:

◆ GNUNET_CURL_fini()

void GNUNET_CURL_fini ( struct GNUNET_CURL_Context ctx)

Cleanup library initialisation resources.

This function should be called after using this library to cleanup the resources occupied during library's initialisation.

Parameters
ctxthe library context

Definition at line 696 of file curl.c.

References GNUNET_CURL_Context::common_headers, GNUNET_assert, GNUNET_free, GNUNET_CURL_Context::jobs_head, GNUNET_CURL_Context::multi, and GNUNET_CURL_Context::share.

697 {
698  /* all jobs must have been cancelled at this time, assert this */
699  GNUNET_assert (NULL == ctx->jobs_head);
700  curl_share_cleanup (ctx->share);
701  curl_multi_cleanup (ctx->multi);
702  curl_slist_free_all (ctx->common_headers);
703  GNUNET_free (ctx);
704 }
#define GNUNET_assert(cond)
Use this for fatal errors that cannot be handled.
struct GNUNET_CURL_Job * jobs_head
We keep jobs in a DLL.
Definition: curl.c:135
CURLSH * share
Curl share handle.
Definition: curl.c:130
CURLM * multi
Curl multi handle.
Definition: curl.c:125
#define GNUNET_free(ptr)
Wrapper around free.
struct curl_slist * common_headers
Headers common for all requests in the context.
Definition: curl.c:145

◆ GNUNET_CURL_job_add()

struct GNUNET_CURL_Job* GNUNET_CURL_job_add ( struct GNUNET_CURL_Context ctx,
CURL *  eh,
int  add_json,
GNUNET_CURL_JobCompletionCallback  jcc,
void *  jcc_cls 
)

Schedule a CURL request to be executed and call the given jcc upon its completion.

Note that the context will make use of the CURLOPT_PRIVATE facility of the CURL eh.

This function modifies the CURL handle to add the "Content-Type: application/json" header if add_json is set.

Parameters
ctxcontext to execute the job in
ehcurl easy handle for the request, will be executed AND cleaned up
add_jsonadd "application/json" content type header
jcccallback to invoke upon completion
jcc_clsclosure for jcc
Returns
NULL on error (in this case, is still released!)

Definition at line 372 of file curl.c.

References GNUNET_assert, GNUNET_CURL_job_add2(), GNUNET_YES, job, and GNUNET_CURL_Job::job_headers.

377 {
378  struct GNUNET_CURL_Job *job;
379  struct curl_slist *job_headers = NULL;
380 
381  if (GNUNET_YES == add_json)
382  {
383  GNUNET_assert (
384  NULL != (job_headers =
385  curl_slist_append (NULL, "Content-Type: application/json")));
386  }
387 
388  job = GNUNET_CURL_job_add2 (ctx, eh, job_headers, jcc, jcc_cls);
389  curl_slist_free_all (job_headers);
390  return job;
391 }
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:280
#define GNUNET_assert(cond)
Use this for fatal errors that cannot be handled.
static struct GNUNET_SCHEDULER_Task * job
Task for main job.
Definition: gnunet-cadet.c:137
Jobs are CURL requests running within a struct GNUNET_CURL_Context.
Definition: curl.c:71
#define GNUNET_YES
Definition: gnunet_common.h:80
Here is the call graph for this function:

◆ GNUNET_CURL_job_add2()

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.

Note that the context will make use of the CURLOPT_PRIVATE facility of the CURL eh.

This function modifies the CURL handle to add the "Content-Type: application/json" header if add_json is set.

Parameters
ctxcontext to execute the job in
ehcurl easy handle for the request, will be executed AND cleaned up
job_headersextra headers to add for this request
jcccallback to invoke upon completion
jcc_clsclosure for jcc
Returns
NULL on error (in this case, is still released!)

Note that the context will make use of the CURLOPT_PRIVATE facility of the CURL eh.

This function modifies the CURL handle to add the "Content-Type: application/json" header if add_json is set.

Parameters
ctxcontext to execute the job in
ehcurl easy handle for the request, will be executed AND cleaned up. NOTE: the handle should never have gotten any headers list, as that would then be ovverridden by jcc. Therefore, always pass custom headers as the job_headers parameter.
job_headersextra headers to add for this request
jcccallback to invoke upon completion
jcc_clsclosure for jcc
Returns
NULL on error (in this case, is still released!)

Definition at line 280 of file curl.c.

References GNUNET_CURL_Context::async_scope_id_header, GNUNET_CURL_Context::cb, GNUNET_CURL_Context::cb_cls, GNUNET_CURL_Context::common_headers, GNUNET_CURL_Job::ctx, GNUNET_CURL_Job::db, download_cb(), GNUNET_CURL_Job::easy_handle, GNUNET_assert, GNUNET_async_scope_get(), GNUNET_break, GNUNET_CONTAINER_DLL_insert, GNUNET_free, GNUNET_new, GNUNET_STRINGS_data_to_string_alloc(), GNUNET_YES, GNUNET_AsyncScopeSave::have_scope, GNUNET_CURL_Job::jcc, GNUNET_CURL_Job::jcc_cls, job, GNUNET_CURL_Job::job_headers, GNUNET_CURL_Context::jobs_head, GNUNET_CURL_Context::jobs_tail, GNUNET_CURL_Context::multi, GNUNET_AsyncScopeSave::scope_id, and GNUNET_CURL_Context::share.

Referenced by GNUNET_CURL_job_add().

285 {
286  struct GNUNET_CURL_Job *job;
287  struct curl_slist *all_headers = NULL;
288 
289  for (const struct curl_slist *curr = job_headers; curr != NULL;
290  curr = curr->next)
291  {
292  GNUNET_assert (NULL !=
293  (all_headers = curl_slist_append (all_headers, curr->data)));
294  }
295 
296  for (const struct curl_slist *curr = ctx->common_headers; curr != NULL;
297  curr = curr->next)
298  {
299  GNUNET_assert (NULL !=
300  (all_headers = curl_slist_append (all_headers, curr->data)));
301  }
302 
303  if (NULL != ctx->async_scope_id_header)
304  {
306 
308  if (GNUNET_YES == scope.have_scope)
309  {
310  char *aid_header = NULL;
311  aid_header =
313  sizeof (
314  struct GNUNET_AsyncScopeId));
315  GNUNET_assert (NULL != aid_header);
316  GNUNET_assert (NULL != curl_slist_append (all_headers, aid_header));
317  GNUNET_free (aid_header);
318  }
319  }
320 
321  if (CURLE_OK != curl_easy_setopt (eh, CURLOPT_HTTPHEADER, all_headers))
322  {
323  GNUNET_break (0);
324  curl_slist_free_all (all_headers);
325  curl_easy_cleanup (eh);
326  return NULL;
327  }
328 
329  job = GNUNET_new (struct GNUNET_CURL_Job);
330  job->job_headers = all_headers;
331 
332  if ((CURLE_OK != curl_easy_setopt (eh, CURLOPT_PRIVATE, job)) ||
333  (CURLE_OK !=
334  curl_easy_setopt (eh, CURLOPT_WRITEFUNCTION, &download_cb)) ||
335  (CURLE_OK != curl_easy_setopt (eh, CURLOPT_WRITEDATA, &job->db)) ||
336  (CURLE_OK != curl_easy_setopt (eh, CURLOPT_SHARE, ctx->share)) ||
337  (CURLM_OK != curl_multi_add_handle (ctx->multi, eh)))
338  {
339  GNUNET_break (0);
340  GNUNET_free (job);
341  curl_easy_cleanup (eh);
342  return NULL;
343  }
344 
345  job->easy_handle = eh;
346  job->ctx = ctx;
347  job->jcc = jcc;
348  job->jcc_cls = jcc_cls;
350  ctx->cb (ctx->cb_cls);
351  return job;
352 }
#define GNUNET_CONTAINER_DLL_insert(head, tail, element)
Insert an element at the head of a DLL.
#define GNUNET_assert(cond)
Use this for fatal errors that cannot be handled.
#define GNUNET_new(type)
Allocate a struct or union of the given type.
Identifier for an asynchronous execution context.
GNUNET_CURL_RescheduleCallback cb
Function we need to call whenever the event loop&#39;s socket set changed.
Definition: curl.c:157
#define GNUNET_break(cond)
Use this for internal assertion violations that are not fatal (can be handled) but should not occur...
static struct GNUNET_DNSSTUB_Context * ctx
Context for DNS resolution.
void * jcc_cls
Closure for jcc.
Definition: curl.c:102
GNUNET_CURL_JobCompletionCallback jcc
Function to call upon completion.
Definition: curl.c:97
struct GNUNET_CURL_Job * jobs_head
We keep jobs in a DLL.
Definition: curl.c:135
static enum GNUNET_NetworkType scope
Which network scope do we belong to?
CURLSH * share
Curl share handle.
Definition: curl.c:130
void GNUNET_async_scope_get(struct GNUNET_AsyncScopeSave *scope_ret)
Get the current async scope.
CURLM * multi
Curl multi handle.
Definition: curl.c:125
Saved async scope identifier or root scope.
CURL * easy_handle
Easy handle of the job.
Definition: curl.c:87
static struct GNUNET_SCHEDULER_Task * job
Task for main job.
Definition: gnunet-cadet.c:137
void * cb_cls
Closure for cb.
Definition: curl.c:162
Jobs are CURL requests running within a struct GNUNET_CURL_Context.
Definition: curl.c:71
const char * async_scope_id_header
If non-NULL, the async scope ID is sent in a request header of this name.
Definition: curl.c:151
struct GNUNET_CURL_Job * jobs_tail
We keep jobs in a DLL.
Definition: curl.c:140
#define GNUNET_YES
Definition: gnunet_common.h:80
struct GNUNET_CURL_DownloadBuffer db
Buffer for response received from CURL.
Definition: curl.c:107
char * GNUNET_STRINGS_data_to_string_alloc(const void *buf, size_t size)
Return the base32crockford encoding of the given buffer.
Definition: strings.c:988
struct curl_slist * job_headers
Headers used for this job, the list needs to be freed after the job has finished. ...
Definition: curl.c:113
#define GNUNET_free(ptr)
Wrapper around free.
struct GNUNET_CURL_Context * ctx
Context this job runs in.
Definition: curl.c:92
struct curl_slist * common_headers
Headers common for all requests in the context.
Definition: curl.c:145
static size_t download_cb(char *bufptr, size_t size, size_t nitems, void *cls)
Callback used when downloading the reply to an HTTP request.
Definition: curl.c:235
Here is the call graph for this function:
Here is the caller graph for this function:

◆ GNUNET_CURL_job_cancel()

void GNUNET_CURL_job_cancel ( struct GNUNET_CURL_Job job)

Cancel a job.

Must only be called before the job completion callback is called for the respective job.

Parameters
jobjob to cancel

Definition at line 401 of file curl.c.

References GNUNET_CURL_DownloadBuffer::buf, GNUNET_CURL_Job::ctx, GNUNET_CURL_Job::db, GNUNET_CURL_Job::easy_handle, GNUNET_break, GNUNET_CONTAINER_DLL_remove, GNUNET_free, GNUNET_free_non_null, GNUNET_CURL_Job::job_headers, GNUNET_CURL_Context::jobs_head, GNUNET_CURL_Context::jobs_tail, and GNUNET_CURL_Context::multi.

Referenced by GNUNET_CURL_perform2().

402 {
403  struct GNUNET_CURL_Context *ctx = job->ctx;
404 
406  GNUNET_break (CURLM_OK ==
407  curl_multi_remove_handle (ctx->multi, job->easy_handle));
408  curl_easy_cleanup (job->easy_handle);
409  GNUNET_free_non_null (job->db.buf);
410  curl_slist_free_all (job->job_headers);
411  GNUNET_free (job);
412 }
#define GNUNET_CONTAINER_DLL_remove(head, tail, element)
Remove an element from a DLL.
#define GNUNET_free_non_null(ptr)
Free the memory pointed to by ptr if ptr is not NULL.
#define GNUNET_break(cond)
Use this for internal assertion violations that are not fatal (can be handled) but should not occur...
static struct GNUNET_DNSSTUB_Context * ctx
Context for DNS resolution.
struct GNUNET_CURL_Job * jobs_head
We keep jobs in a DLL.
Definition: curl.c:135
Context.
Definition: curl.c:120
CURLM * multi
Curl multi handle.
Definition: curl.c:125
CURL * easy_handle
Easy handle of the job.
Definition: curl.c:87
void * buf
Download buffer.
struct GNUNET_CURL_Job * jobs_tail
We keep jobs in a DLL.
Definition: curl.c:140
struct GNUNET_CURL_DownloadBuffer db
Buffer for response received from CURL.
Definition: curl.c:107
struct curl_slist * job_headers
Headers used for this job, the list needs to be freed after the job has finished. ...
Definition: curl.c:113
#define GNUNET_free(ptr)
Wrapper around free.
struct GNUNET_CURL_Context * ctx
Context this job runs in.
Definition: curl.c:92
Here is the caller graph for this function:

◆ GNUNET_CURL_gnunet_rc_create()

struct GNUNET_CURL_RescheduleContext* GNUNET_CURL_gnunet_rc_create ( struct GNUNET_CURL_Context ctx)

Initialize reschedule context.

Parameters
ctxcontext to manage
Returns
closure for GNUNET_CURL_gnunet_scheduler_reschedule().

Definition at line 102 of file curl_reschedule.c.

References clean_result(), GNUNET_CURL_RescheduleContext::cleaner, GNUNET_CURL_RescheduleContext::ctx, GNUNET_CURL_download_get_result_(), GNUNET_new, and GNUNET_CURL_RescheduleContext::parser.

103 {
105 
107  rc->ctx = ctx;
109  rc->cleaner = &clean_result;
110  return rc;
111 }
struct GNUNET_CURL_Context * ctx
Context we manage.
#define GNUNET_new(type)
Allocate a struct or union of the given type.
GNUNET_CURL_ResponseCleaner cleaner
Deallocate the response object.
GNUNET_CURL_RawParser parser
Parser of the raw response.
static struct GNUNET_DNSSTUB_Context * ctx
Context for DNS resolution.
Closure for GNUNET_CURL_gnunet_scheduler_reschedule().
static void clean_result(void *response)
Just a wrapper to avoid casting of function pointers.
void * GNUNET_CURL_download_get_result_(struct GNUNET_CURL_DownloadBuffer *db, CURL *eh, long *response_code)
Obtain information about the final result about the HTTP download.
Definition: curl.c:434
Here is the call graph for this function:

◆ GNUNET_CURL_gnunet_rc_create_with_parser()

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.

Parameters
ctxcontext to manage
Returns
closure for GNUNET_CURL_gnunet_scheduler_reschedule().

Definition at line 69 of file curl_reschedule.c.

References GNUNET_CURL_RescheduleContext::cleaner, GNUNET_CURL_RescheduleContext::ctx, GNUNET_new, GNUNET_CURL_RescheduleContext::parser, and rp.

72 {
73  struct GNUNET_CURL_RescheduleContext *rctx;
74 
76  rctx->ctx = ctx;
77  rctx->parser = rp;
78  rctx->cleaner = rc;
79 
80  return rctx;
81 }
struct GNUNET_CURL_Context * ctx
Context we manage.
#define GNUNET_new(type)
Allocate a struct or union of the given type.
GNUNET_CURL_ResponseCleaner cleaner
Deallocate the response object.
GNUNET_CURL_RawParser parser
Parser of the raw response.
static struct GNUNET_DNSSTUB_Context * ctx
Context for DNS resolution.
Closure for GNUNET_CURL_gnunet_scheduler_reschedule().
static char * rp
Relying party.

◆ GNUNET_CURL_gnunet_rc_destroy()

void GNUNET_CURL_gnunet_rc_destroy ( struct GNUNET_CURL_RescheduleContext rc)

Destroy reschedule context.

Parameters
rccontext to destroy

Definition at line 120 of file curl_reschedule.c.

References GNUNET_free, GNUNET_SCHEDULER_cancel(), and GNUNET_CURL_RescheduleContext::task.

121 {
122  if (NULL != rc->task)
124  GNUNET_free (rc);
125 }
struct GNUNET_SCHEDULER_Task * task
Just the task.
#define GNUNET_free(ptr)
Wrapper around free.
void * GNUNET_SCHEDULER_cancel(struct GNUNET_SCHEDULER_Task *task)
Cancel the task with the specified identifier.
Definition: scheduler.c:965
Here is the call graph for this function:

◆ GNUNET_CURL_gnunet_scheduler_reschedule()

void GNUNET_CURL_gnunet_scheduler_reschedule ( void *  cls)

Implementation of the GNUNET_CURL_RescheduleCallback for GNUnet's scheduler.

Will run the CURL context using GNUnet's scheduler. Note that you MUST immediately destroy the reschedule context after calling GNUNET_CURL_fini().

Parameters
clsmust point to a struct GNUNET_CURL_RescheduleContext * (pointer to a pointer!)

Definition at line 191 of file curl_reschedule.c.

References context_task(), GNUNET_SCHEDULER_add_now(), GNUNET_SCHEDULER_cancel(), and GNUNET_CURL_RescheduleContext::task.

192 {
193  struct GNUNET_CURL_RescheduleContext *rc = *(void **) cls;
194 
195  if (NULL != rc->task)
198 }
Closure for GNUNET_CURL_gnunet_scheduler_reschedule().
struct GNUNET_SCHEDULER_Task * GNUNET_SCHEDULER_add_now(GNUNET_SCHEDULER_TaskCallback task, void *task_cls)
Schedule a new task to be run as soon as possible.
Definition: scheduler.c:1273
struct GNUNET_SCHEDULER_Task * task
Just the task.
static void context_task(void *cls)
Task that runs the context&#39;s event loop with the GNUnet scheduler.
void * GNUNET_SCHEDULER_cancel(struct GNUNET_SCHEDULER_Task *task)
Cancel the task with the specified identifier.
Definition: scheduler.c:965
Here is the call graph for this function:

◆ GNUNET_CURL_enable_async_scope_header()

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.

Parameters
ctxthe context to enable this for
header_namename of the header to send.

Definition at line 214 of file curl.c.

References GNUNET_CURL_Context::async_scope_id_header.

216 {
217  ctx->async_scope_id_header = header_name;
218 }
const char * async_scope_id_header
If non-NULL, the async scope ID is sent in a request header of this name.
Definition: curl.c:151