lib/Spin/Details/documentation.h

   1 /** \mainpage Arachnida/Spin: Dutch for spider.
   2  * Spin is a small, simple to use, full-featured HTTP(S) server. Below, the
   3  * \em entire source code of the "Hello, world!" equivalent of an HTTP server
   4  * is reproduced. I.e., the Mesothelae mini-server serves up only two pages but
   5  * has been tested with both Mozilla Firefox and Microsoft Internet Explorer as
   6  * clients. It replies to a request for / with a redirect to /index.html, which
   7  * it serves up with a bit of HTP containing "Hello, world!". Connections are
   8  * handled asynchronously and requests are put in the request handler, where the
   9  * main thread will find them calling getNextRequest.
  10  * \dontinclude Mesothelae/main.cpp
  11  * \until else if (request->url_ == "/index.html")
  12  * \until }
  13  * \skip close_connection
  14  * \skip {
  15  * \skip else
  16  * \until client hung up
  17  * \until }
  18  * \until }
  19  * \until }
  20  */
  21
  22 //! The library's main namespace
  23 namespace Spin
  24 {
  25         //! Implementation details you may need to know about
  26         namespace Details
  27         { /* doc only */ }
  28         //! Exceptions thrown by the library
  29         namespace Exceptions
  30         {
  31                 //! Connection-related exceptions
  32                 namespace Connection
  33                 { /* doc only */ }
  34                 //! HTTP protocol exceptions
  35                 namespace HTTP
  36                 { /* doc only */ }
  37         }
  38         //! Connection, data and request handlers and interfaces of such
  39         namespace Handlers
  40         { /* doc only */ }
  41 }