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_Context *	GNUNET_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_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. More...
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. 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_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. More...
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. 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_RescheduleContext *	GNUNET_CURL_gnunet_rc_create (struct GNUNET_CURL_Context *ctx)
	Initialize reschedule context. More...
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. 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

cls

closure

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

db	the raw data
eh	handle
response_code	HTTP 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

response

object 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

cls	closure
response_code	HTTP response code from server, 0 on hard error
response	in 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

cls	closure
response_code	HTTP response code from server, 0 on hard error
body	http body of the response
body_size	number 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

cb	function to call when rescheduling is required
cb_cls	closure for cb

Returns

library context

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

{
  struct GNUNET_CURL_Context *ctx;
  CURLM *multi;
  CURLSH *share;

  if (curl_fail)
  {
    GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
                "Curl was not initialised properly\n");
    return NULL;
  }
  if (NULL == (multi = curl_multi_init ()))
  {
    GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
                "Failed to create a Curl multi handle\n");
    return NULL;
  }
  if (NULL == (share = curl_share_init ()))
  {
    GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
                "Failed to create a Curl share handle\n");
    return NULL;
  }
  ctx = GNUNET_new (struct GNUNET_CURL_Context);
  ctx->cb = cb;
  ctx->cb_cls = cb_cls;
  ctx->multi = multi;
  ctx->share = share;
  return ctx;
}

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

ctx	context to get the event loop information for
read_fd_set	will be set for any pending read operations
write_fd_set	will be set for any pending write operations
except_fd_set	is here because curl_multi_fdset() has this argument
max_fd	set 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().)
timeout	set 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

ctx	context to get the event loop information for
read_fd_set	will be set for any pending read operations
write_fd_set	will be set for any pending write operations
except_fd_set	is here because curl_multi_fdset() has this argument
max_fd	set 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().)
timeout	set 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 1012 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().

{
  long to;
  int m;

  m = -1;
  GNUNET_assert (CURLM_OK == curl_multi_fdset (ctx->multi,
                                               read_fd_set,
                                               write_fd_set,
                                               except_fd_set,
                                               &m));
  to = *timeout;
  *max_fd = GNUNET_MAX (m, *max_fd);
  GNUNET_assert (CURLM_OK == curl_multi_timeout (ctx->multi, &to));

  /* Only if what we got back from curl is smaller than what we
     already had (-1 == infinity!), then update timeout */
  if ((to < *timeout) && (-1 != to))
    *timeout = to;
  if ((-1 == (*timeout)) && (NULL != ctx->jobs_head))
    *timeout = to;
}

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

ctx	cURL context.
header	header string; will be given to the context AS IS.

Returns

GNUNET_OK if no errors occurred, GNUNET_SYSERR otherwise.

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

{
  ctx->common_headers = curl_slist_append (ctx->common_headers, header);
  if (NULL == ctx->common_headers)
    return GNUNET_SYSERR;

  return GNUNET_OK;
}

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

ctx	the library context

Run the main event loop for the CURL interaction.

Parameters

ctx	the library context

Definition at line 975 of file curl.c.

References GNUNET_CURL_download_get_result_(), and GNUNET_CURL_perform2().

{
  GNUNET_CURL_perform2 (ctx,
                        &GNUNET_CURL_download_get_result_,
                        (GNUNET_CURL_ResponseCleaner) & json_decref);
}

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

ctx	the library context
rp	parses the raw response returned from the Web server.
rc	cleans/frees the response

Definition at line 915 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().

{
  CURLMsg *cmsg;
  int n_running;
  int n_completed;

  (void) curl_multi_perform (ctx->multi,
                             &n_running);
  while (NULL != (cmsg = curl_multi_info_read (ctx->multi, &n_completed)))
  {
    struct GNUNET_CURL_Job *job;
    long response_code;
    void *response;

    /* Only documented return value is CURLMSG_DONE */
    GNUNET_break (CURLMSG_DONE == cmsg->msg);
    GNUNET_assert (CURLE_OK == curl_easy_getinfo (cmsg->easy_handle,
                                                  CURLINFO_PRIVATE,
                                                  (char **) &job));
    GNUNET_assert (job->ctx == ctx);
    response_code = 0;
    if (NULL != job->jcc_raw)
    {
      /* RAW mode, no parsing */
      GNUNET_break (CURLE_OK ==
                    curl_easy_getinfo (job->easy_handle,
                                       CURLINFO_RESPONSE_CODE,
                                       &response_code));
      job->jcc_raw (job->jcc_raw_cls,
                    response_code,
                    job->db.buf,
                    job->db.buf_size);
    }
    else
    {
      /* to be parsed via 'rp' */
      response = rp (&job->db,
                     job->easy_handle,
                     &response_code);
      job->jcc (job->jcc_cls,
                response_code,
                response);
      rc (response);
    }
#if ENABLE_BENCHMARK
    do_benchmark (cmsg);
#endif
    GNUNET_CURL_job_cancel (job);
  }
}

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

ctx	the library context

Definition at line 1049 of file curl.c.

References GNUNET_CURL_Context::certfile, GNUNET_CURL_Context::certtype, GNUNET_CURL_Context::common_headers, GNUNET_assert, GNUNET_free, GNUNET_CURL_Context::jobs_head, GNUNET_CURL_Context::keyfile, GNUNET_CURL_Context::keypass, GNUNET_CURL_Context::multi, GNUNET_CURL_Context::share, and GNUNET_CURL_Context::userpass.

{
  /* all jobs must have been cancelled at this time, assert this */
  GNUNET_assert (NULL == ctx->jobs_head);
  curl_share_cleanup (ctx->share);
  curl_multi_cleanup (ctx->multi);
  curl_slist_free_all (ctx->common_headers);
  GNUNET_free (ctx->userpass);
  GNUNET_free (ctx->certtype);
  GNUNET_free (ctx->certfile);
  GNUNET_free (ctx->keyfile);
  GNUNET_free (ctx->keypass);
  GNUNET_free (ctx);
}

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

ctx	context to execute the job in
eh	curl easy handle for the request, will be executed AND cleaned up
jcc	callback to invoke upon completion
jcc_cls	closure for jcc

Returns

NULL on error (in this case, is still released!)

Definition at line 657 of file curl.c.

References GNUNET_CURL_job_add2().

{
  return GNUNET_CURL_job_add2 (ctx,
                               eh,
                               NULL,
                               jcc,
                               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

ctx	context to execute the job in
eh	curl easy handle for the request, will be executed AND cleaned up
jcc	callback to invoke upon completion
jcc_cls	closure for jcc

Returns

NULL on error (in this case, is still released!)

Definition at line 623 of file curl.c.

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

{
  struct GNUNET_CURL_Job *job;
  struct curl_slist *job_headers = NULL;

  GNUNET_assert (NULL != (job_headers =
                            curl_slist_append (NULL,
                                               "Content-Type: application/json")));
  job = GNUNET_CURL_job_add2 (ctx,
                              eh,
                              job_headers,
                              jcc,
                              jcc_cls);
  curl_slist_free_all (job_headers);
  return 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

ctx	context to set authentication data for
userpass	string with "$USERNAME:$PASSWORD"

Definition at line 213 of file curl.c.

References GNUNET_free, GNUNET_strdup, and GNUNET_CURL_Context::userpass.

{
  GNUNET_free (ctx->userpass);
  if (NULL != userpass)
    ctx->userpass = GNUNET_strdup (userpass);
}

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

ctx	context to set authentication data for
certtype	type of the certificate
certfile	file with the certificate
keyfile	file with the private key
keypass	passphrase to decrypt keyfile (or NULL)

Definition at line 238 of file curl.c.

References GNUNET_CURL_Context::certfile, GNUNET_CURL_Context::certtype, GNUNET_free, GNUNET_strdup, GNUNET_CURL_Context::keyfile, and GNUNET_CURL_Context::keypass.

{
  GNUNET_free (ctx->certtype);
  GNUNET_free (ctx->certfile);
  GNUNET_free (ctx->keyfile);
  GNUNET_free (ctx->keypass);
  if (NULL != certtype)
    ctx->certtype = GNUNET_strdup (certtype);
  if (NULL != certfile)
    ctx->certfile = GNUNET_strdup (certfile);
  if (NULL != keyfile)
    ctx->certtype = GNUNET_strdup (keyfile);
  if (NULL != keypass)
    ctx->certtype = GNUNET_strdup (keypass);
}

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

ctx	context to execute the job in
eh	curl easy handle for the request, will be executed AND cleaned up
job_headers	extra headers to add for this request
jcc	callback to invoke upon completion
jcc_cls	closure 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

ctx	context to execute the job in
eh	curl 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 overridden by jcc. Therefore, always pass custom headers as the job_headers parameter.
job_headers	extra headers to add for this request
jcc	callback to invoke upon completion
jcc_cls	closure for jcc

Returns

NULL on error (in this case, is still released!)

Definition at line 557 of file curl.c.

References GNUNET_CURL_Context::cb, GNUNET_CURL_Context::cb_cls, GNUNET_CURL_Context::certfile, GNUNET_CURL_Context::certtype, GNUNET_assert, GNUNET_CURL_Job::jcc, GNUNET_CURL_Job::jcc_cls, job, GNUNET_CURL_Context::keyfile, GNUNET_CURL_Context::keypass, setup_job(), setup_job_headers(), and GNUNET_CURL_Context::userpass.

Referenced by GNUNET_CURL_job_add(), and GNUNET_CURL_job_add_with_ct_json().

{
  struct GNUNET_CURL_Job *job;
  struct curl_slist *all_headers;

  GNUNET_assert (NULL != jcc);
  if ( (NULL != ctx->userpass) &&
       (0 != curl_easy_setopt (eh,
                               CURLOPT_USERPWD,
                               ctx->userpass)) )
    return NULL;
  if ( (NULL != ctx->certfile) &&
       (0 != curl_easy_setopt (eh,
                               CURLOPT_SSLCERT,
                               ctx->certfile)) )
    return NULL;
  if ( (NULL != ctx->certtype) &&
       (0 != curl_easy_setopt (eh,
                               CURLOPT_SSLCERTTYPE,
                               ctx->certtype)) )
    return NULL;
  if ( (NULL != ctx->keyfile) &&
       (0 != curl_easy_setopt (eh,
                               CURLOPT_SSLKEY,
                               ctx->keyfile)) )
    return NULL;
  if ( (NULL != ctx->keypass) &&
       (0 != curl_easy_setopt (eh,
                               CURLOPT_KEYPASSWD,
                               ctx->keypass)) )
    return NULL;

  all_headers = setup_job_headers (ctx,
                                   job_headers);
  if (NULL == (job = setup_job (eh,
                                ctx,
                                all_headers)))
    return NULL;

  job->jcc = jcc;
  job->jcc_cls = jcc_cls;
  ctx->cb (ctx->cb_cls);
  return job;
}

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

ctx	context to execute the job in
eh	curl easy handle for the request, will be executed AND cleaned up
job_headers	extra headers to add for this request
max_reply_size	largest acceptable response body
jcc	callback to invoke upon completion
jcc_cls	closure for jcc

Returns

NULL on error (in this case, is still released!)

Definition at line 514 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().

{
  struct GNUNET_CURL_Job *job;
  struct curl_slist *all_headers;

  GNUNET_assert (NULL != jcc);
  all_headers = setup_job_headers (ctx,
                                   job_headers);
  if (NULL == (job = setup_job (eh,
                                ctx,
                                all_headers)))
    return NULL;
  job->jcc_raw = jcc;
  job->jcc_raw_cls = jcc_cls;
  ctx->cb (ctx->cb_cls);
  return job;
}

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]	job	the job to modify
	extra_headers	headers to append

Definition at line 481 of file curl.c.

References GNUNET_assert, and GNUNET_CURL_Job::job_headers.

{
  struct curl_slist *all_headers = job->job_headers;

  for (const struct curl_slist *curr = extra_headers;
       NULL != curr;
       curr = curr->next)
  {
    GNUNET_assert (NULL !=
                   (all_headers = curl_slist_append (all_headers,
                                                     curr->data)));
  }
  job->job_headers = all_headers;
}

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

job	job to cancel

Definition at line 677 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_CURL_Job::job_headers, GNUNET_CURL_Context::jobs_head, GNUNET_CURL_Context::jobs_tail, and GNUNET_CURL_Context::multi.

Referenced by GNUNET_CURL_perform2().

{
  struct GNUNET_CURL_Context *ctx = job->ctx;

  GNUNET_CONTAINER_DLL_remove (ctx->jobs_head, ctx->jobs_tail, job);
  GNUNET_break (CURLM_OK ==
                curl_multi_remove_handle (ctx->multi, job->easy_handle));
  curl_easy_cleanup (job->easy_handle);
  GNUNET_free (job->db.buf);
  curl_slist_free_all (job->job_headers);
  ctx->cb (ctx->cb_cls);
  GNUNET_free (job);
}

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

ctx	context 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.

{
  struct GNUNET_CURL_RescheduleContext *rc;

  rc = GNUNET_new (struct GNUNET_CURL_RescheduleContext);
  rc->ctx = ctx;
  rc->parser = &GNUNET_CURL_download_get_result_;
  rc->cleaner = &clean_result;
  return rc;
}

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

ctx	context 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.

{
  struct GNUNET_CURL_RescheduleContext *rctx;

  rctx = GNUNET_new (struct GNUNET_CURL_RescheduleContext);
  rctx->ctx = ctx;
  rctx->parser = rp;
  rctx->cleaner = rc;

  return rctx;
}

GNUNET_CURL_gnunet_rc_destroy()

void GNUNET_CURL_gnunet_rc_destroy

(

struct GNUNET_CURL_RescheduleContext *

rc

)

Destroy reschedule context.

Parameters

rc	context to destroy

Definition at line 121 of file curl_reschedule.c.

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

{
  if (NULL != rc->task)
    GNUNET_SCHEDULER_cancel (rc->task);
  GNUNET_free (rc);
}

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

cls	must 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.

{
  struct GNUNET_CURL_RescheduleContext *rc = *(void **) cls;

  if (NULL != rc->task)
    GNUNET_SCHEDULER_cancel (rc->task);
  rc->task = GNUNET_SCHEDULER_add_now (&context_task, rc);
}

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

ctx	the context to enable this for
header_name	name of the header to send.

Definition at line 309 of file curl.c.

References GNUNET_CURL_Context::async_scope_id_header.

{
  ctx->async_scope_id_header = header_name;
}

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

See setup_job_headers, logic related to GNUNET_CURL_enable_async_scope_header() for the code that generates such a scope_id.

Returns

GNUNET_YES iff given a valid scope ID

Definition at line 326 of file curl.c.

References GNUNET_NO, and GNUNET_YES.

{
  if (strlen (scope_id) >= 64)
    return GNUNET_NO;
  for (size_t i = 0; i < strlen (scope_id); i++)
    if (! (isalnum (scope_id[i]) || (scope_id[i] == '-')))
      return GNUNET_NO;
  return GNUNET_YES;
}