ObjFW
Instance Methods | Class Methods | Properties | List of all members
OFHTTPCookie Class Reference

A class for storing and manipulating HTTP cookies. More...

#import <ObjFW/OFHTTPCookie.h>

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

Instance Methods

(id) - initWithName:value:domain:
 Initializes an already allocated new cookie with the specified name and value. 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...
 
(nullable void *) - allocMemoryWithSize:
 Allocates memory and stores it in the object's memory pool. More...
 
(nullable 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...
 
(bool) - allowsWeakReference
 Returns whether the class allows weak references. More...
 
(bool) - retainWeakReference
 Retain a weak reference to this object. More...
 
- Instance Methods inherited from <OFCopying>
(id) - copy
 Copies the object. More...
 

Class Methods

(OFArray *) + cookiesWithResponseHeaderFields:forURL:
 Parses the specified response header fields for the specified URL and returns an array of cookies. More...
 
(OFDictionary *) + requestHeaderFieldsWithCookies:
 Returns the request header fields for the specified cookies. More...
 
(instancetype) + cookieWithName:value:domain:
 Create a new cookie with the specified name and value. 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...
 
(nullable 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...
 

Properties

OFStringname
 
OFStringvalue
 
OFStringdomain
 
OFStringpath
 
 nonatomic
 
bool secure
 
bool HTTPOnly
 
OFMutableArrayextensions
 

Detailed Description

A class for storing and manipulating HTTP cookies.

Method Documentation

◆ cookiesWithResponseHeaderFields:forURL:()

+ (OFArray *) cookiesWithResponseHeaderFields: (OFDictionary *)  headerFields
forURL: (OFURL *)  URL 

Parses the specified response header fields for the specified URL and returns an array of cookies.

Parameters
headerFieldsThe response header fields to parse
URLThe URL for the response header fields to parse
Returns
An array of cookies

◆ cookieWithName:value:domain:()

+ (instancetype) cookieWithName: (OFString *)  name
value: (OFString *)  value
domain: (OFString *)  domain 

Create a new cookie with the specified name and value.

Parameters
nameThe name of the cookie
valueThe value of the cookie
domainThe domain for the cookie
Returns
A new, autoreleased OFHTTPCookie

◆ initWithName:value:domain:()

- (id) initWithName: (OFString *)  name
value: (OFString *)  value
domain: (OFString *)  domain 

Initializes an already allocated new cookie with the specified name and value.

Parameters
nameThe name of the cookie
valueThe value of the cookie
domainThe domain for the cookie
Returns
An initialized OFHTTPCookie

◆ requestHeaderFieldsWithCookies:()

+ (OFDictionary *) requestHeaderFieldsWithCookies: (OFArray *)  cookies

Returns the request header fields for the specified cookies.

Parameters
cookiesThe cookies to return the request header fields for
Returns
The request header fields for the specified cookies

Property Documentation

◆ domain

- (OFString*) domain
readwritenonatomiccopy

The domain for the cookie.

◆ extensions

- (OFMutableArray*) extensions
readnonatomicassign

An array of other attributes.

◆ HTTPOnly

- (bool) HTTPOnly
readwritenonatomicassign

Whether the cookie is only to be accessed through HTTP.

◆ name

- (OFString*) name
readwritenonatomiccopy

The name of the cookie.

◆ nonatomic

- nonatomic
readwriteatomic

The date when the cookie expires.

◆ path

- (OFString*) path
readwritenonatomiccopy

The path for the cookie.

◆ secure

- (bool) secure
readwritenonatomicassign

Whether the cookie is only to be used with HTTPS.

◆ value

- (OFString*) value
readwritenonatomiccopy

The value of the cookie.


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