Added socket stream and socket into SilcClientConnection context.

[silc.git] / lib / silchttp / silchttpserver.h

diff --git a/lib/silchttp/silchttpserver.h b/lib/silchttp/silchttpserver.h
index 2cd7e9b221aac04cbe56def7667fcda11e30fb3d..36faf5a5dc70b0229e8ec98292b03bc469bbeafb 100644 (file)
--- a/lib/silchttp/silchttpserver.h
+++ b/lib/silchttp/silchttpserver.h
@@ -4,7 +4,7 @@
 
   Author: Pekka Riikonen <priikone@silcnet.org>
 
-  Copyright (C) 2006 Pekka Riikonen
+  Copyright (C) 2006 - 2007 Pekka Riikonen
 
   This program is free software; you can redistribute it and/or modify
   it under the terms of the GNU General Public License as published by
@@ -24,7 +24,8 @@
  * Very simple HTTP server interface.  This HTTP server supports basic HTTP
  * features.  All pages on the server are dynamically created by the caller
  * of this interface.  The server does not support plugins, modules, cgi-bin,
- * server-side includes or any other special features.
+ * server-side includes or any other special features.  Naturally, the caller
+ * of this interface may itself implement such features.
  *
  ***/
 
@@ -74,7 +75,7 @@ typedef struct SilcHttpConnectionStruct *SilcHttpConnection;
  *
  * DESCRIPTION
  *
- *    The HTTP request callback, that is called everytime a new HTTP request
+ *    The HTTP request callback that is called everytime a new HTTP request
  *    comes from a HTTP client.  The `uri' is the requested URI (web page),
  *    and the `method' is the HTTP request method (GET, POST, etc.).  The
  *    `data' is non-NULL only if the `method' is POST, and it includes the
@@ -111,6 +112,8 @@ typedef void (*SilcHttpServerCallback)(SilcHttpServer httpd,
  *    `port'.  The `callback' with `context' will be called everytime a new
  *    HTTP request comes to the server from a HTTP client.  In that callback
  *    the caller must then reply with the requested Web page or with error.
+ *    If the `schedule' is NULL this will call silc_schedule_get_global to
+ *    try to get global scheduler.
  *
  ***/
 SilcHttpServer silc_http_server_alloc(const char *ip, SilcUInt16 port,
@@ -193,7 +196,7 @@ SilcBool silc_http_server_send_error(SilcHttpServer httpd,
  *
  *    Finds a header field indicated by `field' from the current HTTP
  *    request sent by the HTTP client.  Returns the field value or NULL
- *    if suchs header field does not exist.
+ *    if such header field does not exist.
  *
  ***/
 const char *silc_http_server_get_header(SilcHttpServer httpd,
@@ -218,6 +221,7 @@ const char *silc_http_server_get_header(SilcHttpServer httpd,
  * EXAMPLE
  *
  *    silc_http_server_add_header(httpd, conn, "Content-Type", "image/jpeg");
+ *    silc_http_server_send(httpd, conn, image_data);
  *
  ***/
 SilcBool silc_http_server_add_header(SilcHttpServer httpd,