GNUnet 0.24.1-15-gab6ed22f1
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...
 
enum GNUNET_GenericReturnValue 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 48 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 83 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 93 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 200 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 214 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 247 of file curl.c.

249{
250 struct GNUNET_CURL_Context *ctx;
251 CURLM *multi;
252 CURLSH *share;
253
254 if (curl_fail)
255 {
257 "Curl was not initialised properly\n");
258 return NULL;
259 }
260 if (NULL == (multi = curl_multi_init ()))
261 {
263 "Failed to create a Curl multi handle\n");
264 return NULL;
265 }
266 if (NULL == (share = curl_share_init ()))
267 {
269 "Failed to create a Curl share handle\n");
270 return NULL;
271 }
273 ctx->cb = cb;
274 ctx->cb_cls = cb_cls;
275 ctx->multi = multi;
276 ctx->share = share;
277 return ctx;
278}
static int curl_fail
Failsafe flag.
Definition: curl.c:72
static CURLM * multi
Current multi-CURL handle.
static struct GNUNET_FS_Handle * ctx
#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:141
void * cb_cls
Closure for cb.
Definition: curl.c:182
CURLSH * share
Curl share handle.
Definition: curl.c:150
GNUNET_CURL_RescheduleCallback cb
Function we need to call whenever the event loop's socket set changed.
Definition: curl.c:177

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

844{
845 long to;
846 int m;
847
848 m = -1;
849 GNUNET_assert (CURLM_OK ==
850 curl_multi_fdset (ctx->multi,
851 read_fd_set,
852 write_fd_set,
853 except_fd_set,
854 &m));
855 to = *timeout;
856 *max_fd = GNUNET_MAX (m, *max_fd);
857 GNUNET_assert (CURLM_OK ==
858 curl_multi_timeout (ctx->multi,
859 &to));
860
861 /* Only if what we got back from curl is smaller than what we
862 already had (-1 == infinity!), then update timeout */
863 if ((to < *timeout) && (-1 != to))
864 *timeout = to;
865 if ((-1 == (*timeout)) && (NULL != ctx->jobs_head))
866 *timeout = to;
867}
static struct GNUNET_ARM_MonitorHandle * m
Monitor connection with ARM.
Definition: gnunet-arm.c:103
static struct GNUNET_TIME_Relative timeout
User defined timestamp for completing operations.
Definition: gnunet-arm.c:118
#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 744 of file curl.c.

746{
747 ctx->common_headers = curl_slist_append (ctx->common_headers,
748 header);
749 if (NULL == ctx->common_headers)
750 return GNUNET_SYSERR;
751
752 return GNUNET_OK;
753}
@ GNUNET_OK
@ GNUNET_SYSERR

References ctx, GNUNET_OK, and GNUNET_SYSERR.

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

830{
833 (GNUNET_CURL_ResponseCleaner) & json_decref);
834}
void * GNUNET_CURL_download_get_result_(struct GNUNET_CURL_DownloadBuffer *db, CURL *eh, long *response_code)
Definition: curl.c:655
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:757

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

760{
761 CURLMsg *cmsg;
762 int n_running;
763 int n_completed;
764
765 (void) curl_multi_perform (ctx->multi,
766 &n_running);
767 while (NULL != (cmsg = curl_multi_info_read (ctx->multi,
768 &n_completed)))
769 {
770 struct GNUNET_CURL_Job *job;
772 long response_code;
773 void *response;
774
775 /* Only documented return value is CURLMSG_DONE */
776 GNUNET_break (CURLMSG_DONE == cmsg->msg);
777 GNUNET_assert (CURLE_OK ==
778 curl_easy_getinfo (cmsg->easy_handle,
779 CURLINFO_PRIVATE,
780 (char **) &job));
781 GNUNET_assert (job->ctx == ctx);
782 response_code = 0;
784 if (NULL != job->jcc_raw)
785 {
786 /* RAW mode, no parsing */
787 GNUNET_break (CURLE_OK ==
788 curl_easy_getinfo (job->easy_handle,
789 CURLINFO_RESPONSE_CODE,
790 &response_code));
791 job->jcc_raw (job->jcc_raw_cls,
792 response_code,
793 job->db.buf,
794 job->db.buf_size);
795 }
796 else
797 {
798 /* to be parsed via 'rp' */
799 response = rp (&job->db,
800 job->easy_handle,
801 &response_code);
802 job->jcc (job->jcc_cls,
803 response_code,
804 response);
805 rc (response);
806 }
807 {
808 const char *url = NULL;
809
810 if (CURLE_UNKNOWN_OPTION ==
811 curl_easy_getinfo (job->easy_handle,
812 CURLINFO_EFFECTIVE_URL,
813 &url))
814 url = "<unknown>";
816 "HTTP request for `%s' finished with %u after %s\n",
817 url,
818 (unsigned int) response_code,
820 true));
821 /* Note: we MUST NOT free 'url' here */
822 }
824 }
825}
static struct GNUNET_SCHEDULER_Task * job
Task for main job.
Definition: gnunet-cadet.c:137
static struct MHD_Response * response
Our canonical response.
static char * rp
Relying party.
static struct GNUNET_TIME_Relative duration
Option '-d': duration of the mapping.
Definition: gnunet-vpn.c:90
void GNUNET_CURL_job_cancel(struct GNUNET_CURL_Job *job)
Cancel a job.
Definition: curl.c:602
#define GNUNET_break(cond)
Use this for internal assertion violations that are not fatal (can be handled) but should not occur.
@ GNUNET_ERROR_TYPE_INFO
const char * GNUNET_TIME_relative2s(struct GNUNET_TIME_Relative delta, bool do_round)
Give relative time in human-readable fancy format.
Definition: time.c:264
struct GNUNET_TIME_Relative GNUNET_TIME_absolute_get_duration(struct GNUNET_TIME_Absolute whence)
Get the duration of an operation as the difference of the current time and the given start time "henc...
Definition: time.c:438
Jobs are CURL requests running within a struct GNUNET_CURL_Context.
Definition: curl.c:78
Time for relative time used by GNUnet, in microseconds.

References ctx, duration, GNUNET_assert, GNUNET_break, GNUNET_CURL_job_cancel(), GNUNET_ERROR_TYPE_INFO, GNUNET_log, GNUNET_TIME_absolute_get_duration(), GNUNET_TIME_relative2s(), 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 871 of file curl.c.

872{
873 /* all jobs must have been cancelled at this time, assert this */
874 GNUNET_assert (NULL == ctx->jobs_head);
875 curl_share_cleanup (ctx->share);
876 curl_multi_cleanup (ctx->multi);
877 curl_slist_free_all (ctx->common_headers);
878 GNUNET_free (ctx->userpass);
879 GNUNET_free (ctx->certtype);
880 GNUNET_free (ctx->certfile);
881 GNUNET_free (ctx->keyfile);
882 GNUNET_free (ctx->keypass);
884}
#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 588 of file curl.c.

592{
594 eh,
595 NULL,
596 jcc,
597 jcc_cls);
598}
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:514

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

569{
570 struct GNUNET_CURL_Job *job;
571 struct curl_slist *job_headers = NULL;
572
573 GNUNET_assert (NULL != (job_headers =
574 curl_slist_append (NULL,
575 "Content-Type: application/json")
576 ));
578 eh,
579 job_headers,
580 jcc,
581 jcc_cls);
582 curl_slist_free_all (job_headers);
583 return job;
584}

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

217{
218 GNUNET_free (ctx->userpass);
219 if (NULL != userpass)
220 ctx->userpass = GNUNET_strdup (userpass);
221}
#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 225 of file curl.c.

230{
231 GNUNET_free (ctx->certtype);
232 GNUNET_free (ctx->certfile);
233 GNUNET_free (ctx->keyfile);
234 GNUNET_free (ctx->keypass);
235 if (NULL != certtype)
236 ctx->certtype = GNUNET_strdup (certtype);
237 if (NULL != certfile)
238 ctx->certfile = GNUNET_strdup (certfile);
239 if (NULL != keyfile)
240 ctx->certtype = GNUNET_strdup (keyfile);
241 if (NULL != keypass)
242 ctx->certtype = GNUNET_strdup (keypass);
243}

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.

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

519{
520 struct GNUNET_CURL_Job *job;
521 struct curl_slist *all_headers;
522
523 GNUNET_assert (NULL != jcc);
524 if ( (NULL != ctx->userpass) &&
525 (0 != curl_easy_setopt (eh,
526 CURLOPT_USERPWD,
527 ctx->userpass)) )
528 return NULL;
529 if ( (NULL != ctx->certfile) &&
530 (0 != curl_easy_setopt (eh,
531 CURLOPT_SSLCERT,
532 ctx->certfile)) )
533 return NULL;
534 if ( (NULL != ctx->certtype) &&
535 (0 != curl_easy_setopt (eh,
536 CURLOPT_SSLCERTTYPE,
537 ctx->certtype)) )
538 return NULL;
539 if ( (NULL != ctx->keyfile) &&
540 (0 != curl_easy_setopt (eh,
541 CURLOPT_SSLKEY,
542 ctx->keyfile)) )
543 return NULL;
544 if ( (NULL != ctx->keypass) &&
545 (0 != curl_easy_setopt (eh,
546 CURLOPT_KEYPASSWD,
547 ctx->keypass)) )
548 return NULL;
549
550 all_headers = setup_job_headers (ctx,
551 job_headers);
552 if (NULL == (job = setup_job (eh,
553 ctx,
554 all_headers)))
555 return NULL;
556
557 job->jcc = jcc;
558 job->jcc_cls = jcc_cls;
559 ctx->cb (ctx->cb_cls);
560 return job;
561}
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:407
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:352

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

495{
496 struct GNUNET_CURL_Job *job;
497 struct curl_slist *all_headers;
498
499 GNUNET_assert (NULL != jcc);
500 all_headers = setup_job_headers (ctx,
501 job_headers);
502 if (NULL == (job = setup_job (eh,
503 ctx,
504 all_headers)))
505 return NULL;
506 job->jcc_raw = jcc;
507 job->jcc_raw_cls = jcc_cls;
508 ctx->cb (ctx->cb_cls);
509 return job;
510}

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

470{
471 struct curl_slist *all_headers = job->job_headers;
472
473 for (const struct curl_slist *curr = extra_headers;
474 NULL != curr;
475 curr = curr->next)
476 {
477 GNUNET_assert (NULL !=
478 (all_headers = curl_slist_append (all_headers,
479 curr->data)));
480 }
481 job->job_headers = all_headers;
482 GNUNET_break (CURLE_OK ==
483 curl_easy_setopt (job->easy_handle,
484 CURLOPT_HTTPHEADER,
485 all_headers));
486}

References GNUNET_assert, GNUNET_break, 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 602 of file curl.c.

603{
604 struct GNUNET_CURL_Context *ctx = job->ctx;
605
607 ctx->jobs_tail,
608 job);
609 GNUNET_break (CURLM_OK ==
610 curl_multi_remove_handle (ctx->multi,
611 job->easy_handle));
612 curl_easy_cleanup (job->easy_handle);
613 GNUNET_free (job->db.buf);
614 curl_slist_free_all (job->job_headers);
615 ctx->cb (ctx->cb_cls);
617}
#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 87 of file curl_reschedule.c.

88{
90
92 rc->ctx = ctx;
94 rc->cleaner = &clean_result;
95 return rc;
96}
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, ctx, GNUNET_CURL_RescheduleContext::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 59 of file curl_reschedule.c.

62{
64
66 rctx->ctx = ctx;
67 rctx->parser = rp;
68 rctx->cleaner = rc;
69
70 return rctx;
71}

References GNUNET_CURL_RescheduleContext::cleaner, ctx, GNUNET_CURL_RescheduleContext::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 100 of file curl_reschedule.c.

101{
102 if (NULL != rc->task)
104 GNUNET_free (rc);
105}
void * GNUNET_SCHEDULER_cancel(struct GNUNET_SCHEDULER_Task *task)
Cancel the task with the specified identifier.
Definition: scheduler.c:980
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 166 of file curl_reschedule.c.

167{
168 struct GNUNET_CURL_RescheduleContext *rc = *(void **) cls;
169
170 if (NULL != rc->task)
173 rc);
174}
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:1304

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

284{
285 ctx->async_scope_id_header = header_name;
286}

References ctx.

◆ GNUNET_CURL_is_valid_scope_id()

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

291{
292 if (strlen (scope_id) >= 64)
293 return GNUNET_NO;
294 for (size_t i = 0; i < strlen (scope_id); i++)
295 if (! (isalnum (scope_id[i]) || (scope_id[i] == '-')))
296 return GNUNET_NO;
297 return GNUNET_YES;
298}
@ GNUNET_YES
@ GNUNET_NO

References GNUNET_NO, and GNUNET_YES.