|
Zen API
|
|
Zen API
|
Implements a simple HTTP server.
The kHttpServer class implements a simple HTTP 1.1 server framework. The kHttpServer_SetHandler function can be used to register a callback function to process remote requests. The 'args' parameter to this callback receives a kHttpServerChannel instance, which can be used to access kHttpServerRequest and kHttpServerResponse objects. These request/response objects can be used to parse an incoming request and to format an outgoing response, respectively.
kHttpServer uses a simple thread-per-connection model, where the maximum number of simultaneous connections can be configured using the kHttpServer_SetMaxConnections function. Accordingly, kHttpServer is better suited to small/embedded applications than large-scale web applications.
Inheritance diagram for kHttpServer:Public Member Functions | |
| kStatus | kHttpServer_Construct (kHttpServer *server, kAlloc allocator) |
| Constructs a kHttpServer object. More... | |
| kStatus | kHttpServer_LocalEndPoint (kHttpServer server, kIpEndPoint *endPoint) |
| Reports the local end-point for a running server. More... | |
| kStatus | kHttpServer_SetAddress (kHttpServer server, kIpAddress address) |
| Sets the local address to which the server should bind. More... | |
| kStatus | kHttpServer_SetHandler (kHttpServer server, kCallbackFx function, kPointer receiver) |
| Sets the callback that will be invoked to process remote requests. More... | |
| kStatus | kHttpServer_SetMaxConnections (kHttpServer server, kSize capacity) |
| Sets the maximum number of simultaneous connections supported by the server. More... | |
| kStatus | kHttpServer_SetPort (kHttpServer server, k32u port) |
| Sets the local port to which the server should bind. More... | |
| kStatus | kHttpServer_Start (kHttpServer server) |
| Starts the server. More... | |
| kStatus | kHttpServer_Stop (kHttpServer server) |
| Stops the server. More... | |
| kAlloc | kObject_Alloc (kObject object) |
| Gets the memory allocator associated with this object. More... | |
| kStatus | kObject_Clone (kObject *object, kObject source, kAlloc allocator) |
| Constructs a new object by copying an existing object, including any aggregated child elements. More... | |
| kStatus | kObject_Destroy (kObject object) |
| Destroys the object. More... | |
| kStatus | kObject_Dispose (kObject object) |
| Destroys the object and any aggregated child elements. More... | |
| kBool | kObject_Equals (kObject object, kObject other) |
| Determines whether the object is equal to another object. More... | |
| kSize | kObject_HashCode (kObject object) |
| Gets a hash code representing the state of this object. More... | |
| kBool | kObject_Is (kObject object, kType type) |
| Determines whether this object is an instance of the specified type. More... | |
| kBool | kObject_IsShared (kObject object) |
| Reports whether the object is currently shared (reference count greater than one). More... | |
| kStatus | kObject_SetPool (kObject object, kObjectPool pool) |
| Sets the object pool associated with this object. More... | |
| kStatus | kObject_Share (kObject object) |
| Increments the reference count associated with this object. More... | |
| kSize | kObject_Size (kObject object) |
| Estimates the memory consumed by this object, including any aggregated child elements. More... | |
| kType | kObject_Type (kObject object) |
| Returns the type of the object. More... | |
| kStatus kHttpServer_Construct | ( | kHttpServer * | server, |
| kAlloc | allocator | ||
| ) |
Constructs a kHttpServer object.
| server | Destination for the constructed object handle. |
| allocator | Memory allocator (or kNULL for default). |
| kStatus kHttpServer_LocalEndPoint | ( | kHttpServer | server, |
| kIpEndPoint * | endPoint | ||
| ) |
Reports the local end-point for a running server.
| server | kHttpServer object. |
| endPoint | Receives local end-point information. |
| kStatus kHttpServer_SetAddress | ( | kHttpServer | server, |
| kIpAddress | address | ||
| ) |
Sets the local address to which the server should bind.
By default, the server will bind to the address returned by kIpAddress_AnyV4().
This function can only be called while the server is stopped.
| server | Server object. |
| address | IP address. |
| kStatus kHttpServer_SetHandler | ( | kHttpServer | server, |
| kCallbackFx | function, | ||
| kPointer | receiver | ||
| ) |
Sets the callback that will be invoked to process remote requests.
The callback 'sender' argument will receive a kHttpServer instance, while the callback 'args' argument will receive a kHttpServerChannel instance. The callback receiver can use the kHttpServerChannel object to access kHttpServerRequest and kHttpServerResponse objects, which can be used to parse the incoming request and to generate a response.
This function can only be called while the server is stopped.
| server | Server object. |
| function | Callback function. |
| receiver | Callback receiver. |
| kStatus kHttpServer_SetMaxConnections | ( | kHttpServer | server, |
| kSize | capacity | ||
| ) |
Sets the maximum number of simultaneous connections supported by the server.
This function can only be called while the server is stopped.
| server | Server object. |
| capacity | Maximum simultaneous connection count. |
| kStatus kHttpServer_SetPort | ( | kHttpServer | server, |
| k32u | port | ||
| ) |
Sets the local port to which the server should bind.
By default, the server will bind to port 80.
This function can only be called while the server is stopped.
| server | Server object. |
| port | Port number. |
| kStatus kHttpServer_Start | ( | kHttpServer | server | ) |
| kStatus kHttpServer_Stop | ( | kHttpServer | server | ) |
Stops the server.
All asynchronous activities performed by the server will be stopped before this function returns.
| server | kHttpServer object. |
Gets the memory allocator associated with this object.
Most objects are constructed with an allocator, which is used to allocate the memory required by the object. Objects retain a reference to this allocator to enable further allocations and to free memory when the object is destroyed.
| object | Object. |
Constructs a new object by copying an existing object, including any aggregated child elements.
If the source object is an object collection (e.g. kArrayList<kString>), any aggregated child objects are also cloned. In this case, the kObject_Dispose method can be used to free the cloned collection and its associated elements.
This method will fail if the source object (or an aggregated child element) does not support cloning.
| object | Receives the constructed object. |
| source | Source object. |
| allocator | Memory allocator (or kNULL for default). |
Destroys the object.
The kObject_Destroy method destroys the object itself and any resources that are owned by the object. See Object Destruction for more information.
When an object is destroyed (or disposed), its reference count is decremented. The object is only truly destroyed when the reference count reaches zero. See Reference Counting for more information.
| object | Object (or kNULL). |
Destroys the object and any aggregated child elements.
The kObject_Dispose method destroys the object itself, any resources that are owned by the object, and if the object represents a collection of objects, any child objects in the collection. See Object Destruction for more information.
When an object is destroyed (or disposed), its reference count is decremented. The object is only truly destroyed when the reference count reaches zero. See Reference Counting for more information.
| object | Object (or kNULL). |
Determines whether the object is equal to another object.
By default, objects are compared by reference; objects are considered equal if the given handles refer to the same object instance. However, some classes override the Equals method to provide a more meaningful comparison (e.g. kString).
| object | Object. |
| other | Object for comparison. |
Gets a hash code representing the state of this object.
By default, objects return a hash code based on the object handle value. However, some classes override the HashCode method to provide a more useful hash (e.g. kString).
| object | Object. |
Determines whether this object is an instance of the specified type.
This function compares the type of this object with the given type. An object is considered to be an instance of a given type if a) the type represents a class and this object inherits from (or instantiates) that class, or b) the type represents an interface and this object implements the interface.
| object | Object. |
| type | Type. |
Reports whether the object is currently shared (reference count greater than one).
Objects are initialized with a reference count of one. The kObject_Share method can be used to increment the reference count. The kObject_Destroy and kObject_Dispose methods decrease the reference count, and when the reference count reaches zero, the object is actually destroyed/disposed.
This method can be used to determine if the reference count of an object is currently greater than one.
This method is thread-safe.
| object | Object. |
|
inherited |
Sets the object pool associated with this object.
Object pools can be used to implement custom lifecycle management. If an object has an assigned pool, then the kObjectPool_Reclaim method will be called just prior to destruction, to provide an opportunity for the object to be reclaimed.
| object | Object. |
| pool | Pool object (or kNULL to clear the pool assignment). |
Increments the reference count associated with this object.
This method is thread-safe.
| object | Object. |
Estimates the memory consumed by this object, including any aggregated child elements.
This method can be optionally overridden by kObject-derived classes to report the amount of memory consumed by an object. The default implementation reports only the size of the class instance (additional allocations performed by the class are excluded).
| object | Object. |
Returns the type of the object.
Each object is an instance of a specific class type. The type handle returned by this function can be used to learn about the class.
| object | Object. |
