GNUnet  0.18.1
CURL integration library

Download JSON using libcurl. More...

Collaboration diagram for CURL integration library:

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 47 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 82 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 92 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 199 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 213 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 241 of file curl.c.

243 {
244  struct GNUNET_CURL_Context *ctx;
245  CURLM *multi;
246  CURLSH *share;
247 
248  if (curl_fail)
249  {
251  "Curl was not initialised properly\n");
252  return NULL;
253  }
254  if (NULL == (multi = curl_multi_init ()))
255  {
257  "Failed to create a Curl multi handle\n");
258  return NULL;
259  }
260  if (NULL == (share = curl_share_init ()))
261  {
263  "Failed to create a Curl share handle\n");
264  return NULL;
265  }
267  ctx->cb = cb;
268  ctx->cb_cls = cb_cls;
269  ctx->multi = multi;
270  ctx->share = share;
271  return ctx;
272 }
static int curl_fail
Failsafe flag.
Definition: curl.c:71
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:135
void * cb_cls
Closure for cb.
Definition: curl.c:176
CURLSH * share
Curl share handle.
Definition: curl.c:144
GNUNET_CURL_RescheduleCallback cb
Function we need to call whenever the event loop's socket set changed.
Definition: curl.c:171

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

801 {
802  long to;
803  int m;
804 
805  m = -1;
806  GNUNET_assert (CURLM_OK ==
807  curl_multi_fdset (ctx->multi,
808  read_fd_set,
809  write_fd_set,
810  except_fd_set,
811  &m));
812  to = *timeout;
813  *max_fd = GNUNET_MAX (m, *max_fd);
814  GNUNET_assert (CURLM_OK ==
815  curl_multi_timeout (ctx->multi,
816  &to));
817 
818  /* Only if what we got back from curl is smaller than what we
819  already had (-1 == infinity!), then update timeout */
820  if ((to < *timeout) && (-1 != to))
821  *timeout = to;
822  if ((-1 == (*timeout)) && (NULL != ctx->jobs_head))
823  *timeout = to;
824 }
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 643 of file curl.c.

721 {
722  ctx->common_headers = curl_slist_append (ctx->common_headers,
723  header);
724  if (NULL == ctx->common_headers)
725  return GNUNET_SYSERR;
726 
727  return GNUNET_OK;
728 }
@ GNUNET_OK
Definition: gnunet_common.h:99
@ GNUNET_SYSERR
Definition: gnunet_common.h:97

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

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

787 {
790  (GNUNET_CURL_ResponseCleaner) & json_decref);
791 }
void * GNUNET_CURL_download_get_result_(struct GNUNET_CURL_DownloadBuffer *db, CURL *eh, long *response_code)
Definition: curl.c:643
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:732

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

735 {
736  CURLMsg *cmsg;
737  int n_running;
738  int n_completed;
739 
740  (void) curl_multi_perform (ctx->multi,
741  &n_running);
742  while (NULL != (cmsg = curl_multi_info_read (ctx->multi,
743  &n_completed)))
744  {
745  struct GNUNET_CURL_Job *job;
746  long response_code;
747  void *response;
748 
749  /* Only documented return value is CURLMSG_DONE */
750  GNUNET_break (CURLMSG_DONE == cmsg->msg);
751  GNUNET_assert (CURLE_OK ==
752  curl_easy_getinfo (cmsg->easy_handle,
753  CURLINFO_PRIVATE,
754  (char **) &job));
755  GNUNET_assert (job->ctx == ctx);
756  response_code = 0;
757  if (NULL != job->jcc_raw)
758  {
759  /* RAW mode, no parsing */
760  GNUNET_break (CURLE_OK ==
761  curl_easy_getinfo (job->easy_handle,
762  CURLINFO_RESPONSE_CODE,
763  &response_code));
764  job->jcc_raw (job->jcc_raw_cls,
765  response_code,
766  job->db.buf,
767  job->db.buf_size);
768  }
769  else
770  {
771  /* to be parsed via 'rp' */
772  response = rp (&job->db,
773  job->easy_handle,
774  &response_code);
775  job->jcc (job->jcc_cls,
776  response_code,
777  response);
778  rc (response);
779  }
781  }
782 }
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:590
#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:77

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

829 {
830  /* all jobs must have been cancelled at this time, assert this */
831  GNUNET_assert (NULL == ctx->jobs_head);
832  curl_share_cleanup (ctx->share);
833  curl_multi_cleanup (ctx->multi);
834  curl_slist_free_all (ctx->common_headers);
835  GNUNET_free (ctx->userpass);
836  GNUNET_free (ctx->certtype);
837  GNUNET_free (ctx->certfile);
838  GNUNET_free (ctx->keyfile);
839  GNUNET_free (ctx->keypass);
840  GNUNET_free (ctx);
841 }
#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 576 of file curl.c.

580 {
581  return GNUNET_CURL_job_add2 (ctx,
582  eh,
583  NULL,
584  jcc,
585  jcc_cls);
586 }
struct GNUNET_CURL_Job * GNUNET_CURL_job_add2(struct GNUNET_CURL_Context *ctx, CURL *eh, const struct curl_slist *job_headers, GNUNET_CURL_JobCompletionCallback jcc, void *jcc_cls)
Schedule a CURL request to be executed and call the given jcc upon its completion.
Definition: curl.c:503

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

558 {
559  struct GNUNET_CURL_Job *job;
560  struct curl_slist *job_headers = NULL;
561 
562  GNUNET_assert (NULL != (job_headers =
563  curl_slist_append (NULL,
564  "Content-Type: application/json")));
566  eh,
567  job_headers,
568  jcc,
569  jcc_cls);
570  curl_slist_free_all (job_headers);
571  return job;
572 }

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

211 {
212  GNUNET_free (ctx->userpass);
213  if (NULL != userpass)
214  ctx->userpass = GNUNET_strdup (userpass);
215 }
#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 219 of file curl.c.

224 {
225  GNUNET_free (ctx->certtype);
226  GNUNET_free (ctx->certfile);
227  GNUNET_free (ctx->keyfile);
228  GNUNET_free (ctx->keypass);
229  if (NULL != certtype)
230  ctx->certtype = GNUNET_strdup (certtype);
231  if (NULL != certfile)
232  ctx->certfile = GNUNET_strdup (certfile);
233  if (NULL != keyfile)
234  ctx->certtype = GNUNET_strdup (keyfile);
235  if (NULL != keypass)
236  ctx->certtype = GNUNET_strdup (keypass);
237 }

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

508 {
509  struct GNUNET_CURL_Job *job;
510  struct curl_slist *all_headers;
511 
512  GNUNET_assert (NULL != jcc);
513  if ( (NULL != ctx->userpass) &&
514  (0 != curl_easy_setopt (eh,
515  CURLOPT_USERPWD,
516  ctx->userpass)) )
517  return NULL;
518  if ( (NULL != ctx->certfile) &&
519  (0 != curl_easy_setopt (eh,
520  CURLOPT_SSLCERT,
521  ctx->certfile)) )
522  return NULL;
523  if ( (NULL != ctx->certtype) &&
524  (0 != curl_easy_setopt (eh,
525  CURLOPT_SSLCERTTYPE,
526  ctx->certtype)) )
527  return NULL;
528  if ( (NULL != ctx->keyfile) &&
529  (0 != curl_easy_setopt (eh,
530  CURLOPT_SSLKEY,
531  ctx->keyfile)) )
532  return NULL;
533  if ( (NULL != ctx->keypass) &&
534  (0 != curl_easy_setopt (eh,
535  CURLOPT_KEYPASSWD,
536  ctx->keypass)) )
537  return NULL;
538 
539  all_headers = setup_job_headers (ctx,
540  job_headers);
541  if (NULL == (job = setup_job (eh,
542  ctx,
543  all_headers)))
544  return NULL;
545 
546  job->jcc = jcc;
547  job->jcc_cls = jcc_cls;
548  ctx->cb (ctx->cb_cls);
549  return job;
550 }
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:346
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:401

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

Definition at line 479 of file curl.c.

484 {
485  struct GNUNET_CURL_Job *job;
486  struct curl_slist *all_headers;
487 
488  GNUNET_assert (NULL != jcc);
489  all_headers = setup_job_headers (ctx,
490  job_headers);
491  if (NULL == (job = setup_job (eh,
492  ctx,
493  all_headers)))
494  return NULL;
495  job->jcc_raw = jcc;
496  job->jcc_raw_cls = jcc_cls;
497  ctx->cb (ctx->cb_cls);
498  return job;
499 }

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

463 {
464  struct curl_slist *all_headers = job->job_headers;
465 
466  for (const struct curl_slist *curr = extra_headers;
467  NULL != curr;
468  curr = curr->next)
469  {
470  GNUNET_assert (NULL !=
471  (all_headers = curl_slist_append (all_headers,
472  curr->data)));
473  }
474  job->job_headers = all_headers;
475 }

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

591 {
592  struct GNUNET_CURL_Context *ctx = job->ctx;
593 
594  GNUNET_CONTAINER_DLL_remove (ctx->jobs_head,
595  ctx->jobs_tail,
596  job);
597  GNUNET_break (CURLM_OK ==
598  curl_multi_remove_handle (ctx->multi,
599  job->easy_handle));
600  curl_easy_cleanup (job->easy_handle);
601  GNUNET_free (job->db.buf);
602  curl_slist_free_all (job->job_headers);
603  ctx->cb (ctx->cb_cls);
604  GNUNET_free (job);
605 }
#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 91 of file curl_reschedule.c.

92 {
94 
96  rc->ctx = ctx;
98  rc->cleaner = &clean_result;
99  return rc;
100 }
void * GNUNET_CURL_download_get_result_(struct GNUNET_CURL_DownloadBuffer *db, CURL *eh, long *response_code)
Definition: curl.c:643
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 63 of file curl_reschedule.c.

66 {
67  struct GNUNET_CURL_RescheduleContext *rctx;
68 
70  rctx->ctx = ctx;
71  rctx->parser = rp;
72  rctx->cleaner = rc;
73 
74  return rctx;
75 }

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 104 of file curl_reschedule.c.

105 {
106  if (NULL != rc->task)
108  GNUNET_free (rc);
109 }
void * GNUNET_SCHEDULER_cancel(struct GNUNET_SCHEDULER_Task *task)
Cancel the task with the specified identifier.
Definition: scheduler.c:943
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 170 of file curl_reschedule.c.

171 {
172  struct GNUNET_CURL_RescheduleContext *rc = *(void **) cls;
173 
174  if (NULL != rc->task)
177  rc);
178 }
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:1267

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

278 {
279  ctx->async_scope_id_header = header_name;
280 }

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

285 {
286  if (strlen (scope_id) >= 64)
287  return GNUNET_NO;
288  for (size_t i = 0; i < strlen (scope_id); i++)
289  if (! (isalnum (scope_id[i]) || (scope_id[i] == '-')))
290  return GNUNET_NO;
291  return GNUNET_YES;
292 }
@ GNUNET_YES
@ GNUNET_NO
Definition: gnunet_common.h:98

References GNUNET_NO, and GNUNET_YES.