ObjFW
 All Classes Functions Variables
Instance Methods | Class Methods | List of all members
OFHTTPRequest Class Reference

A class for storing and performing HTTP requests. More...

#import <OFHTTPRequest.h>

Inheritance diagram for OFHTTPRequest:
OFObject <OFObject>

Instance Methods

(id) - initWithURL:
 Initializes an already allocated OFHTTPRequest with the specified URL.
 
(void) - setURL:
 Sets the URL of the HTTP request.
 
(OFURL *) - URL
 Returns the URL of the HTTP request.
 
(void) - setRequestType:
 Sets the request type of the HTTP request.
 
(of_http_request_type_t) - requestType
 Returns the request type of the HTTP request.
 
(void) - setQueryString:
 Sets the query string of the HTTP request.
 
(OFString *) - queryString
 Returns the query string of the HTTP request.
 
(void) - setHeaders:
 Sets a dictionary with headers for the HTTP request.
 
(OFDictionary *) - headers
 Retrusn a dictionary with headers for the HTTP request.
 
(void) - setRedirectsFromHTTPSToHTTPAllowed:
 Sets whether redirects from HTTPS to HTTP are allowed.
 
(BOOL) - redirectsFromHTTPSToHTTPAllowed
 Returns whether redirects from HTTPS to HTTP will be allowed.
 
(void) - setDelegate:
 Sets the delegate of the HTTP request.
 
(id< OFHTTPRequestDelegate >) - delegate
 Returns the delegate of the HTTP reqeust.
 
(void) - setStoresData:
 Sets whether an OFDataArray with the data should be created.
 
(BOOL) - storesData
 Returns whether an OFDataArray with the date should be created.
 
(OFHTTPRequestResult *) - perform
 Performs the HTTP request and returns an OFHTTPRequestResult.
 
(OFHTTPRequestResult *) - performWithRedirects:
 Performs the HTTP request and returns an OFHTTPRequestResult.
 
- Instance Methods inherited from OFObject
(id) - init
 Initializes an already allocated object.
 
(OFString *) - className
 Returns the name of the object's class.
 
(OFString *) - description
 Returns a description for the object.
 
(void *) - allocMemoryWithSize:
 Allocates memory and stores it in the object's memory pool.
 
(void *) - allocMemoryWithSize:count:
 Allocates memory for the specified number of items and stores it in the object's memory pool.
 
(void *) - resizeMemory:size:
 Resizes memory in the object's memory pool to the specified size.
 
(void *) - resizeMemory:size:count:
 Resizes memory in the object's memory pool to the specific number of items of the specified size.
 
(void) - freeMemory:
 Frees allocated memory and removes it from the object's memory pool.
 
(void) - dealloc
 Deallocates the object.
 
(void) - performSelector:afterDelay:
 Performs the specified selector after the specified delay.
 
(void) - performSelector:withObject:afterDelay:
 Performs the specified selector with the specified object after the specified delay.
 
(void) - performSelector:withObject:withObject:afterDelay:
 Performs the specified selector with the specified objects after the specified delay.
 
(void) - performSelector:onThread:waitUntilDone:
 Performs the specified selector on the specified thread.
 
(void) - performSelector:onThread:withObject:waitUntilDone:
 Performs the specified selector on the specified thread with the specified object.
 
(void) - performSelector:onThread:withObject:withObject:waitUntilDone:
 Performs the specified selector on the specified thread with the specified objects.
 
(void) - performSelectorOnMainThread:waitUntilDone:
 Performs the specified selector on the main thread.
 
(void) - performSelectorOnMainThread:withObject:waitUntilDone:
 Performs the specified selector on the main thread with the specified object.
 
(void) - performSelectorOnMainThread:withObject:withObject:waitUntilDone:
 Performs the specified selector on the main thread with the specified objects.
 
(void) - performSelector:onThread:afterDelay:
 Performs the specified selector on the specified thread after the specified delay.
 
(void) - performSelector:onThread:withObject:afterDelay:
 Performs the specified selector on the specified thread with the specified object after the specified delay.
 
(void) - performSelector:onThread:withObject:withObject:afterDelay:
 Performs the specified selector on the specified thread with the specified objects after the specified delay.
 
(OFString *) - stringBySerializing
 Creates a string by serializing the receiver.
 
- Instance Methods inherited from <OFObject>
(BOOL) - isKindOfClass:
 Returns a boolean whether the object of the specified kind.
 
(BOOL) - isMemberOfClass:
 Returns a boolean whether the object is a member of the specified class.
 
(BOOL) - respondsToSelector:
 Returns a boolean whether the object responds to the specified selector.
 
(IMP) - methodForSelector:
 Returns the implementation for the specified selector.
 
(const char *) - typeEncodingForSelector:
 Returns the type encoding for the specified selector.
 
(id) - performSelector:
 Performs the specified selector.
 
(id) - performSelector:withObject:
 Performs the specified selector with the specified object.
 
(id) - performSelector:withObject:withObject:
 Performs the specified selector with the specified objects.
 
(BOOL) - isEqual:
 Checks two objects for equality.
 
(uint32_t) - hash
 Calculates a hash for the object.
 
(id) - retain
 Increases the retain count.
 
(unsigned int) - retainCount
 Returns the retain count.
 
(void) - release
 Decreases the retain count.
 
(id) - autorelease
 Adds the object to the topmost OFAutoreleasePool of the thread's autorelease pool stack.
 
(id) - self
 Returns the receiver.
 
(BOOL) - isProxy
 Returns whether the object is a proxy object.
 

Class Methods

(instancetype) + request
 Creates a new OFHTTPRequest.
 
(instancetype) + requestWithURL:
 Creates a new OFHTTPRequest with the specified URL.
 
- Class Methods inherited from OFObject
(void) + load
 A method which is called once when the class is loaded into the runtime.
 
(void) + initialize
 A method which is called the moment before the first call to the class is being made.
 
(id) + alloc
 Allocates memory for an instance of the class and sets up the memory pool for the object.
 
(id) + new
 Allocates memory for a new instance and calls init on it.
 
(Class) + class
 Returns the class.
 
(OFString *) + className
 Returns the name of the class as a string.
 
(BOOL) + isSubclassOfClass:
 Returns a boolean whether the class is a subclass of the specified class.
 
(Class) + superclass
 Returns the superclass of the class.
 
(BOOL) + instancesRespondToSelector:
 Checks whether instances of the class respond to a given selector.
 
(BOOL) + conformsToProtocol:
 Checks whether the class conforms to a given protocol.
 
(IMP) + instanceMethodForSelector:
 Returns the implementation of the instance method for the specified selector.
 
(const char *) + typeEncodingForInstanceSelector:
 Returns the type encoding of the instance method for the specified selector.
 
(OFString *) + description
 Returns a description for the class, which is usually the class name.
 
(IMP) + replaceClassMethod:withMethodFromClass:
 Replaces a class method with a class method from another class.
 
(IMP) + replaceInstanceMethod:withMethodFromClass:
 Replaces an instance method with an instance method from another class.
 
(IMP) + replaceClassMethod:withImplementation:typeEncoding:
 Replaces or adds a class method.
 
(IMP) + replaceInstanceMethod:withImplementation:typeEncoding:
 Replaces or adds an instance method.
 
(void) + inheritMethodsFromClass:
 Adds all methods from the specified class to the class that is the receiver.
 
(BOOL) + resolveClassMethod:
 Try to resolve the specified class method.
 
(BOOL) + resolveInstanceMethod:
 Try to resolve the specified instance method.
 

Detailed Description

A class for storing and performing HTTP requests.

Method Documentation

- (id <OFHTTPRequestDelegate>) delegate

Returns the delegate of the HTTP reqeust.

Returns
The delegate of the HTTP request
- (OFDictionary*) headers

Retrusn a dictionary with headers for the HTTP request.

Returns
A dictionary with headers for the HTTP request.
- (id) initWithURL: (OFURL*)  URL

Initializes an already allocated OFHTTPRequest with the specified URL.

Parameters
URLThe URL for the request
Returns
An initialized OFHTTPRequest
- (OFHTTPRequestResult *) perform

Performs the HTTP request and returns an OFHTTPRequestResult.

Returns
An OFHTTPRequestResult with the result of the HTTP request
- (OFHTTPRequestResult *) performWithRedirects: (size_t)  redirects

Performs the HTTP request and returns an OFHTTPRequestResult.

Parameters
redirectsThe maximum number of redirects after which no further attempt is done to follow the redirect, but instead the redirect is returned as an OFHTTPRequest
Returns
An OFHTTPRequestResult with the result of the HTTP request
- (OFString*) queryString

Returns the query string of the HTTP request.

Returns
The query string of the HTTP request
- (BOOL) redirectsFromHTTPSToHTTPAllowed

Returns whether redirects from HTTPS to HTTP will be allowed.

Returns
Whether redirects from HTTPS to HTTP will be allowed
+ (instancetype) request

Creates a new OFHTTPRequest.

Returns
A new, autoreleased OFHTTPRequest
- (of_http_request_type_t) requestType

Returns the request type of the HTTP request.

Returns
The request type of the HTTP request
+ (instancetype) requestWithURL: (OFURL*)  URL

Creates a new OFHTTPRequest with the specified URL.

Parameters
URLThe URL for the request
Returns
A new, autoreleased OFHTTPRequest
- (void) setDelegate: (id <OFHTTPRequestDelegate>)  delegate

Sets the delegate of the HTTP request.

Parameters
delegateThe delegate of the HTTP request
- (void) setHeaders: (OFDictionary*)  headers

Sets a dictionary with headers for the HTTP request.

Parameters
headersA dictionary with headers for the HTTP request
- (void) setQueryString: (OFString*)  queryString

Sets the query string of the HTTP request.

Parameters
queryStringThe query string of the HTTP request
- (void) setRedirectsFromHTTPSToHTTPAllowed: (BOOL)  allowed

Sets whether redirects from HTTPS to HTTP are allowed.

Parameters
allowedWhether redirects from HTTPS to HTTP are allowed
- (void) setRequestType: (of_http_request_type_t)  requestType

Sets the request type of the HTTP request.

Parameters
requestTypeThe request type of the HTTP request
- (void) setStoresData: (BOOL)  storesData

Sets whether an OFDataArray with the data should be created.

Setting this to NO is only useful if you are using the delegate to handle the data.

Parameters
storesDataWhether to store the data in an OFDataArray
- (void) setURL: (OFURL*)  URL

Sets the URL of the HTTP request.

Parameters
URLThe URL of the HTTP request
- (BOOL) storesData

Returns whether an OFDataArray with the date should be created.

Returns
Whether an OFDataArray with the data should be created
- (OFURL*) URL

Returns the URL of the HTTP request.

Returns
The URL of the HTTP request

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