alepharchives / erlvolt Goto Github PK

%%%-------------------------------------------------------------------------%%%
%%% File        : README                                                    %%% 
%%% Version     : 0.2.01/alpha                                              %%%
%%% Description : Erlang-VoltDB client API                                  %%%
%%% Copyright   : VoltDB, LLC - http://www.voltdb.com                       %%%
%%% Production  : Eonblast Corporation - http://www.eonblast.com            %%%
%%% Author      : H. Diedrich <[email protected]>                         %%%
%%% License     : GPLv3                                                     %%%
%%% Created     : 17 Apr 2010                                               %%%
%%% Changed     : 25 May 2010                                               %%% 
%%%-------------------------------------------------------------------------%%%
%%%                                                                         %%%
%%%   Erlvolt is an Erlang interface to a VoltDB server. It allows for      %%%
%%%   Erlang programs to talk with the VoltDB server as VoltDB clients.     %%%
%%%                                                                         %%%
%%%-------------------------------------------------------------------------%%%
%%%                                                                         %%%
%%%   This API is being contributed to VoltDB by Eonblast Corporation.      %%%
%%%                                                                         %%%
%%%-------------------------------------------------------------------------%%%
%%%                                                                         %%%
%%%   STATUS                                                                %%%
%%%                                                                         %%%
%%%   All basic functionality is implemented and unit tested. Test pro-     %%%
%%%   grams are being written to test usability. Function signatures are    %%%
%%%   yet to change mildly. Asynchronous calls are not yet supported.       %%%
%%%                                                                         %%%
%%%   REQUIREMENTS                                                          %%%
%%%                                                                         %%%
%%%   + VoltDB 1.0.01                                                       %%%
%%%   + Tested on Java 1.6.0-17 (use -18+!)                                 %%%
%%%   + Tested on Erlang R13B01                                             %%%
%%%                                                                         %%%
%%%   TESTS                                                                 %%%
%%%                                                                         %%%
%%%   + Have at least Erlang R12B-4                                         %%%
%%%   + Get Erlunit from http://github.com/Eonblast/Erlunit/tarball/master  %%%
%%%     and put it into subfolder erlunit, inside your Erlvolt folder.      %%%
%%%   + From the OS command line run ./test                                 %%%
%%%                                                                         %%%
%%%   SAMPLE                                                                %%%
%%%                                                                         %%%
%%%   + From the OS command line run ./hello                                %%% 
%%%                                                                         %%%
%%%   DOCS                                                                  %%%
%%%                                                                         %%%
%%%   + point your browser to doc/index.html                                %%% 
%%%                                                                         %%%
%%%-------------------------------------------------------------------------%%%
%%%                                                                         %%%
%%%     Erlvolt is used for Solar Pirates http://www.eonblast.com.          %%%
%%%                                                                         %%%
%%%-------------------------------------------------------------------------%%%
%%%                                                                         %%%
%%%   THE FUTURE:                                                           %%%
%%%                                                                         %%%
%%%   Erlvolt is an Erlang interface to a VoltDB server. It allows for an   %%%
%%%   Erlang program  to take the place of a  VoltDB client.  Just as the   %%%
%%%   original Java clients, Erlvolt clients:                               %%%
%%%                                                                         %%%
%%%   * can be multiple clients                                             %%%
%%%   * can make synchronous or asynchronous request                        %%%
%%%   * asynchronous requests can be fed a call back                        %%%
%%%                                                                         %%%
%%%   Erlvolt communicates with the VoltDB server using the binary VoltDB   %%%
%%%   wire protocol.  The server does not know wether it is  talking to a   %%%
%%%   Java or an Erlang client.                                             %%%  
%%%                                                                         %%% 
%%%   In many cases the  Erlang  program  will itself be a server and the   %%%
%%%   VoltDB server its database back end.  Implementation of  Erlvolt is   %%%
%%%   as a library.                                                         %%%
%%%                                                                         %%%
%%%-------------------------------------------------------------------------%%%
%%%                                                                         %%%
%%%    Erlvolt 0.2.01/alpha - an Erlang-VoltDB client API.                  %%%
%%%    Copyright (C) 2010 VoltDB, LLC http://www.voltdb.com                 %%%
%%%    Author H. Diedrich <[email protected]> http://www.eonblast.com     %%%
%%%                                                                         %%%
%%%    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 the Free Software Foundation,  either version  3 of    %%%
%%%    the License,  or (at your option) any later version.                 %%%
%%%                                                                         %%%
%%%    This program is distributed  in the hope  that it will be useful,    %%%
%%%    but  WITHOUT ANY WARRANTY;  without  even the implied warranty of    %%%
%%%    MERCHANTABILITY  or  FITNESS FOR  A PARTICULAR PURPOSE.  See  the    %%%
%%%    GNU General Public License for more details.                         %%%
%%%                                                                         %%%
%%%    You should have received a copy of the GNU General Public License    %%%
%%%    along with this program. If not, see <http://www.gnu.org/licenses/>. %%%
%%%                                                                         %%%
%%%-------------------------------------------------------------------------%%%