#include <URLSessionConfiguration.h>

Overview

Configuration bundle for URLSession.

Definition at line 44 of file URLSessionConfiguration.h.

Inheritance diagram for URLSessionConfiguration:

Properties
long	connectTimeout
	The timeout interval for establishing a connection, in seconds. 0 means no limit.

struct {

String * password
	The password. More...

String * username
	The username. More...

}	credentials
	Credentials for URLRequests requiring authentication.

Dictionary *	httpHeaders
	The HTTP headers added to every HTTP URLRequest.

int	httpMaximumConnectionsPerHost
	The maximum number of HTTP connections to open per host.

bool	longPolling
	If true, disables stall detection (LOW_SPEED_LIMIT / LOW_SPEED_TIME). Use for requests that legitimately expect long periods of silence.

Object	object
	The superclass.

long	timeout
	The timeout for the entire transfer, in seconds. 0 means no limit.

URLCache *	urlCache
	The cache for URL responses, or `NULL` to disable caching.

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 *	_URLSessionConfiguration (void)
	The URLSessionConfiguration archetype.

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

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
URLSessionConfigurationInterface *	interface
	The interface.

Protected Attributes inherited from Object
ObjectInterface *	interface
	The interface.

Property Details

◆ connectTimeout

long URLSessionConfiguration::connectTimeout

The timeout interval for establishing a connection, in seconds. 0 means no limit.

Definition at line 86 of file URLSessionConfiguration.h.

◆ [struct]

struct { ... } URLSessionConfiguration::credentials

Credentials for URLRequests requiring authentication.

◆ httpHeaders

Dictionary* URLSessionConfiguration::httpHeaders

The HTTP headers added to every HTTP URLRequest.

Definition at line 76 of file URLSessionConfiguration.h.

◆ httpMaximumConnectionsPerHost

int URLSessionConfiguration::httpMaximumConnectionsPerHost

The maximum number of HTTP connections to open per host.

Definition at line 81 of file URLSessionConfiguration.h.

◆ interface

URLSessionConfigurationInterface* URLSessionConfiguration::interface

protected

The interface.

Definition at line 55 of file URLSessionConfiguration.h.

◆ longPolling

bool URLSessionConfiguration::longPolling

If true, disables stall detection (LOW_SPEED_LIMIT / LOW_SPEED_TIME). Use for requests that legitimately expect long periods of silence.

Definition at line 97 of file URLSessionConfiguration.h.

◆ object

Object URLSessionConfiguration::object

The superclass.

Definition at line 49 of file URLSessionConfiguration.h.

◆ password

String* URLSessionConfiguration::password

The password.

Definition at line 69 of file URLSessionConfiguration.h.

◆ timeout

long URLSessionConfiguration::timeout

The timeout for the entire transfer, in seconds. 0 means no limit.

Definition at line 91 of file URLSessionConfiguration.h.

◆ urlCache

URLCache* URLSessionConfiguration::urlCache

The cache for URL responses, or NULL to disable caching.

Definition at line 102 of file URLSessionConfiguration.h.

◆ username

String* URLSessionConfiguration::username

The username.

Definition at line 64 of file URLSessionConfiguration.h.

Method Details

◆ _URLSessionConfiguration()

Class * _URLSessionConfiguration ( void )

The URLSessionConfiguration archetype.

Returns: The URLSessionConfiguration Class.

Definition at line 62 of file URLSessionConfiguration.c.

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

◆ init()

URLSessionConfiguration * init ( URLSessionConfiguration * self )

Initializes this URLSessionConfiguration.

Parameters

self	The URLSessionConfiguration.

Returns: The initialized configuration, or NULL on error.

Definition at line 35 of file URLSessionConfiguration.c.

                                                                    {
 
  self = (URLSessionConfiguration *) super(Object, self, init);
  if (self) {
    self->connectTimeout = 5;
    self->urlCache = NULL;
  }
 
  return self;
}

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

Sources/Objectively/URLSessionConfiguration.h
Sources/Objectively/URLSessionConfiguration.c