ObjFW
Instance Methods | Class Methods | List of all members
OFHTTPRequest Class Reference

A class for storing HTTP requests. More...

#import <ObjFW/OFHTTPRequest.h>

Inheritance diagram for OFHTTPRequest:
OFObject <OFCopying> <OFObject>

Instance Methods

(id) - initWithURL:
 Initializes an already allocated OFHTTPRequest with the specified URL. More...
 
(void) - setURL:
 Sets the URL of the HTTP request. More...
 
(OFURL *) - URL
 Returns the URL of the HTTP request. More...
 
(void) - setMethod:
 Sets the request method of the HTTP request. More...
 
(of_http_request_method_t- method
 Returns the request method of the HTTP request. More...
 
(void) - setProtocolVersion:
 Sets the protocol version of the HTTP request. More...
 
(of_http_request_protocol_version_t- protocolVersion
 Returns the protocol version of the HTTP request. More...
 
(void) - setProtocolVersionFromString:
 Sets the protocol version of the HTTP request to the version described by the specified string. More...
 
(OFString *) - protocolVersionString
 Returns the protocol version of the HTTP request as a string. More...
 
(void) - setHeaders:
 Sets a dictionary with headers for the HTTP request. More...
 
(nullable OFDictionary OF_GENERIC(OFString *, OFString *) - headers
 Returns a dictionary with headers for the HTTP request. More...
 
(void) - setBody:
 Sets the entity body of the HTTP request. More...
 
(void) - setBodyFromString:
 Sets the entity body of the HTTP request to the specified string encoded in UTF-8. More...
 
(void) - setBodyFromString:encoding:
 Sets the entity body of the HTTP request to the specified string encoded in the specified encoding. More...
 
(nullable OFDataArray *) - body
 Returns the entity body of the HTTP request. More...
 
(void) - setRemoteAddress:
 Sets the remote address from which the request originates. More...
 
(nullable OFString *) - remoteAddress
 Returns the remote address from which the request originates. More...
 
- Instance Methods inherited from OFObject
(id) - init
 Initializes an already allocated object. More...
 
(OFString *) - className
 Returns the name of the object's class. More...
 
(OFString *) - description
 Returns a description for the object. More...
 
(void *) - allocMemoryWithSize:
 Allocates memory and stores it in the object's memory pool. More...
 
(void *) - allocMemoryWithSize:count:
 Allocates memory for the specified number of items and stores it in the object's memory pool. More...
 
(nullable void *) - resizeMemory:size:
 Resizes memory in the object's memory pool to the specified size. More...
 
(nullable void *) - resizeMemory:size:count:
 Resizes memory in the object's memory pool to the specific number of items of the specified size. More...
 
(void) - freeMemory:
 Frees allocated memory and removes it from the object's memory pool. More...
 
(void) - dealloc
 Deallocates the object. More...
 
(void) - performSelector:afterDelay:
 Performs the specified selector after the specified delay. More...
 
(void) - performSelector:withObject:afterDelay:
 Performs the specified selector with the specified object after the specified delay. More...
 
(void) - performSelector:withObject:withObject:afterDelay:
 Performs the specified selector with the specified objects after the specified delay. More...
 
(void) - performSelector:onThread:waitUntilDone:
 Performs the specified selector on the specified thread. More...
 
(void) - performSelector:onThread:withObject:waitUntilDone:
 Performs the specified selector on the specified thread with the specified object. More...
 
(void) - performSelector:onThread:withObject:withObject:waitUntilDone:
 Performs the specified selector on the specified thread with the specified objects. More...
 
(void) - performSelectorOnMainThread:waitUntilDone:
 Performs the specified selector on the main thread. More...
 
(void) - performSelectorOnMainThread:withObject:waitUntilDone:
 Performs the specified selector on the main thread with the specified object. More...
 
(void) - performSelectorOnMainThread:withObject:withObject:waitUntilDone:
 Performs the specified selector on the main thread with the specified objects. More...
 
(void) - performSelector:onThread:afterDelay:
 Performs the specified selector on the specified thread after the specified delay. More...
 
(void) - performSelector:onThread:withObject:afterDelay:
 Performs the specified selector on the specified thread with the specified object after the specified delay. More...
 
(void) - performSelector:onThread:withObject:withObject:afterDelay:
 Performs the specified selector on the specified thread with the specified objects after the specified delay. More...
 
(nullable id) - forwardingTargetForSelector:
 This method is called when resolveClassMethod: or resolveInstanceMethod: returned false. It should return a target to which the message should be forwarded. More...
 
(void) - doesNotRecognizeSelector:
 Handles messages which are not understood by the receiver. More...
 
(OFString *) - stringBySerializing
 Creates a string by serializing the receiver. More...
 
- Instance Methods inherited from <OFObject>
(bool) - isKindOfClass:
 Returns a boolean whether the object of the specified kind. More...
 
(bool) - isMemberOfClass:
 Returns a boolean whether the object is a member of the specified class. More...
 
(bool) - respondsToSelector:
 Returns a boolean whether the object responds to the specified selector. More...
 
(nullable IMP) - methodForSelector:
 Returns the implementation for the specified selector. More...
 
(nullable const char *) - typeEncodingForSelector:
 Returns the type encoding for the specified selector. More...
 
(nullable id) - performSelector:
 Performs the specified selector. More...
 
(nullable id) - performSelector:withObject:
 Performs the specified selector with the specified object. More...
 
(nullable id) - performSelector:withObject:withObject:
 Performs the specified selector with the specified objects. More...
 
(bool) - isEqual:
 Checks two objects for equality. More...
 
(uint32_t) - hash
 Calculates a hash for the object. More...
 
(id) - retain
 Increases the retain count. More...
 
(unsigned int) - retainCount
 Returns the retain count. More...
 
(void) - release
 Decreases the retain count. More...
 
(id) - autorelease
 Adds the object to the topmost OFAutoreleasePool of the thread's autorelease pool stack. More...
 
(id) - self
 Returns the receiver. More...
 
(bool) - isProxy
 Returns whether the object is a proxy object. More...
 
- Instance Methods inherited from <OFCopying>
(id) - copy
 Copies the object. More...
 

Class Methods

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

Detailed Description

A class for storing HTTP requests.

Method Documentation

- (OFDataArray *) body

Returns the entity body of the HTTP request.

Returns
The entity body of the HTTP request
- (nullable OFDictionary OF_GENERIC(OFString*, OFString*) headers

Returns 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

Returns the request method of the HTTP request.

Returns
The request method of the HTTP request

Returns the protocol version of the HTTP request.

Returns
The protocol version of the HTTP request
- (OFString *) protocolVersionString

Returns the protocol version of the HTTP request as a string.

Returns
The protocol version of the HTTP request as a string
- (OFString *) remoteAddress

Returns the remote address from which the request originates.

Returns
The remote address from which the request originates
+ (instancetype) request

Creates a new OFHTTPRequest.

Returns
A new, autoreleased OFHTTPRequest
+ (instancetype) requestWithURL: (OFURL*)  URL

Creates a new OFHTTPRequest with the specified URL.

Parameters
URLThe URL for the request
Returns
A new, autoreleased OFHTTPRequest
- (void) setBody: (nullable OFDataArray *)  body

Sets the entity body of the HTTP request.

Parameters
bodyThe entity body of the HTTP request
- (void) setBodyFromString: (nullable OFString *)  string

Sets the entity body of the HTTP request to the specified string encoded in UTF-8.

Parameters
stringThe string to use for the entity body
- (void) setBodyFromString: (nullable OFString *)  string
encoding: (of_string_encoding_t encoding 

Sets the entity body of the HTTP request to the specified string encoded in the specified encoding.

Parameters
stringThe string to use for the entity body
encodingThe encoding to encode the string with
- (void) setHeaders: (nullable OFDictionary OF_GENERIC(OFString *, OFString *)*)  headers

Sets a dictionary with headers for the HTTP request.

Parameters
headersA dictionary with headers for the HTTP request
- (void) setMethod: (of_http_request_method_t method

Sets the request method of the HTTP request.

Parameters
methodThe request method of the HTTP request
- (void) setProtocolVersion: (of_http_request_protocol_version_t protocolVersion

Sets the protocol version of the HTTP request.

Parameters
protocolVersionThe protocol version of the HTTP request
- (void) setProtocolVersionFromString: (OFString*)  string

Sets the protocol version of the HTTP request to the version described by the specified string.

Parameters
stringA string describing an HTTP version
- (void) setRemoteAddress: (nullable OFString *)  remoteAddress

Sets the remote address from which the request originates.

Parameters
remoteAddressThe remote address from which the request originates
- (void) setURL: (OFURL*)  URL

Sets the URL of the HTTP request.

Parameters
URLThe URL of the HTTP request
- (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: