URLSessionTask.c File Reference

#include <assert.h>
#include <string.h>
#include <stdlib.h>
#include <curl/curl.h>
#include "URLRequest.h"
#include "URLResponse.h"
#include "URLSession.h"
#include "URLSessionTask.h"

Go to the source code of this file.

Macros
#define	_Class   _URLSessionTask

Functions
Class *	_URLSessionTask (void)
static void	cancel (URLSessionTask *self)
static Object *	copy (const Object *self)
static void	dealloc (Object *self)
static void	execute (URLSessionTask *self)
static void	initialize (Class *clazz)
static URLSessionTask *	initWithRequestInSession (URLSessionTask *self, struct URLRequest *request, struct URLSession *session, URLSessionTaskCompletion completion)
static int	progress (ident self, curl_off_t bytesExpectedToReceive, curl_off_t bytesReceived, curl_off_t bytesExpectedToSend, curl_off_t bytesSent)
	The CURLOPT_XFERINFOFUNCTION, which updates internal state and dispatches the task's progress function.
static void	requestHeaders_enumerator (const Dictionary *dictionary, ident obj, ident key, ident data)
	A helper to populate the request headers list for CURL.
static size_t	responseHeader (char *buffer, size_t size, size_t count, void *data)
	The CURLOPT_HEADERFUNCTION for parsing response headers.
static void	resume (URLSessionTask *self)
static void	setup (URLSessionTask *self)
static void	suspend (URLSessionTask *self)
static void	teardown (URLSessionTask *self)

Macro Definition Documentation

_Class

#define _Class   _URLSessionTask

Definition at line 34 of file URLSessionTask.c.

Function Documentation

_URLSessionTask()

Class * _URLSessionTask

(

void

)

Definition at line 342 of file URLSessionTask.c.

                             {
  static Class *clazz;
  static Once once;
 
  do_once(&once, {
    clazz = _initialize(&(const ClassDef) {
      .name = "URLSessionTask",
      .superclass = _Object(),
      .instanceSize = sizeof(URLSessionTask),
      .interfaceOffset = offsetof(URLSessionTask, interface),
      .interfaceSize = sizeof(URLSessionTaskInterface),
      .initialize = initialize,
    });
  });
 
  return clazz;
}

cancel()

static void cancel ( URLSessionTask *  self )

static

Definition at line 70 of file URLSessionTask.c.

                                         {
 
  switch (self->state) {
    case URLSESSIONTASK_RESUMING:
    case URLSESSIONTASK_RESUMED:
    case URLSESSIONTASK_SUSPENDING:
    case URLSESSIONTASK_SUSPENDED:
      self->state = URLSESSIONTASK_CANCELING;
      break;
    default:
      break;
  }
}

copy()

static Object * copy ( const Object *  self )

static

See also

Object::copy(const Object *)

Definition at line 41 of file URLSessionTask.c.

                                        {
 
  return NULL;
}

dealloc()

static void dealloc ( Object *  self )

static

See also

Object::dealloc(Object *)

Definition at line 49 of file URLSessionTask.c.

                                  {
 
  URLSessionTask *this = (URLSessionTask *) self;
 
  if (this->error) {
    free(this->error);
  }
 
  release(this->request);
  release(this->session);
  release(this->response);
 
  super(Object, self, dealloc);
}

execute()

static void execute ( URLSessionTask *  self )

static

Definition at line 88 of file URLSessionTask.c.

                                          {
 
  $(self, setup);
 
  curl_easy_perform(self->locals.handle);
 
  curl_easy_getinfo(self->locals.handle, CURLINFO_RESPONSE_CODE, (long *) &self->response->httpStatusCode);
 
  self->state = URLSESSIONTASK_COMPLETED;
 
  $(self, teardown);
}

initialize()

static void initialize ( Class *  clazz )

static

See also

Class::initialize(Class *)

Definition at line 324 of file URLSessionTask.c.

                                     {
 
  ((ObjectInterface *) clazz->interface)->copy = copy;
  ((ObjectInterface *) clazz->interface)->dealloc = dealloc;
 
  ((URLSessionTaskInterface *) clazz->interface)->cancel = cancel;
  ((URLSessionTaskInterface *) clazz->interface)->execute = execute;
  ((URLSessionTaskInterface *) clazz->interface)->initWithRequestInSession = initWithRequestInSession;
  ((URLSessionTaskInterface *) clazz->interface)->resume = resume;
  ((URLSessionTaskInterface *) clazz->interface)->setup = setup;
  ((URLSessionTaskInterface *) clazz->interface)->suspend = suspend;
  ((URLSessionTaskInterface *) clazz->interface)->teardown = teardown;
}

initWithRequestInSession()

static URLSessionTask * initWithRequestInSession ( URLSessionTask *  self, struct URLRequest *  request, struct URLSession *  session, URLSessionTaskCompletion  completion  )

static

Definition at line 105 of file URLSessionTask.c.

                                                                     {
 
  assert(request);
  assert(session);
 
  self = (URLSessionTask *) super(Object, self, init);
  if (self) {
 
    self->error = calloc(1, CURL_ERROR_SIZE);
    assert(self->error);
 
    self->request = retain(request);
    self->session = retain(session);
 
    self->response = $(alloc(URLResponse), init);
 
    self->completion = completion;
 
    self->state = URLSESSIONTASK_SUSPENDED;
  }
 
  return self;
}

progress()

static int progress ( ident  self, curl_off_t  bytesExpectedToReceive, curl_off_t  bytesReceived, curl_off_t  bytesExpectedToSend, curl_off_t  bytesSent  )

static

The CURLOPT_XFERINFOFUNCTION, which updates internal state and dispatches the task's progress function.

Remarks

This is also the mechanism for resuming suspended tasks.

Definition at line 190 of file URLSessionTask.c.

                                                          {
 
  URLSessionTask *this = (URLSessionTask *) self;
 
  curl_easy_getinfo(this->locals.handle, CURLINFO_RESPONSE_CODE, (long *) &this->response->httpStatusCode);
 
  this->bytesExpectedToReceive = bytesExpectedToReceive;
  this->bytesExpectedToSend = bytesExpectedToSend;
 
  if (this->progress) {
    this->progress(this);
  }
 
  return 0;
}

requestHeaders_enumerator()

static void requestHeaders_enumerator ( const Dictionary *  dictionary, ident  obj, ident  key, ident  data  )

static

A helper to populate the request headers list for CURL.

Definition at line 149 of file URLSessionTask.c.

                                                                                                      {
 
  String *header = $(alloc(String), initWithFormat, "%s: %s", ((String * ) key)->chars, ((String * ) obj)->chars);
 
  struct curl_slist **headers = (struct curl_slist **) data;
  *headers = curl_slist_append(*headers, header->chars);
 
  release(header);
}

responseHeader()

static size_t responseHeader ( char *  buffer, size_t  size, size_t  count, void *  data  )

static

The CURLOPT_HEADERFUNCTION for parsing response headers.

Definition at line 162 of file URLSessionTask.c.

                                                                                  {
 
  URLSessionTask *this = (URLSessionTask *) data;
 
  char *header = calloc(count + 1, 1);
  memcpy(header, buffer, count);
 
  char *delim = strchr(header, ':');
  if (delim) {
    *delim = 0;
 
    char *field = header;
    char *value = strtrim(delim + 1);
 
    $(this->response, setValueForHTTPHeaderField, value, field);
 
    free(value);
  }
 
  free(header);
  return count;
}

resume()

static void resume ( URLSessionTask *  self )

static

Definition at line 134 of file URLSessionTask.c.

                                         {
 
  switch (self->state) {
    case URLSESSIONTASK_SUSPENDING:
    case URLSESSIONTASK_SUSPENDED:
      self->state = URLSESSIONTASK_RESUMING;
      break;
    default:
      break;
  }
}

setup()

static void setup ( URLSessionTask *  self )

static

Definition at line 211 of file URLSessionTask.c.

                                        {
 
  self->locals.handle = curl_easy_init();
  assert(self->locals.handle);
 
  curl_easy_setopt(self->locals.handle, CURLOPT_ERRORBUFFER, self->error);
  curl_easy_setopt(self->locals.handle, CURLOPT_FOLLOWLOCATION, true);
 
  const URLSessionConfiguration *config = self->session->configuration;
  if (config->connectTimeout) {
    curl_easy_setopt(self->locals.handle, CURLOPT_CONNECTTIMEOUT, config->connectTimeout);
  }
  if (config->timeout) {
    curl_easy_setopt(self->locals.handle, CURLOPT_TIMEOUT, config->timeout);
  }
  if (!config->longPolling) {
    curl_easy_setopt(self->locals.handle, CURLOPT_LOW_SPEED_LIMIT, 1L);
    curl_easy_setopt(self->locals.handle, CURLOPT_LOW_SPEED_TIME, 10L);
  }
 
  curl_easy_setopt(self->locals.handle, CURLOPT_HEADERFUNCTION, responseHeader);
  curl_easy_setopt(self->locals.handle, CURLOPT_HEADERDATA, self);
 
  curl_easy_setopt(self->locals.handle, CURLOPT_XFERINFOFUNCTION, progress);
  curl_easy_setopt(self->locals.handle, CURLOPT_XFERINFODATA, self);
 
  Data *body = self->request->httpBody;
  if (body) {
    curl_easy_setopt(self->locals.handle, CURLOPT_POSTFIELDS, body->bytes);
    curl_easy_setopt(self->locals.handle, CURLOPT_POSTFIELDSIZE, body->length);
  }
 
  struct curl_slist *httpHeaders = NULL;
  const Dictionary *headers = NULL;
 
  headers = self->session->configuration->httpHeaders;
  if (headers) {
    $(headers, enumerateObjectsAndKeys, requestHeaders_enumerator, &httpHeaders);
  }
 
  headers = self->request->httpHeaders;
  if (headers) {
    $(headers, enumerateObjectsAndKeys, requestHeaders_enumerator, &httpHeaders);
  }
 
  curl_easy_setopt(self->locals.handle, CURLOPT_HTTPHEADER, httpHeaders);
 
  self->locals.requestHeaders = httpHeaders;
 
  switch (self->request->httpMethod) {
    case HTTP_POST:
      curl_easy_setopt(self->locals.handle, CURLOPT_POST, true);
      break;
    case HTTP_PUT:
      curl_easy_setopt(self->locals.handle, CURLOPT_PUT, true);
      break;
    case HTTP_DELETE:
      curl_easy_setopt(self->locals.handle, CURLOPT_CUSTOMREQUEST, "DELETE");
      break;
    case HTTP_PATCH:
      curl_easy_setopt(self->locals.handle, CURLOPT_CUSTOMREQUEST, "PATCH");
      break;
    case HTTP_HEAD:
      curl_easy_setopt(self->locals.handle, CURLOPT_NOBODY, true);
      break;
    case HTTP_OPTIONS:
      curl_easy_setopt(self->locals.handle, CURLOPT_CUSTOMREQUEST, "OPTIONS");
      break;
    default:
      break;
  }
 
  curl_easy_setopt(self->locals.handle, CURLOPT_URL, self->request->url->urlString->chars);
}

suspend()

static void suspend ( URLSessionTask *  self )

static

Definition at line 290 of file URLSessionTask.c.

                                          {
 
  switch (self->state) {
    case URLSESSIONTASK_RESUMING:
    case URLSESSIONTASK_RESUMED:
      self->state = URLSESSIONTASK_SUSPENDING;
      break;
    default:
      break;
  }
}

teardown()

static void teardown ( URLSessionTask *  self )

static

Definition at line 306 of file URLSessionTask.c.

                                           {
 
  if (self->locals.handle) {
    curl_easy_cleanup(self->locals.handle);
    self->locals.handle = NULL;
  }
 
  if (self->locals.requestHeaders) {
    curl_slist_free_all(self->locals.requestHeaders);
    self->locals.requestHeaders = NULL;
  }
}