GNUnet  0.11.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...
 
typedef 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. 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 HTTP 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...
 
struct GNUNET_CURL_JobGNUNET_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. 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 86 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 96 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
responsein JSON, NULL if response was not in JSON format

Definition at line 203 of file gnunet_curl_lib.h.

◆ GNUNET_CURL_RawJobCompletionCallback

typedef 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.

Parameters
clsclosure
response_codeHTTP response code from server, 0 on hard error
bodyhttp body of the response
body_sizenumber of bytes in body

Definition at line 217 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 184 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.

185 {
186  struct GNUNET_CURL_Context *ctx;
187  CURLM *multi;
188  CURLSH *share;
189 
190  if (curl_fail)
191  {
192  GNUNET_log (GNUNET_ERROR_TYPE_ERROR, "Curl was not initialised properly\n");
193  return NULL;
194  }
195  if (NULL == (multi = curl_multi_init ()))
196  {
198  "Failed to create a Curl multi handle\n");
199  return NULL;
200  }
201  if (NULL == (share = curl_share_init ()))
202  {
204  "Failed to create a Curl share handle\n");
205  return NULL;
206  }
207  ctx = GNUNET_new (struct GNUNET_CURL_Context);
208  ctx->cb = cb;
209  ctx->cb_cls = cb_cls;
210  ctx->multi = multi;
211  ctx->share = share;
212  return ctx;
213 }
#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:166
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:139
static int curl_fail
Failsafe flag.
Definition: curl.c:66
Context.
Definition: curl.c:129
CURLM * multi
Curl multi handle.
Definition: curl.c:134
void * cb_cls
Closure for cb.
Definition: curl.c:171
#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 790 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().

796 {
797  long to;
798  int m;
799 
800  m = -1;
801  GNUNET_assert (CURLM_OK == curl_multi_fdset (ctx->multi,
802  read_fd_set,
803  write_fd_set,
804  except_fd_set,
805  &m));
806  to = *timeout;
807  *max_fd = GNUNET_MAX (m, *max_fd);
808  GNUNET_assert (CURLM_OK == curl_multi_timeout (ctx->multi, &to));
809 
810  /* Only if what we got back from curl is smaller than what we
811  already had (-1 == infinity!), then update timeout */
812  if ((to < *timeout) && (-1 != to))
813  *timeout = to;
814  if ((-1 == (*timeout)) && (NULL != ctx->jobs_head))
815  *timeout = to;
816 }
#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:104
struct GNUNET_CURL_Job * jobs_head
We keep jobs in a DLL.
Definition: curl.c:144
static struct GNUNET_TIME_Relative timeout
Desired timeout for the lookup (default is no timeout).
Definition: gnunet-abd.c:61
#define GNUNET_MAX(a, b)
Definition: gnunet_common.h:90
CURLM * multi
Curl multi handle.
Definition: curl.c:134
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 604 of file curl.c.

References UrlRequestData::bytes_received, UrlRequestData::bytes_sent, GNUNET_CURL_Context::common_headers, UrlRequestData::count, get_url_benchmark_data(), GNUNET_break, GNUNET_OK, GNUNET_SYSERR, GNUNET_TIME_relative_add(), GNUNET_TIME_relative_max(), GNUNET_TIME_Relative::rel_value_us, UrlRequestData::time, and UrlRequestData::time_max.

605 {
606  ctx->common_headers = curl_slist_append (ctx->common_headers, header);
607  if (NULL == ctx->common_headers)
608  return GNUNET_SYSERR;
609 
610  return GNUNET_OK;
611 }
#define GNUNET_OK
Named constants for return values.
Definition: gnunet_common.h:83
#define GNUNET_SYSERR
Definition: gnunet_common.h:84
struct curl_slist * common_headers
Headers common for all requests in the context.
Definition: curl.c:154
Here is the call graph for this function:

◆ 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 753 of file curl.c.

References GNUNET_CURL_download_get_result_(), and GNUNET_CURL_perform2().

754 {
757  (GNUNET_CURL_ResponseCleaner) & json_decref);
758 }
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 HTTP interaction.
Definition: curl.c:693
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:525
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 HTTP interaction.

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

Definition at line 693 of file curl.c.

References GNUNET_assert, GNUNET_break, GNUNET_CURL_job_cancel(), job, GNUNET_CURL_Context::multi, response, and rp.

Referenced by context_task(), and GNUNET_CURL_perform().

696 {
697  CURLMsg *cmsg;
698  int n_running;
699  int n_completed;
700 
701  (void) curl_multi_perform (ctx->multi,
702  &n_running);
703  while (NULL != (cmsg = curl_multi_info_read (ctx->multi, &n_completed)))
704  {
705  struct GNUNET_CURL_Job *job;
706  long response_code;
707  void *response;
708 
709  /* Only documented return value is CURLMSG_DONE */
710  GNUNET_break (CURLMSG_DONE == cmsg->msg);
711  GNUNET_assert (CURLE_OK == curl_easy_getinfo (cmsg->easy_handle,
712  CURLINFO_PRIVATE,
713  (char **) &job));
714  GNUNET_assert (job->ctx == ctx);
715  response_code = 0;
716  if (NULL != job->jcc_raw)
717  {
718  /* RAW mode, no parsing */
719  GNUNET_break (CURLE_OK ==
720  curl_easy_getinfo (job->easy_handle,
721  CURLINFO_RESPONSE_CODE,
722  &response_code));
723  job->jcc_raw (job->jcc_raw_cls,
724  response_code,
725  job->db.buf,
726  job->db.buf_size);
727  }
728  else
729  {
730  /* to be parsed via 'rp' */
731  response = rp (&job->db,
732  job->easy_handle,
733  &response_code);
734  job->jcc (job->jcc_cls,
735  response_code,
736  response);
737  rc (response);
738  }
739 #if ENABLE_BENCHMARK
740  do_benchmark (cmsg);
741 #endif
743  }
744 }
#define GNUNET_assert(cond)
Use this for fatal errors that cannot be handled.
void GNUNET_CURL_job_cancel(struct GNUNET_CURL_Job *job)
Cancel a job.
Definition: curl.c:491
#define GNUNET_break(cond)
Use this for internal assertion violations that are not fatal (can be handled) but should not occur...
void * jcc_cls
Closure for jcc.
Definition: curl.c:101
GNUNET_CURL_JobCompletionCallback jcc
Function to call upon completion.
Definition: curl.c:96
GNUNET_CURL_RawJobCompletionCallback jcc_raw
Function to call upon completion.
Definition: curl.c:106
CURLM * multi
Curl multi handle.
Definition: curl.c:134
CURL * easy_handle
Easy handle of the job.
Definition: curl.c:86
static struct GNUNET_SCHEDULER_Task * job
Task for main job.
Definition: gnunet-cadet.c:137
void * buf
Download buffer.
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:116
size_t buf_size
The size of the download buffer.
void * jcc_raw_cls
Closure for jcc_raw.
Definition: curl.c:111
struct GNUNET_CURL_Context * ctx
Context this job runs in.
Definition: curl.c:91
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 827 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.

828 {
829  /* all jobs must have been cancelled at this time, assert this */
830  GNUNET_assert (NULL == ctx->jobs_head);
831  curl_share_cleanup (ctx->share);
832  curl_multi_cleanup (ctx->multi);
833  curl_slist_free_all (ctx->common_headers);
834  GNUNET_free (ctx);
835 }
#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:144
CURLSH * share
Curl share handle.
Definition: curl.c:139
CURLM * multi
Curl multi handle.
Definition: curl.c:134
#define GNUNET_free(ptr)
Wrapper around free.
struct curl_slist * common_headers
Headers common for all requests in the context.
Definition: curl.c:154

◆ 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 462 of file curl.c.

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

467 {
468  struct GNUNET_CURL_Job *job;
469  struct curl_slist *job_headers = NULL;
470 
471  if (GNUNET_YES == add_json)
472  {
473  GNUNET_assert (
474  NULL != (job_headers =
475  curl_slist_append (NULL, "Content-Type: application/json")));
476  }
477 
478  job = GNUNET_CURL_job_add2 (ctx, eh, job_headers, jcc, jcc_cls);
479  curl_slist_free_all (job_headers);
480  return job;
481 }
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:421
#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:85
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 421 of file curl.c.

References GNUNET_CURL_Context::cb, GNUNET_CURL_Context::cb_cls, GNUNET_assert, GNUNET_CURL_Job::jcc, GNUNET_CURL_Job::jcc_cls, job, setup_job(), and setup_job_headers().

Referenced by GNUNET_CURL_job_add().

426 {
427  struct GNUNET_CURL_Job *job;
428  struct curl_slist *all_headers;
429 
430  GNUNET_assert (NULL != jcc);
431  all_headers = setup_job_headers (ctx,
432  job_headers);
433  if (NULL == (job = setup_job (eh,
434  ctx,
435  all_headers)))
436  return NULL;
437 
438  job->jcc = jcc;
439  job->jcc_cls = jcc_cls;
440  ctx->cb (ctx->cb_cls);
441  return job;
442 }
#define GNUNET_assert(cond)
Use this for fatal errors that cannot be handled.
GNUNET_CURL_RescheduleCallback cb
Function we need to call whenever the event loop&#39;s socket set changed.
Definition: curl.c:166
void * jcc_cls
Closure for jcc.
Definition: curl.c:101
GNUNET_CURL_JobCompletionCallback jcc
Function to call upon completion.
Definition: curl.c:96
static struct curl_slist * setup_job_headers(struct GNUNET_CURL_Context *ctx, const struct curl_slist *job_headers)
Create the HTTP headers for the request.
Definition: curl.c:277
static struct GNUNET_SCHEDULER_Task * job
Task for main job.
Definition: gnunet-cadet.c:137
void * cb_cls
Closure for cb.
Definition: curl.c:171
Jobs are CURL requests running within a struct GNUNET_CURL_Context.
Definition: curl.c:71
static struct GNUNET_CURL_Job * setup_job(CURL *eh, struct GNUNET_CURL_Context *ctx, struct curl_slist *all_headers)
Create a job.
Definition: curl.c:326
Here is the call graph for this function:
Here is the caller graph for this function:

◆ GNUNET_CURL_job_add_raw()

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.

Note that the context will make use of the CURLOPT_PRIVATE facility of the CURL eh. Used to download resources that are NOT in JSON. The raw body will be returned.

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
max_reply_sizelargest acceptable response body
jcccallback to invoke upon completion
jcc_clsclosure for jcc
Returns
NULL on error (in this case, is still released!)

Definition at line 378 of file curl.c.

References GNUNET_CURL_Context::cb, GNUNET_CURL_Context::cb_cls, GNUNET_assert, GNUNET_CURL_Job::jcc, GNUNET_CURL_Job::jcc_cls, GNUNET_CURL_Job::jcc_raw, GNUNET_CURL_Job::jcc_raw_cls, job, setup_job(), and setup_job_headers().

383 {
384  struct GNUNET_CURL_Job *job;
385  struct curl_slist *all_headers;
386 
387  GNUNET_assert (NULL != jcc);
388  all_headers = setup_job_headers (ctx,
389  job_headers);
390  if (NULL == (job = setup_job (eh,
391  ctx,
392  all_headers)))
393  return NULL;
394  job->jcc_raw = jcc;
395  job->jcc_raw_cls = jcc_cls;
396  ctx->cb (ctx->cb_cls);
397  return job;
398 }
#define GNUNET_assert(cond)
Use this for fatal errors that cannot be handled.
GNUNET_CURL_RescheduleCallback cb
Function we need to call whenever the event loop&#39;s socket set changed.
Definition: curl.c:166
static struct curl_slist * setup_job_headers(struct GNUNET_CURL_Context *ctx, const struct curl_slist *job_headers)
Create the HTTP headers for the request.
Definition: curl.c:277
GNUNET_CURL_RawJobCompletionCallback jcc_raw
Function to call upon completion.
Definition: curl.c:106
static struct GNUNET_SCHEDULER_Task * job
Task for main job.
Definition: gnunet-cadet.c:137
void * cb_cls
Closure for cb.
Definition: curl.c:171
Jobs are CURL requests running within a struct GNUNET_CURL_Context.
Definition: curl.c:71
void * jcc_raw_cls
Closure for jcc_raw.
Definition: curl.c:111
static struct GNUNET_CURL_Job * setup_job(CURL *eh, struct GNUNET_CURL_Context *ctx, struct curl_slist *all_headers)
Create a job.
Definition: curl.c:326
Here is the call 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 491 of file curl.c.

References GNUNET_CURL_DownloadBuffer::buf, GNUNET_CURL_Context::cb, GNUNET_CURL_Context::cb_cls, 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().

492 {
493  struct GNUNET_CURL_Context *ctx = job->ctx;
494 
496  GNUNET_break (CURLM_OK ==
497  curl_multi_remove_handle (ctx->multi, job->easy_handle));
498  curl_easy_cleanup (job->easy_handle);
499  GNUNET_free_non_null (job->db.buf);
500  curl_slist_free_all (job->job_headers);
501  ctx->cb (ctx->cb_cls);
502  GNUNET_free (job);
503 }
#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.
GNUNET_CURL_RescheduleCallback cb
Function we need to call whenever the event loop&#39;s socket set changed.
Definition: curl.c:166
#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:144
Context.
Definition: curl.c:129
CURLM * multi
Curl multi handle.
Definition: curl.c:134
CURL * easy_handle
Easy handle of the job.
Definition: curl.c:86
void * buf
Download buffer.
void * cb_cls
Closure for cb.
Definition: curl.c:171
struct GNUNET_CURL_Job * jobs_tail
We keep jobs in a DLL.
Definition: curl.c:149
struct GNUNET_CURL_DownloadBuffer db
Buffer for response received from CURL.
Definition: curl.c:116
struct curl_slist * job_headers
Headers used for this job, the list needs to be freed after the job has finished. ...
Definition: curl.c:122
#define GNUNET_free(ptr)
Wrapper around free.
struct GNUNET_CURL_Context * ctx
Context this job runs in.
Definition: curl.c:91
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 103 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.

104 {
106 
108  rc->ctx = ctx;
110  rc->cleaner = &clean_result;
111  return rc;
112 }
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:525
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 121 of file curl_reschedule.c.

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

122 {
123  if (NULL != rc->task)
125  GNUNET_free (rc);
126 }
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:966
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:1280
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:966
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 223 of file curl.c.

References GNUNET_CURL_Context::async_scope_id_header.

225 {
226  ctx->async_scope_id_header = header_name;
227 }
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:160