#include <URLRequest.h>

Overview

A protocol-agnostic abstraction for requesting resources via URLs.

Definition at line 58 of file URLRequest.h.

Inheritance diagram for URLRequest:

Properties
Data *	httpBody
	The HTTP request body, sent as `POST` or `PUT` data.

Dictionary *	httpHeaders
	The HTTP request headers.

HTTPMethod	httpMethod
	The HTTP request method.

Object	object
	The superclass.

URL *	url
	The URL.

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 *	_URLRequest (void)
	The URLRequest archetype.

URLRequest *	initWithURL (URLRequest self, URL url)
	Initializes this URLRequest with the specified URL.

void	setValueForHTTPHeaderField (URLREquest self, const char value, const char *field)

void	setValueForHTTPHeaderField (URLRequest self, const char value, const char *field)
	Sets a value for the specified HTTP header.

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
URLRequestInterface *	interface [0]
	The interface type.

Protected Attributes inherited from Object
ObjectInterface *	interface [0]
	The interface type.

Property Details

◆ httpBody

Data* URLRequest::httpBody

The HTTP request body, sent as POST or PUT data.

Definition at line 74 of file URLRequest.h.

◆ httpHeaders

Dictionary* URLRequest::httpHeaders

The HTTP request headers.

Definition at line 79 of file URLRequest.h.

◆ httpMethod

HTTPMethod URLRequest::httpMethod

The HTTP request method.

Definition at line 84 of file URLRequest.h.

◆ interface

URLRequestInterface* URLRequest::interface[0]

protected

The interface type.

Definition at line 69 of file URLRequest.h.

◆ object

Object URLRequest::object

The superclass.

Definition at line 63 of file URLRequest.h.

◆ url

URL* URLRequest::url

The URL.

Definition at line 89 of file URLRequest.h.

Method Details

◆ _URLRequest()

Class * _URLRequest ( void )

The URLRequest archetype.

Returns: The URLRequest Class.

Definition at line 204 of file URLRequest.c.

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

◆ initWithURL()

URLRequest * initWithURL	(	URLRequest *	self,
		URL *	url
	)

Initializes this URLRequest with the specified URL.

Parameters

self	The URLRequest.
url	The URL.

Returns: The initialized URLRequest, or NULL on error.

Definition at line 150 of file URLRequest.c.

                                                           {
 
  assert(url);
 
  self = (URLRequest *) super(Object, self, init);
  if (self) {
    self->url = retain(url);
    assert(self->url);
 
    self->httpMethod = HTTP_GET;
  }
 
  return self;
}

◆ setValueForHTTPHeaderField() [1/2]

void setValueForHTTPHeaderField	(	URLREquest *	self,
		const char *	value,
		const char *	field
	)

◆ setValueForHTTPHeaderField() [2/2]

void setValueForHTTPHeaderField	(	URLRequest *	self,
		const char *	value,
		const char *	field
	)

Sets a value for the specified HTTP header.