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...
 
enum GNUNET_GenericReturnValue 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, 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_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. More...
 
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 performed with ctx. More...
 
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 performed with ctx. 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_extend_headers (struct GNUNET_CURL_Job *job, const struct curl_slist *extra_headers)
 Add extra_headers to the HTTP headers for job. 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...
 
int GNUNET_CURL_is_valid_scope_id (const char *scope_id)
 Return GNUNET_YES if given a valid scope ID and GNUNET_NO otherwise. 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 50 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 85 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 95 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 202 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 216 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 237 of file curl.c.

239 {
240  struct GNUNET_CURL_Context *ctx;
241  CURLM *multi;
242  CURLSH *share;
243 
244  if (curl_fail)
245  {
247  "Curl was not initialised properly\n");
248  return NULL;
249  }
250  if (NULL == (multi = curl_multi_init ()))
251  {
253  "Failed to create a Curl multi handle\n");
254  return NULL;
255  }
256  if (NULL == (share = curl_share_init ()))
257  {
259  "Failed to create a Curl share handle\n");
260  return NULL;
261  }
263  ctx->cb = cb;
264  ctx->cb_cls = cb_cls;
265  ctx->multi = multi;
266  ctx->share = share;
267  return ctx;
268 }
static int curl_fail
Failsafe flag.
Definition: curl.c:67
static CURLM * multi
Current multi-CURL handle.
static struct GNUNET_DNSSTUB_Context * ctx
Context for DNS resolution.
#define GNUNET_log(kind,...)
@ GNUNET_ERROR_TYPE_ERROR
#define GNUNET_new(type)
Allocate a struct or union of the given type.
Context.
Definition: curl.c:131
void * cb_cls
Closure for cb.
Definition: curl.c:172
CURLSH * share
Curl share handle.
Definition: curl.c:140
GNUNET_CURL_RescheduleCallback cb
Function we need to call whenever the event loop's socket set changed.
Definition: curl.c:167

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

◆ 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().

Definition at line 783 of file curl.c.

789 {
790  long to;
791  int m;
792 
793  m = -1;
794  GNUNET_assert (CURLM_OK ==
795  curl_multi_fdset (ctx->multi,
796  read_fd_set,
797  write_fd_set,
798  except_fd_set,
799  &m));
800  to = *timeout;
801  *max_fd = GNUNET_MAX (m, *max_fd);
802  GNUNET_assert (CURLM_OK ==
803  curl_multi_timeout (ctx->multi,
804  &to));
805 
806  /* Only if what we got back from curl is smaller than what we
807  already had (-1 == infinity!), then update timeout */
808  if ((to < *timeout) && (-1 != to))
809  *timeout = to;
810  if ((-1 == (*timeout)) && (NULL != ctx->jobs_head))
811  *timeout = to;
812 }
static struct GNUNET_TIME_Relative timeout
Desired timeout for the lookup (default is no timeout).
Definition: gnunet-abd.c:61
static struct GNUNET_ARM_MonitorHandle * m
Monitor connection with ARM.
Definition: gnunet-arm.c:104
#define GNUNET_MAX(a, b)
#define GNUNET_assert(cond)
Use this for fatal errors that cannot be handled.

References ctx, GNUNET_assert, GNUNET_MAX, m, and timeout.

Referenced by context_task().

Here is the caller graph for this function:

◆ GNUNET_CURL_append_header()

enum GNUNET_GenericReturnValue 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 633 of file curl.c.

709 {
710  ctx->common_headers = curl_slist_append (ctx->common_headers,
711  header);
712  if (NULL == ctx->common_headers)
713  return GNUNET_SYSERR;
714 
715  return GNUNET_OK;
716 }
@ GNUNET_OK
Definition: gnunet_common.h:95
@ GNUNET_SYSERR
Definition: gnunet_common.h:93

References db, GNUNET_break, GNUNET_ERROR_TYPE_DEBUG, GNUNET_ERROR_TYPE_WARNING, GNUNET_free, GNUNET_log, is_json(), and JSON_WARN.

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

Definition at line 774 of file curl.c.

775 {
778  (GNUNET_CURL_ResponseCleaner) & json_decref);
779 }
void * GNUNET_CURL_download_get_result_(struct GNUNET_CURL_DownloadBuffer *db, CURL *eh, long *response_code)
Definition: curl.c:633
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:720

References ctx, GNUNET_CURL_download_get_result_(), and GNUNET_CURL_perform2().

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

723 {
724  CURLMsg *cmsg;
725  int n_running;
726  int n_completed;
727 
728  (void) curl_multi_perform (ctx->multi,
729  &n_running);
730  while (NULL != (cmsg = curl_multi_info_read (ctx->multi,
731  &n_completed)))
732  {
733  struct GNUNET_CURL_Job *job;
734  long response_code;
735  void *response;
736 
737  /* Only documented return value is CURLMSG_DONE */
738  GNUNET_break (CURLMSG_DONE == cmsg->msg);
739  GNUNET_assert (CURLE_OK ==
740  curl_easy_getinfo (cmsg->easy_handle,
741  CURLINFO_PRIVATE,
742  (char **) &job));
743  GNUNET_assert (job->ctx == ctx);
744  response_code = 0;
745  if (NULL != job->jcc_raw)
746  {
747  /* RAW mode, no parsing */
748  GNUNET_break (CURLE_OK ==
749  curl_easy_getinfo (job->easy_handle,
750  CURLINFO_RESPONSE_CODE,
751  &response_code));
752  job->jcc_raw (job->jcc_raw_cls,
753  response_code,
754  job->db.buf,
755  job->db.buf_size);
756  }
757  else
758  {
759  /* to be parsed via 'rp' */
760  response = rp (&job->db,
761  job->easy_handle,
762  &response_code);
763  job->jcc (job->jcc_cls,
764  response_code,
765  response);
766  rc (response);
767  }
769  }
770 }
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.
void GNUNET_CURL_job_cancel(struct GNUNET_CURL_Job *job)
Cancel a job.
Definition: curl.c:580
#define GNUNET_break(cond)
Use this for internal assertion violations that are not fatal (can be handled) but should not occur.
Jobs are CURL requests running within a struct GNUNET_CURL_Context.
Definition: curl.c:73

References ctx, GNUNET_assert, GNUNET_break, GNUNET_CURL_job_cancel(), job, response, and rp.

Referenced by context_task(), and GNUNET_CURL_perform().

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

817 {
818  /* all jobs must have been cancelled at this time, assert this */
819  GNUNET_assert (NULL == ctx->jobs_head);
820  curl_share_cleanup (ctx->share);
821  curl_multi_cleanup (ctx->multi);
822  curl_slist_free_all (ctx->common_headers);
823  GNUNET_free (ctx->userpass);
824  GNUNET_free (ctx->certtype);
825  GNUNET_free (ctx->certfile);
826  GNUNET_free (ctx->keyfile);
827  GNUNET_free (ctx->keypass);
828  GNUNET_free (ctx);
829 }
#define GNUNET_free(ptr)
Wrapper around free.

References ctx, GNUNET_assert, and GNUNET_free.

◆ GNUNET_CURL_job_add()

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.

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

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

Definition at line 566 of file curl.c.

570 {
571  return GNUNET_CURL_job_add2 (ctx,
572  eh,
573  NULL,
574  jcc,
575  jcc_cls);
576 }
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:493

References ctx, GNUNET_CURL_job_add2(), GNUNET_CURL_Job::jcc, and GNUNET_CURL_Job::jcc_cls.

Here is the call graph for this function:

◆ GNUNET_CURL_job_add_with_ct_json()

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.

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.

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

Definition at line 544 of file curl.c.

548 {
549  struct GNUNET_CURL_Job *job;
550  struct curl_slist *job_headers = NULL;
551 
552  GNUNET_assert (NULL != (job_headers =
553  curl_slist_append (NULL,
554  "Content-Type: application/json")));
556  eh,
557  job_headers,
558  jcc,
559  jcc_cls);
560  curl_slist_free_all (job_headers);
561  return job;
562 }

References ctx, GNUNET_assert, GNUNET_CURL_job_add2(), and job.

Here is the call graph for this function:

◆ GNUNET_CURL_set_userpass()

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 performed with ctx.

Parameters
ctxcontext to set authentication data for
userpassstring with "$USERNAME:$PASSWORD"

Definition at line 205 of file curl.c.

207 {
208  GNUNET_free (ctx->userpass);
209  if (NULL != userpass)
210  ctx->userpass = GNUNET_strdup (userpass);
211 }
#define GNUNET_strdup(a)
Wrapper around GNUNET_xstrdup_.

References ctx, GNUNET_free, and GNUNET_strdup.

◆ GNUNET_CURL_set_tlscert()

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 performed with ctx.

Note that if the provided information is incorrect, the earliest operation that could fail is GNUNET_CURL_job_add() or GNUNET_CURL_job_add2()!

Parameters
ctxcontext to set authentication data for
certtypetype of the certificate
certfilefile with the certificate
keyfilefile with the private key
keypasspassphrase to decrypt keyfile (or NULL)

Definition at line 215 of file curl.c.

220 {
221  GNUNET_free (ctx->certtype);
222  GNUNET_free (ctx->certfile);
223  GNUNET_free (ctx->keyfile);
224  GNUNET_free (ctx->keypass);
225  if (NULL != certtype)
226  ctx->certtype = GNUNET_strdup (certtype);
227  if (NULL != certfile)
228  ctx->certfile = GNUNET_strdup (certfile);
229  if (NULL != keyfile)
230  ctx->certtype = GNUNET_strdup (keyfile);
231  if (NULL != keypass)
232  ctx->certtype = GNUNET_strdup (keypass);
233 }

References ctx, GNUNET_free, and GNUNET_strdup.

◆ 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, @eh is still released!)

Definition at line 493 of file curl.c.

498 {
499  struct GNUNET_CURL_Job *job;
500  struct curl_slist *all_headers;
501 
502  GNUNET_assert (NULL != jcc);
503  if ( (NULL != ctx->userpass) &&
504  (0 != curl_easy_setopt (eh,
505  CURLOPT_USERPWD,
506  ctx->userpass)) )
507  return NULL;
508  if ( (NULL != ctx->certfile) &&
509  (0 != curl_easy_setopt (eh,
510  CURLOPT_SSLCERT,
511  ctx->certfile)) )
512  return NULL;
513  if ( (NULL != ctx->certtype) &&
514  (0 != curl_easy_setopt (eh,
515  CURLOPT_SSLCERTTYPE,
516  ctx->certtype)) )
517  return NULL;
518  if ( (NULL != ctx->keyfile) &&
519  (0 != curl_easy_setopt (eh,
520  CURLOPT_SSLKEY,
521  ctx->keyfile)) )
522  return NULL;
523  if ( (NULL != ctx->keypass) &&
524  (0 != curl_easy_setopt (eh,
525  CURLOPT_KEYPASSWD,
526  ctx->keypass)) )
527  return NULL;
528 
529  all_headers = setup_job_headers (ctx,
530  job_headers);
531  if (NULL == (job = setup_job (eh,
532  ctx,
533  all_headers)))
534  return NULL;
535 
536  job->jcc = jcc;
537  job->jcc_cls = jcc_cls;
538  ctx->cb (ctx->cb_cls);
539  return job;
540 }
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:342
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:397

References ctx, GNUNET_assert, job, setup_job(), and setup_job_headers().

Referenced by GNUNET_CURL_job_add(), and GNUNET_CURL_job_add_with_ct_json().

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, @eh is still released!)

Definition at line 469 of file curl.c.

474 {
475  struct GNUNET_CURL_Job *job;
476  struct curl_slist *all_headers;
477 
478  GNUNET_assert (NULL != jcc);
479  all_headers = setup_job_headers (ctx,
480  job_headers);
481  if (NULL == (job = setup_job (eh,
482  ctx,
483  all_headers)))
484  return NULL;
485  job->jcc_raw = jcc;
486  job->jcc_raw_cls = jcc_cls;
487  ctx->cb (ctx->cb_cls);
488  return job;
489 }

References ctx, GNUNET_assert, job, setup_job(), and setup_job_headers().

Here is the call graph for this function:

◆ GNUNET_CURL_extend_headers()

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.

Parameters
[in,out]jobthe job to modify
extra_headersheaders to append

Definition at line 451 of file curl.c.

453 {
454  struct curl_slist *all_headers = job->job_headers;
455 
456  for (const struct curl_slist *curr = extra_headers;
457  NULL != curr;
458  curr = curr->next)
459  {
460  GNUNET_assert (NULL !=
461  (all_headers = curl_slist_append (all_headers,
462  curr->data)));
463  }
464  job->job_headers = all_headers;
465 }

References GNUNET_assert, and job.

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

581 {
582  struct GNUNET_CURL_Context *ctx = job->ctx;
583 
584  GNUNET_CONTAINER_DLL_remove (ctx->jobs_head,
585  ctx->jobs_tail,
586  job);
587  GNUNET_break (CURLM_OK ==
588  curl_multi_remove_handle (ctx->multi,
589  job->easy_handle));
590  curl_easy_cleanup (job->easy_handle);
591  GNUNET_free (job->db.buf);
592  curl_slist_free_all (job->job_headers);
593  ctx->cb (ctx->cb_cls);
594  GNUNET_free (job);
595 }
#define GNUNET_CONTAINER_DLL_remove(head, tail, element)
Remove an element from a DLL.

References ctx, GNUNET_break, GNUNET_CONTAINER_DLL_remove, GNUNET_free, and job.

Referenced by GNUNET_CURL_perform2().

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.

104 {
106 
108  rc->ctx = ctx;
110  rc->cleaner = &clean_result;
111  return rc;
112 }
void * GNUNET_CURL_download_get_result_(struct GNUNET_CURL_DownloadBuffer *db, CURL *eh, long *response_code)
Definition: curl.c:633
static void clean_result(void *response)
Just a wrapper to avoid casting of function pointers.
Closure for GNUNET_CURL_gnunet_scheduler_reschedule().
GNUNET_CURL_RawParser parser
Parser of the raw response.
struct GNUNET_CURL_Context * ctx
Context we manage.
GNUNET_CURL_ResponseCleaner cleaner
Deallocate the response object.

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

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.

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 }

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

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

122 {
123  if (NULL != rc->task)
125  GNUNET_free (rc);
126 }
void * GNUNET_SCHEDULER_cancel(struct GNUNET_SCHEDULER_Task *task)
Cancel the task with the specified identifier.
Definition: scheduler.c:972
struct GNUNET_SCHEDULER_Task * task
Just the task.

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

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.

192 {
193  struct GNUNET_CURL_RescheduleContext *rc = *(void **) cls;
194 
195  if (NULL != rc->task)
198 }
static void context_task(void *cls)
Task that runs the context's event loop with the GNUnet scheduler.
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:1296

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

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

274 {
275  ctx->async_scope_id_header = header_name;
276 }

References ctx.

◆ GNUNET_CURL_is_valid_scope_id()

int GNUNET_CURL_is_valid_scope_id ( const char *  scope_id)

Return GNUNET_YES if given a valid scope ID and GNUNET_NO otherwise.

See GNUNET_CURL_enable_async_scope_header() for the code that generates such a scope_id in an HTTP header.

Returns
GNUNET_YES iff given a valid scope ID

Definition at line 280 of file curl.c.

281 {
282  if (strlen (scope_id) >= 64)
283  return GNUNET_NO;
284  for (size_t i = 0; i < strlen (scope_id); i++)
285  if (! (isalnum (scope_id[i]) || (scope_id[i] == '-')))
286  return GNUNET_NO;
287  return GNUNET_YES;
288 }
@ GNUNET_YES
Definition: gnunet_common.h:97
@ GNUNET_NO
Definition: gnunet_common.h:94

References GNUNET_NO, and GNUNET_YES.