Added SILC HTTP Server API

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

diff --git a/lib/silchttp/silchttpserver.h b/lib/silchttp/silchttpserver.h
index cfc87c1590dfb7d491e3d3815b647325e6b55b59..a966794f282c370497d7a2f8a83e285e696755a5 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 - 2008 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
@@ -17,7 +17,7 @@
 
 */
 
-/****h* silchttp/SILC HTTP Server Interface
+/****h* silchttp/HTTP Server Interface
  *
  * DESCRIPTION
  *
@@ -32,7 +32,7 @@
 #ifndef SILCHTTPSERVER_H
 #define SILCHTTPSERVER_H
 
-/****s* silchttp/SilcHTTPServer/SilcHttpServer
+/****s* silchttp/SilcHttpServer
  *
  * NAME
  *
@@ -46,7 +46,7 @@
  ***/
 typedef struct SilcHttpServerStruct *SilcHttpServer;
 
-/****s* silchttp/SilcHTTPServer/SilcHttpConnection
+/****s* silchttp/SilcHttpConnection
  *
  * NAME
  *
@@ -62,7 +62,7 @@ typedef struct SilcHttpServerStruct *SilcHttpServer;
  ***/
 typedef struct SilcHttpConnectionStruct *SilcHttpConnection;
 
-/****f* silchttp/SilcHTTPServer/SilcHttpServerCallback
+/****f* silchttp/SilcHttpServerCallback
  *
  * SYNOPSIS
  *
@@ -97,7 +97,7 @@ typedef void (*SilcHttpServerCallback)(SilcHttpServer httpd,
                                       SilcBuffer data,
                                       void *context);
 
-/****f* silchttp/SilcHTTPServer/silc_http_server_alloc
+/****f* silchttp/silc_http_server_alloc
  *
  * SYNOPSIS
  *
@@ -112,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,
@@ -119,7 +121,7 @@ SilcHttpServer silc_http_server_alloc(const char *ip, SilcUInt16 port,
                                      SilcHttpServerCallback callback,
                                      void *context);
 
-/****f* silchttp/SilcHTTPServer/silc_http_server_free
+/****f* silchttp/silc_http_server_free
  *
  * SYNOPSIS
  *
@@ -132,7 +134,7 @@ SilcHttpServer silc_http_server_alloc(const char *ip, SilcUInt16 port,
  ***/
 void silc_http_server_free(SilcHttpServer httpd);
 
-/****f* silchttp/SilcHTTPServer/silc_http_server_send
+/****f* silchttp/silc_http_server_send
  *
  * SYNOPSIS
  *
@@ -151,7 +153,7 @@ SilcBool silc_http_server_send(SilcHttpServer httpd,
                               SilcHttpConnection conn,
                               SilcBuffer data);
 
-/****f* silchttp/SilcHTTPServer/silc_http_server_send_error
+/****f* silchttp/silc_http_server_send_error
  *
  * SYNOPSIS
  *
@@ -182,7 +184,7 @@ SilcBool silc_http_server_send_error(SilcHttpServer httpd,
                                     const char *error,
                                     const char *error_message);
 
-/****f* silchttp/SilcHTTPServer/silc_http_server_get_header
+/****f* silchttp/silc_http_server_get_header
  *
  * SYNOPSIS
  *
@@ -201,7 +203,7 @@ const char *silc_http_server_get_header(SilcHttpServer httpd,
                                        SilcHttpConnection conn,
                                        const char *field);
 
-/****f* silchttp/SilcHTTPServer/silc_http_server_add_header
+/****f* silchttp/silc_http_server_add_header
  *
  * SYNOPSIS
  *