#include <URLSessionTask.h>

Overview

URL session tasks are handles to pending URL operations.

Definition at line 68 of file URLSessionTask.h.

Inheritance diagram for URLSessionTask:

Properties
size_t	bytesExpectedToReceive
	The count of bytes this task expects to receive.

size_t	bytesExpectedToSend
	The count of bytes this task expects to send.

size_t	bytesReceived
	The count of bytes received.

size_t	bytesSent
	The count of bytes sent.

URLSessionTaskCompletion	completion
	The completion function.

ident	data
	User data.

char *	error
	The error buffer.

Object	object
	The superclass.

URLSessionTaskProgress	progress
	The progress function.

struct URLRequest *	request
	The request.

struct URLResponse *	response
	The response.

struct URLSession *	session
	The session.

URLSessionTaskState	state
	The state.

Properties inherited from Object
Class *	clazz
	Every instance of Object begins with a pointer to its Class.

unsigned int	magic
	A header to allow introspection of Object types.

Methods
Class *	_URLSessionTask (void)
	The URLSessionTask archetype.

void	cancel (URLSessionTask *)
	Cancels this task.

void	execute (URLSessionTask *)
	Executes this task synchronously, on the calling thread.

URLSessionTask *	initWithRequestInSession (URLSessionTask , struct URLRequest , struct URLSession *, URLSessionTaskCompletion)
	Initializes this task with the given URLRequest.

void	resume (URLSessionTask *)
	Starts or resumes this task.

void	setup (URLSessionTask *)
	Sets up this task.

void	suspend (URLSessionTask *)
	Suspends this task.

void	teardown (URLSessionTask *)
	Tears down this task.

Methods inherited from Object
Class *	_Object (void)
	The Object archetype.

Object *	copy (const Object *self)
	Creates a shallow copy of this Object.

void	dealloc (Object *self)
	Frees all resources held by this Object.

String *	description (const Object *self)

int	hash (const Object *self)

Object *	init (Object *self)
	Initializes this Object.

bool	isEqual (const Object self, const Object other)
	Tests equality of the other Object.

bool	isKindOfClass (const Object self, const Class clazz)
	Tests for Class hierarchy membership.

Protected Attributes
URLSessionTaskInterface *	interface
	The interface.

Protected Attributes inherited from Object
ObjectInterface *	interface
	The interface.

Property Details

◆ bytesExpectedToReceive

size_t URLSessionTask::bytesExpectedToReceive

The count of bytes this task expects to receive.

Definition at line 99 of file URLSessionTask.h.

◆ bytesExpectedToSend

size_t URLSessionTask::bytesExpectedToSend

The count of bytes this task expects to send.

Definition at line 104 of file URLSessionTask.h.

◆ bytesReceived

size_t URLSessionTask::bytesReceived

The count of bytes received.

Definition at line 109 of file URLSessionTask.h.

◆ bytesSent

size_t URLSessionTask::bytesSent

The count of bytes sent.

Definition at line 114 of file URLSessionTask.h.

◆ completion

URLSessionTaskCompletion URLSessionTask::completion

The completion function.

Definition at line 119 of file URLSessionTask.h.

◆ data

ident URLSessionTask::data

User data.

Definition at line 124 of file URLSessionTask.h.

◆ error

char* URLSessionTask::error

The error buffer.

Definition at line 129 of file URLSessionTask.h.

◆ handle

ident URLSessionTask::handle

The backing libcurl handle.

Definition at line 88 of file URLSessionTask.h.

◆ interface

URLSessionTaskInterface* URLSessionTask::interface

protected

The interface.

Definition at line 79 of file URLSessionTask.h.

◆ object

Object URLSessionTask::object

The superclass.

Definition at line 73 of file URLSessionTask.h.

◆ progress

URLSessionTaskProgress URLSessionTask::progress

The progress function.

Definition at line 134 of file URLSessionTask.h.

◆ request

struct URLRequest* URLSessionTask::request

The request.

Definition at line 139 of file URLSessionTask.h.

◆ requestHeaders

ident URLSessionTask::requestHeaders

HTTP headers, in libcurl list structure.

Definition at line 93 of file URLSessionTask.h.

◆ response

struct URLResponse* URLSessionTask::response

The response.

Definition at line 144 of file URLSessionTask.h.

◆ session

struct URLSession* URLSessionTask::session

The session.

Definition at line 149 of file URLSessionTask.h.

◆ state

URLSessionTaskState URLSessionTask::state

The state.

Definition at line 154 of file URLSessionTask.h.

Method Details

◆ _URLSessionTask()

Class * _URLSessionTask ( void )

The URLSessionTask archetype.

Returns: The URLSessionTask Class.

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

void cancel ( URLSessionTask * self )

Cancels this task.

Parameters

self	The URLSessionTask.

Definition at line 97 of file URLSessionDataTask.c.

                                         {
 
  URLSessionDataTask *this = (URLSessionDataTask *) self;
 
  if (this->cachedResponse) {
    if (this->urlSessionTask.state != URLSESSIONTASK_COMPLETED) {
      release(this->cachedResponse);
      this->cachedResponse = NULL;
      this->urlSessionTask.state = URLSESSIONTASK_CANCELED;
    }
 
    return;
  }
 
  super(URLSessionTask, self, cancel);
}

◆ execute()

void execute ( URLSessionTask * self )

Executes this task synchronously, on the calling thread.

Parameters

self	The URLSessionTask.

Remarks: Do not mix calls to execute with calls to resume.

Definition at line 117 of file URLSessionDataTask.c.

                                          {
 
  URLSessionDataTask *this = (URLSessionDataTask *) self;
 
  if (this->urlSessionTask.state == URLSESSIONTASK_CANCELED
      || this->urlSessionTask.state == URLSESSIONTASK_COMPLETED) {
    return;
  }
 
  if (this->cachedResponse) {
    materializeCachedResponse(this);
    this->urlSessionTask.state = URLSESSIONTASK_COMPLETED;
    return;
  }
 
  $(self, setup);
 
  CURLcode code = curl_easy_perform(self->locals.handle);
 
  curl_easy_getinfo(self->locals.handle, CURLINFO_RESPONSE_CODE, (long *) &self->response->httpStatusCode);
 
  this->urlSessionTask.state = URLSESSIONTASK_COMPLETED;
 
  if (code == CURLE_OK) {
    $(this, cacheResponse);
  }
 
  $(self, teardown);
}

◆ initWithRequestInSession()

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

Initializes this task with the given URLRequest.

Parameters

self	The URLSessionTask.
request	The request.
session	The session.
completion	The completion handler.

Returns: The initialized task, or NULL on error.

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;
}

◆ resume()

void resume ( URLSessionTask * self )

Starts or resumes this task.

Parameters

self	The URLSessionTask.

Definition at line 150 of file URLSessionDataTask.c.

                                         {
 
  URLSessionDataTask *this = (URLSessionDataTask *) self;
 
  if (this->cachedResponse) {
    switch (this->urlSessionTask.state) {
      case URLSESSIONTASK_SUSPENDING:
      case URLSESSIONTASK_SUSPENDED:
      case URLSESSIONTASK_RESUMING:
        materializeCachedResponse(this);
        this->urlSessionTask.state = URLSESSIONTASK_COMPLETED;
 
        if (this->urlSessionTask.completion) {
          this->urlSessionTask.completion((URLSessionTask *) this, true);
        }
        break;
      default:
        break;
    }
 
    return;
  }
 
  super(URLSessionTask, self, resume);
}

◆ setup()

void setup ( URLSessionTask * self )

Sets up this task.

Parameters

self	The URLSessionTask.

Definition at line 199 of file URLSessionDataTask.c.

                                        {
 
  super(URLSessionTask, self, setup);
 
  curl_easy_setopt(self->locals.handle, CURLOPT_WRITEFUNCTION, writeFunction);
  curl_easy_setopt(self->locals.handle, CURLOPT_WRITEDATA, self);
}

◆ suspend()

void suspend ( URLSessionTask * self )

Suspends this task.

Parameters

self	The URLSessionTask.

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

void teardown ( URLSessionTask * self )

Tears down this task.

Parameters

self	The URLSessionTask.

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;
  }
}

The documentation for this struct was generated from the following files:

Sources/Objectively/URLSessionTask.h
Sources/Objectively/URLSessionTask.c

Overview

Properties

Methods

Protected Attributes

Property Details

◆ bytesExpectedToReceive

◆ bytesExpectedToSend

◆ bytesReceived

◆ bytesSent

◆ completion

◆ data

◆ error

◆ handle

◆ interface

◆ object

◆ progress

◆ request

◆ requestHeaders

◆ response

◆ session

◆ state

Method Details

◆ _URLSessionTask()

◆ cancel()

◆ execute()

◆ initWithRequestInSession()

◆ resume()

◆ setup()

◆ suspend()

◆ teardown()