#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. More...

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

size_t	bytesReceived
	The count of bytes received. More...

size_t	bytesSent
	The count of bytes sent. More...

URLSessionTaskCompletion	completion
	The completion function. More...

ident	data
	User data. More...

char *	error
	The error buffer. More...

Object	object
	The superclass. More...

URLSessionTaskProgress	progress
	The progress function. More...

struct URLRequest *	request
	The request. More...

struct URLResponse *	response
	The response. More...

struct URLSession *	session
	The session. More...

URLSessionTaskState	state
	The state. More...

ident	handle
	The backing libcurl handle. More...

ident	requestHeaders
	HTTP headers, in libcurl list structure. More...

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

Methods
Class *	_URLSessionTask (void)
	The URLSessionTask archetype. More...

void	cancel (URLSessionTask *)
	Cancels this task. More...

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

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

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

void	setup (URLSessionTask *)
	Sets up this task. More...

void	suspend (URLSessionTask *)
	Suspends this task. More...

void	teardown (URLSessionTask *)
	Tears down this task. More...

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

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

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

String *	description (const Object *self)

int	hash (const Object *self)

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

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

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

Protected Attributes
URLSessionTaskInterface *	interface
	The interface. More...

Protected Attributes inherited from Object
ObjectInterface *	interface
	The interface. More...

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

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

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

◆ 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 134 of file URLSessionTask.c.

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

◆ setup()

void setup ( URLSessionTask * self )

Sets up this task.

Parameters

self	The URLSessionTask.

Definition at line 75 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 272 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 288 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()