OFHTTPServer Class Reference

A class for creating a simple HTTP server inside of applications. More...

#include <ObjFW/ObjFW.h>

Inheritance diagram for OFHTTPServer:

Instance Methods
(void)	- start
	Starts the HTTP server in the current thread's run loop.
(void)	- stop
	Stops the HTTP server, meaning it will not accept any new incoming connections, but still handle existing connections until they are finished or timed out.
Instance Methods inherited from OFObject
(instancetype)	- init
	Initializes an already allocated object.
(nullable OFMethodSignature *)	- methodSignatureForSelector:
	Returns the method signature for the specified selector.
(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:withObject:withObject:withObject:afterDelay:
	Performs the specified selector with the specified objects after the specified delay.
(void)	- performSelector:withObject:withObject: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)	- performSelector:onThread:withObject:withObject:withObject:waitUntilDone:
	Performs the specified selector on the specified thread with the specified objects.
(void)	- performSelector:onThread:withObject:withObject: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)	- performSelectorOnMainThread:withObject:withObject:withObject:waitUntilDone:
	Performs the specified selector on the main thread with the specified objects.
(void)	- performSelectorOnMainThread:withObject:withObject: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.
(void)	- performSelector:onThread:withObject:withObject:withObject:afterDelay:
	Performs the specified selector on the specified thread with the specified objects after the specified delay.
(void)	- performSelector:onThread:withObject:withObject:withObject:withObject:afterDelay:
	Performs the specified selector on the specified thread with the specified objects after the specified delay.
(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.
(void)	- doesNotRecognizeSelector:
	Handles messages which are not understood by the receiver.
Instance Methods inherited from <OFObject>
(unsigned long)	- hash
	Returns a hash for the object.
(unsigned int)	- retainCount
	Returns the retain count.
(bool)	- isProxy
	Returns whether the object is a proxy object.
(bool)	- isKindOfClass:
	Returns a boolean whether the object is 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.
(nullable IMP)	- methodForSelector:
	Returns the implementation for the specified selector.
(nullable id)	- performSelector:
	Performs the specified selector.
(nullable id)	- performSelector:withObject:
	Performs the specified selector with the specified object.
(nullable id)	- performSelector:withObject:withObject:
	Performs the specified selector with the specified objects.
(nullable id)	- performSelector:withObject:withObject:withObject:
	Performs the specified selector with the specified objects.
(nullable id)	- performSelector:withObject:withObject:withObject:withObject:
	Performs the specified selector with the specified objects.
(bool)	- isEqual:
	Checks two objects for equality.
(instancetype)	- retain
	Increases the retain count.
(void)	- release
	Decreases the retain count.
(instancetype)	- autorelease
	Adds the object to the topmost autorelease pool of the thread's autorelease pool stack.
(instancetype)	- self
	Returns the receiver.
(bool)	- allowsWeakReference
	Returns whether the object allows a weak reference.
(bool)	- retainWeakReference
	Retain a weak reference to this object.

Class Methods
(instancetype)	+ server
	Creates a new HTTP server.
Class Methods inherited from OFObject
(void)	+ load
	A method which is called once when the class is loaded into the runtime.
(void)	+ unload
	A method which is called when the class is unloaded from the runtime.
(void)	+ initialize
	A method which is called the moment before the first call to the class is being made.
(instancetype)	+ alloc
	Allocates memory for an instance of the class and sets up the memory pool for the object.
(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.
(nullable 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.
(nullable IMP)	+ instanceMethodForSelector:
	Returns the implementation of the instance method for the specified selector.
(nullable OFMethodSignature *)	+ instanceMethodSignatureForSelector:
	Returns the method signature of the instance method for the specified selector.
(OFString *)	+ description
	Returns a description for the class, which is usually the class name.
(nullable IMP)	+ replaceClassMethod:withMethodFromClass:
	Replaces a class method with a class method from another class.
(nullable IMP)	+ replaceInstanceMethod:withMethodFromClass:
	Replaces an instance method with an instance method from another class.
(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.
(id)	+ copy
	Returns the class.

Properties
OFString *	host
	The host on which the HTTP server will listen.
uint16_t	port
	The port on which the HTTP server will listen.
id< OFHTTPServerDelegate >	delegate
	The delegate for the HTTP server.
size_t	numberOfThreads
	The number of threads the OFHTTPServer should use.
OFString *	name
	The server name the server presents to clients.
Properties inherited from OFObject
OFString *	className
	The name of the object's class.
OFString *	description
	A description for the object.

Detailed Description

A class for creating a simple HTTP server inside of applications.

Method Documentation

server

+ (instancetype) server

Creates a new HTTP server.

Returns

A new HTTP server

start

- (void) start

Starts the HTTP server in the current thread's run loop.

Exceptions

OFAlreadyOpenException

The server had already been started

Property Documentation

host

- (OFString *) host

readwriteatomic

The host on which the HTTP server will listen.

Exceptions

OFAlreadyOpenException

The host could not be set because start had already been called

name

- (OFString*) name

readwriteatomic

The server name the server presents to clients.

Setting it to nil means no Server header will be sent, unless one is specified in the response headers.

numberOfThreads

- (size_t) numberOfThreads

readwritenonatomicassign

The number of threads the OFHTTPServer should use.

If this is larger than 1 (the default), one thread will be used to accept incoming connections and all others will be used to handle connections.

For maximum CPU utilization, set this to [OFSystemInfo numberOfCPUs] + 1.

Exceptions

OFAlreadyOpenException

The number of threads could not be set because start had already been called

port

- (uint16_t) port

readwritenonatomicassign

The port on which the HTTP server will listen.

Exceptions

OFAlreadyOpenException

The port could not be set because start had already been called

---

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

• src/OFHTTPServer.h
• src/OFHTTPServer.m