README

   1 Ebb Web Server
   2
   3 = Design
   4
   5 The design is similar to the Evented Mongrel web server; except instead of
   6 using EventMachine (a ruby binding to libevent), the Ebb web server is written
   7 in C and uses the libev event loop library (http://software.schmorp.de/pkg/libev.html).
   8
   9 Connections are processed as follows:
  10
  11 1. libev loops and waits for incoming connections.
  12
  13 2. When Ebb can read from a client socket, it passes the buffer into the
  14    mongrel state machine which parses the headers into name value pairs.
  15
  16 3. Ebb starts passes the request information and peer socket to a user
  17    supplied callback.
  18
  19 4. The included Ruby binding, supplying this callback transforms the request
  20    into a Rack compatible "env" variable and passes it on a Rack adapter.
  21
  22 Because Ebb is written entirely in C, other language bindings can be added to
  23 make it useful to Non-Ruby frameworks. For example a Python WSGI interface is
  24 forthcoming.
  25
  26 Ebb aims to be the smallest and fastest web server possible specifically for
  27 doing the processing for web frameworks like Rails.
  28
  29 It's less than 1000 lines of C code!
  30
  31 = TODO, ordered
  32 * Log levels
  33 * Option to listen on unix sockets instead of tcp
  34 * ebb_merb executable
  35 * Python binding
  36 * Better build system - using scon? (http://www.scons.org/)
  37   Not autoconf.
  38
  39 = License
  40
  41 Copyright (c) 2007 Ryan Dahl
  42
  43 Permission is hereby granted, free of charge, to any person obtaining
  44 a copy of this software and associated documentation files (the
  45 "Software"), to deal in the Software without restriction, including
  46 without limitation the rights to use, copy, modify, merge, publish,
  47 distribute, sublicense, and/or sell copies of the Software, and to
  48 permit persons to whom the Software is furnished to do so, subject to
  49 the following conditions:
  50
  51 The above copyright notice and this permission notice shall be
  52 included in all copies or substantial portions of the Software.
  53
  54 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
  55 EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  56 MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
  57 NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
  58 LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
  59 OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
  60 WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.