#include <URLSession.h>

Overview

A management context for loading resources via URLs.

Definition at line 57 of file URLSession.h.

Inheritance diagram for URLSession:

Properties
URLSessionConfiguration *	configuration
	The session configuration. More...

Object	object
	The superclass. More...

Condition *	condition
	The condition. More...

ident	handle
	The libcurl handle. More...

Lock *	lock
	The Lock guarding access to `tasks`. More...

MutableArray *	tasks
	The URLSessionTasks. More...

Thread *	thread
	The backing Thread. More...

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

Methods
Class *	_URLSession (void)
	The URLSession archetype. More...

URLSessionDataTask *	dataTaskWithRequest (URLSession , URLRequest , URLSessionTaskCompletion)
	Creates a URLSessionDataTask for the given URLRequest. More...

URLSessionDataTask *	dataTaskWithURL (URLSession , URL , URLSessionTaskCompletion)
	Creates a URLSessionDataTask for the given URL. More...

URLSessionDownloadTask *	downloadTaskWithRequest (URLSession , URLRequest , URLSessionTaskCompletion)
	Creates a URLSessionDownloadTask for the given URLRequest. More...

URLSessionDownloadTask *	downloadTaskWithURL (URLSession , URL , URLSessionTaskCompletion)
	Creates a URLSessionDownloadTask for the given URL. More...

URLSession *	init (URLSession *)
	Initializes this URLSession with a default configuration. More...

URLSession *	initWithConfiguration (URLSession , URLSessionConfiguration )
	Initializes this URLSession with the given configuration. More...

void	invalidateAndCancel (URLSession *)
	Invalidates this URLSession and cancels all pending tasks. More...

URLSession *	sharedInstance ()

Array *	tasks (const URLSession *)

URLSessionUploadTask *	uploadTaskWithRequest (URLSession , URLRequest , URLSessionTaskCompletion)
	Creates a URLSessionUploadTask for the given URLRequest. 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
URLSessionInterface *	interface
	The interface. More...

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

Property Details

◆ condition

Condition* URLSession::condition

The condition.

Definition at line 77 of file URLSession.h.

◆ configuration

URLSessionConfiguration* URLSession::configuration

The session configuration.

Definition at line 103 of file URLSession.h.

◆ handle

ident URLSession::handle

The libcurl handle.

Definition at line 82 of file URLSession.h.

◆ interface

URLSessionInterface* URLSession::interface

protected

The interface.

Definition at line 68 of file URLSession.h.

◆ lock

Lock* URLSession::lock

The Lock guarding access to tasks.

Definition at line 87 of file URLSession.h.

◆ object

Object URLSession::object

The superclass.

Definition at line 62 of file URLSession.h.

◆ tasks

MutableArray* URLSession::tasks

The URLSessionTasks.

Definition at line 92 of file URLSession.h.

◆ thread

Thread* URLSession::thread

The backing Thread.

Definition at line 97 of file URLSession.h.

Method Details

◆ _URLSession()

Class * _URLSession ( void )

The URLSession archetype.

Returns: The URLSession Class.

Definition at line 389 of file URLSession.c.

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

◆ dataTaskWithRequest()

URLSessionDataTask * dataTaskWithRequest	(	URLSession *	self,
		URLRequest *	request,
		URLSessionTaskCompletion	completion
	)

Creates a URLSessionDataTask for the given URLRequest.

Parameters

self	The URLSession.
request	The URLRequest to perform.
completion	The completion handler.

Returns: The URLSessionDataTask, or NULL on error.

Definition at line 76 of file URLSession.c.

                                                                                                                           {
 
    return taskWithRequest(self, alloc(URLSessionDataTask), request, completion);
}

◆ dataTaskWithURL()

URLSessionDataTask * dataTaskWithURL	(	URLSession *	self,
		URL *	url,
		URLSessionTaskCompletion	completion
	)

Creates a URLSessionDataTask for the given URL.

Parameters

self	The URLSession.
url	The URL to `GET`.
completion	The completion handler.

Returns: The URLSessionDataTask, or NULL on error.

Definition at line 85 of file URLSession.c.

                                                                                                            {
 
    URLRequest *request = $(alloc(URLRequest), initWithURL, url);
 
    URLSessionDataTask *task = $(self, dataTaskWithRequest, request, completion);
 
    release(request);
 
    return task;
}

◆ downloadTaskWithRequest()

URLSessionDownloadTask * downloadTaskWithRequest	(	URLSession *	self,
		URLRequest *	request,
		URLSessionTaskCompletion	completion
	)

Creates a URLSessionDownloadTask for the given URLRequest.

Parameters

self	The URLSession.
request	The URLRequest to perform.
completion	The completion handler.

Returns: The URLSessionDownloadTask, or NULL on error.

Definition at line 100 of file URLSession.c.

                                                                                                                                   {
 
    return taskWithRequest(self, alloc(URLSessionDownloadTask), request, completion);
}

◆ downloadTaskWithURL()

URLSessionDownloadTask * downloadTaskWithURL	(	URLSession *	self,
		URL *	url,
		URLSessionTaskCompletion	completion
	)

Creates a URLSessionDownloadTask for the given URL.

Parameters

self	The URLSession.
url	The URL to `GET`.
completion	The completion handler.

Returns: The URLSessionDownloadTask, or NULL on error.

Definition at line 109 of file URLSession.c.

                                                                                                                    {
 
    URLRequest *request = $(alloc(URLRequest), initWithURL, url);
 
    URLSessionDownloadTask *task = $(self, downloadTaskWithRequest, request, completion);
 
    release(request);
 
    return task;
}

◆ init()

URLSession * init ( URLSession * self )

Initializes this URLSession with a default configuration.

Parameters

self	The URLSession.

Returns: The initialized URLSession, or NULL on error.

Definition at line 124 of file URLSession.c.

                                          {
 
    URLSessionConfiguration *configuration = $(alloc(URLSessionConfiguration), init);
 
    self = $(self, initWithConfiguration, configuration);
 
    release(configuration);
 
    return self;
}

◆ initWithConfiguration()

URLSession * initWithConfiguration	(	URLSession *	self,
		URLSessionConfiguration *	configuration
	)

Initializes this URLSession with the given configuration.

Parameters

self	The URLSession.
configuration	The URLSessionConfiguration.

Returns: The initialized URLSession, or NULL on error.

Definition at line 267 of file URLSession.c.

                                                                                                   {
 
    assert(configuration);
 
    self = (URLSession *) super(Object, self, init);
    if (self) {
        self->configuration = retain(configuration);
 
        self->locals.condition = $(alloc(Condition), init);
        self->locals.lock = $(alloc(Lock), init);
        self->locals.tasks = $(alloc(MutableArray), init);
        self->locals.thread = $(alloc(Thread), initWithFunction, run, self);
 
        $(self->locals.thread, start);
    }
 
    return self;
}

◆ invalidateAndCancel()

void invalidateAndCancel ( URLSession * self )

Invalidates this URLSession and cancels all pending tasks.

Parameters

self	The URLSession.

Definition at line 290 of file URLSession.c.

                                                  {
 
    if (self->locals.thread->isCancelled) {
        return;
    }
 
    Array *tasks = $(self, tasks);
 
    for (size_t i = 0; i < tasks->count; i++) {
 
        URLSessionTask *task = $(tasks, objectAtIndex, i);
        $(task, cancel);
    }
 
    release(tasks);
 
    $(self->locals.thread, cancel);
    $(self->locals.condition, signal);
}

◆ sharedInstance()

URLSession * sharedInstance ( void )

Returns: The shared URLSession instance.

Definition at line 212 of file Log.c.

                                 {
 
    static Once once;
 
    do_once(&once, {
        _sharedInstance = $(alloc(Log), init);
    });
 
    return _sharedInstance;
}

◆ tasks()

Array * tasks ( const URLSession * self )

Parameters

self	The URLSession.

Returns: An instantaneous copy of this URLSession's URLSessionTasks.

Definition at line 331 of file URLSession.c.

                                            {
 
    Array *array;
 
    synchronized(self->locals.lock, {
        array = $$(Array, arrayWithArray, (Array *) self->locals.tasks);
    });
 
    return array;
}

◆ uploadTaskWithRequest()

URLSessionUploadTask * uploadTaskWithRequest	(	URLSession *	self,
		URLRequest *	request,
		URLSessionTaskCompletion	completion
	)

Creates a URLSessionUploadTask for the given URLRequest.

Parameters

self	The URLSession.
request	The URLRequest to perform.
completion	The completion handler.

Returns: The URLSessionUploadTask, or NULL on error.

Definition at line 346 of file URLSession.c.

                                                                                                                               {
 
    return taskWithRequest(self, alloc(URLSessionUploadTask), request, completion);
}

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

Sources/Objectively/URLSession.h
Sources/Objectively/URLSession.c

Overview

Properties

Methods

Protected Attributes

Property Details

◆ condition

◆ configuration

◆ handle

◆ interface

◆ lock

◆ object

◆ tasks

◆ thread

Method Details

◆ _URLSession()

◆ dataTaskWithRequest()

◆ dataTaskWithURL()

◆ downloadTaskWithRequest()

◆ downloadTaskWithURL()

◆ init()

◆ initWithConfiguration()

◆ invalidateAndCancel()

◆ sharedInstance()

◆ tasks()

◆ uploadTaskWithRequest()