5 Author: Pekka Riikonen <priikone@silcnet.org>
7 Copyright (C) 2006 Pekka Riikonen
9 This program is free software; you can redistribute it and/or modify
10 it under the terms of the GNU General Public License as published by
11 the Free Software Foundation; version 2 of the License.
13 This program is distributed in the hope that it will be useful,
14 but WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 GNU General Public License for more details.
20 /****h* silchttp/SILC HTTP Server Interface
24 * Very simple HTTP server interface. This HTTP server supports basic HTTP
25 * features. All pages on the server are dynamically created by the caller
26 * of this interface. The server does not support plugins, modules, cgi-bin,
27 * server-side includes or any other special features.
31 #ifndef SILCHTTPSERVER_H
32 #define SILCHTTPSERVER_H
34 /****s* silchttp/SilcHTTPServer/SilcHttpServer
38 * typedef struct SilcHttpServerStruct *SilcHttpServer;
42 * The actual HTTP server allocated with silc_http_server_alloc and
43 * freed with silc_http_server_free.
46 typedef struct SilcHttpServerStruct *SilcHttpServer;
48 /****s* silchttp/SilcHTTPServer/SilcHttpConnection
52 * typedef struct SilcHttpConnectionStruct *SilcHttpConnection;
56 * HTTP connection context. This is allocated by the library and
57 * delivered to application in SilcHttpServerCallback callbcak function.
58 * It is given as argument to many silc_http_server_* functions.
59 * It is freed automatically by the library.
62 typedef struct SilcHttpConnectionStruct *SilcHttpConnection;
64 /****f* silchttp/SilcHTTPServer/SilcHttpServerCallback
68 * typedef void (*SilcHttpServerCallback)(SilcHttpServer httpd,
69 * SilcHttpConnection conn,
77 * The HTTP request callback, that is called everytime a new HTTP request
78 * comes from a HTTP client. The `uri' is the requested URI (web page),
79 * and the `method' is the HTTP request method (GET, POST, etc.). The
80 * `data' is non-NULL only if the `method' is POST, and it includes the
83 * The requested web page must be returned to the HTTP client from this
84 * callback by calling silc_http_server_send or error is returned by
85 * calling silc_http_server_send_error.
87 * The silc_http_server_get_header may be called to find a specific
88 * HTTP header from this request. New headers may be added to the
89 * reply by calling silc_http_server_add_header.
92 typedef void (*SilcHttpServerCallback)(SilcHttpServer httpd,
93 SilcHttpConnection conn,
99 /****f* silchttp/SilcHTTPServer/silc_http_server_alloc
104 * silc_http_server_alloc(const char *ip, SilcUInt16 port,
105 * SilcSchedule schedule,
106 * SilcHttpServerCallback callback, void *context);
110 * Allocates HTTP server and binds it to the IP address `ip' on the
111 * `port'. The `callback' with `context' will be called everytime a new
112 * HTTP request comes to the server from a HTTP client. In that callback
113 * the caller must then reply with the requested Web page or with error.
116 SilcHttpServer silc_http_server_alloc(const char *ip, SilcUInt16 port,
117 SilcSchedule schedule,
118 SilcHttpServerCallback callback,
121 /****f* silchttp/SilcHTTPServer/silc_http_server_free
125 * void silc_http_server_free(SilcHttpServer httpd);
129 * Close HTTP server and free all resources.
132 void silc_http_server_free(SilcHttpServer httpd);
134 /****f* silchttp/SilcHTTPServer/silc_http_server_send
138 * SilcBool silc_http_server_send(SilcHttpServer httpd,
139 * SilcHttpConnection conn,
144 * Send the HTTP data indicated by `data' buffer into the connection
145 * indicated by `conn'. Returns TRUE after the data is sent, and FALSE
146 * if error occurred. Usually the `data' would be the requested web page.
149 SilcBool silc_http_server_send(SilcHttpServer httpd,
150 SilcHttpConnection conn,
153 /****f* silchttp/SilcHTTPServer/silc_http_server_send_error
157 * SilcBool silc_http_server_send_error(SilcHttpServer httpd,
158 * SilcHttpConnection conn,
160 * const char *error_message);
164 * Send HTTP error back to the connection indicated by `conn'. The
165 * `error' is one of the 4xx or 5xx errors defined by the HTTP protocol.
166 * The `error_message' is the optional error message sent to the
167 * connection. Returns FALSE if the error could not be sent.
169 * Typical errors are: 400 Bad Request
175 * silc_http_server_send_error(httpd, conn, "400 Bad Request",
176 * "<body><h1>400 Bad Request!!</h1></body>");
179 SilcBool silc_http_server_send_error(SilcHttpServer httpd,
180 SilcHttpConnection conn,
182 const char *error_message);
184 /****f* silchttp/SilcHTTPServer/silc_http_server_get_header
188 * const char *silc_http_server_get_header(SilcHttpServer httpd,
189 * SilcHttpConnection conn,
190 * const char *field);
194 * Finds a header field indicated by `field' from the current HTTP
195 * request sent by the HTTP client. Returns the field value or NULL
196 * if such header field does not exist.
199 const char *silc_http_server_get_header(SilcHttpServer httpd,
200 SilcHttpConnection conn,
203 /****f* silchttp/SilcHTTPServer/silc_http_server_add_header
207 * SilcBool silc_http_server_add_header(SilcHttpServer httpd,
208 * SilcHttpConnection conn,
210 * const char *value);
214 * Adds a new header to the HTTP headers to be sent back to the
215 * HTTP client. This may be called to add needed headers to the
220 * silc_http_server_add_header(httpd, conn, "Content-Type", "image/jpeg");
223 SilcBool silc_http_server_add_header(SilcHttpServer httpd,
224 SilcHttpConnection conn,
228 #endif /* SILCHTTPSERVER_H */