Source

yatce / README.txt

yatce - Yet Another Tokyo Cabinet Erlang binding

* Abstract

  For users who want to use Tokyo Cabinet from Erlang. 
 Reads 'yatch`e' like 'match'. No messaging, nor context switch between 
 the Linkedin driver and Erlang VM by using 'port_control' API.

* Current Status 

  Working well. But Erlang linkedin driver (say, port) said to be bottleneck,
 But port_control runs in the same thread context with Erlang code. 
 Simple performance test (written in porformer.erl) shows the result that,
 insertion performance reaches 6500 qps, and lookup performance reaches 
 29000 qps; is this a row performance of Tokyo Cabinet? (I expect TC makes
 much better performance)
  
  Currently, and Temporarily, it compiles in MacOSX and Ubuntu 9.04 - users
need edit Makefile ( just comment-out and comment-in a single line ).

  See ebin/tctest.erl for sample programs.


* Compilation

  Edit this line in Makefile.
>>>
c_src/Makefile: 
## on Mac
#	sed -e 's/__INCLUDE__/MacOS\.mk/'  c_src/Makefile.in > $@
## on Ubuntu / Debian
	sed -e 's/__INCLUDE__/Ubuntu\.mk/'  c_src/Makefile.in > $@
## on CentOS, other linux which erts directly installed in /usr/local
#	sed -e 's/__INCLUDE__/CentOS\.mk/'  c_src/Makefile.in > $@
<<<


* ROADMAP

-all-option-support
-all-operation-support
-performance test (is port_control a really bottleneck?)
-documentation (EDocize)
-documentation
-documentation :P
-compatilibily in other environment: Linux, *BSD, Solaris. - badly done
-autoconfize - pending

* RELATED PROJECTS ... orz

-Tokyo Cabinet - what I want to bind
  http://tokyocabinet.sourceforge.net/

-tcerl - Erlang port of Tokyo Cabinet
  http://code.google.com/p/tcerl/
  http://dukesoferl.blogspot.com/2008/06/tokyocabinet-and-mnesia.html

* Interface

 going to make compliant with tokyocabinet.idl
 see http://erlang.g.hatena.ne.jp/kuenishi/20090709/1247142432

* License

LGPLv3. see COPYING, COPYING.LESSER
 http://www.gnu.org/licenses/
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.