localmemcache 0.0.1

data/AUTHORS

@@ -0,0 +1 @@
+Sven C. Koehler <schween@snafu.de>

data/COPYING

@@ -0,0 +1,21 @@
+The MIT License
+
+Copyright (c) 2009 Sven C. Koehler
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/LICENSE

@@ -0,0 +1,3 @@
+Copyright (c) 2009 Sven C. Koehler (schween at s n a f u dot de)
+Localmemcache is freely distributable under the terms of an MIT-style license.
+See COPYING or http://www.opensource.org/licenses/mit-license.php.

data/Makefile.in

@@ -0,0 +1,18 @@
+CC=@CC@
+VERSION=@VERSION@
+PACKAGE=pkg/localmemcache-$(VERSION).tar.gz
+
+compile ruby-binding clean install: 
+	-$(MAKE) -C src $@
+
+distclean:
+	rm -f config.status Makefile 
+	rm -rf autom4te.cache 
+	-$(MAKE) -C src $@
+
+package:
+	@echo "CREATING package $(PACKAGE)"
+	test -d pkg || mkdir pkg
+	-tar cvfz $(PACKAGE) `git ls-files`
+	
+

data/README

@@ -0,0 +1,83 @@
+localmemcache README
+=====================
+
+Efficiently sharing a hashtable between processes on a local Unix machine.
+
+WHAT IS IT?
+===========
+
+localmemcache aims to be faster than using memcached locally by using shared
+memory, but providing a similar interface.
+
+
+PERFORMANCE
+===========
+Here's a quick speed comparison, made on an 
+Intel(R) Xeon(R) CPU E5205 @ 1.86GHz:
+
+Benchmark pseudo code:
+
+2_000_000.times {
+  index = rand(10000).to_s
+  $hash.set(index, index)
+  $hash.get(index)
+}
+
+MemCache:      253326.122 ms
+LocalMemCache: 6055.552 ms
+Ruby's Hash:   4963.313 ms
+
+So localmemcache is about 40 times faster than using memcache locally, and
+about 20% slower than Ruby's hash.
+
+EXAMPLE
+=======
+
+In Ruby:
+
+require 'localmemcache'
+$lm = LocalMemCache.new :namespace => :viewcounters
+$lm[:foo] = 1
+$lm[:foo]
+$lm.delete(:foo)
+
+
+INSTALLATION
+============
+
+# gem install localmemcache
+
+How localmemcache works
+=======================
+
+localmemcache is essentially three components:
+
+- a wrapper around mmap()
+- an allocator that works with relative memory addresses (replaces malloc(), etc.)
+- hashtable data type
+
+Namespace life-cycle
+====================
+
+| $lm = LocalMemCache.new :namespace => :viewcounters #, :size_mb => 1024
+
+Namespaces reside as memory-mapped files in /var/tmp/localmemcache.  If the
+namespace does not yet exist, it is created with a default size of 1GB.  It is
+not possible to resize a namespace, so choose a size that will be enough to
+hold all your data.  The class method clear_namespace can be used to delete
+namespaces.  You should also use this function in case your namespace becomes
+inconsistent.  Note that just deleting the memory-mapped file is not enough.
+
+The default size of a namespace is 1GB, it can be changed by passing the option
+:size_mb to the constructor.  Note that this is the maximum size of the shared
+memory segment which cannot be extended later without clearing the namespace
+first.  Setting large sizes shouldn't be much of a problem since only that
+memory which is really used will exist in physical ram and disk.
+
+SUPPORTED SYSTEMS
+=================
+
+- Unix (for mmap)
+- A CPU architecture with more than 32 bit is recommended, since otherwise you
+  might run out of virtual address space when you use larger shared memory
+  segments.

data/Rakefile

@@ -0,0 +1,78 @@
+task :default do
+end
+
+def manifest
+  `git ls-files`.split("\n").select{|n| !%r!/site/!.match(n) }
+end
+
+def version() File.read("VERSION") end
+
+desc "Generate a ChangeLog"
+task :changelog do
+  File.open("ChangeLog", "w") { |out|
+    `git log -z`.split("\0").map { |chunk|
+      author = chunk[/Author: (.*)/, 1].strip
+      date = chunk[/Date: (.*)/, 1].strip
+      desc, detail = $'.strip.split("\n", 2)
+      detail ||= ""
+      detail.rstrip!
+      out.puts "#{date}  #{author}"
+      out.puts "  * #{desc.strip}"
+      out.puts detail  unless detail.empty?
+      out.puts
+    }
+  }
+end
+
+#task :pushsite => [:rdoc] do
+task :pushsite do
+  sh "chmod 755 site"
+  sh "chmod 644 site/*.html"
+  sh "chmod 644 site/*.css"
+  sh 'rsync --rsh="ssh -i $HOME/.ssh/id_rsa_projects -l sck" -avz site/ sck@localmemcache.rubyforge.org:/var/www/gforge-projects/localmemcache/'
+end
+
+begin
+  require 'rubygems'
+
+  require 'rake'
+  require 'rake/clean'
+  require 'rake/packagetask'
+  require 'rake/gempackagetask'
+  require 'fileutils'
+rescue LoadError
+else
+
+  spec = Gem::Specification.new do |s|
+    s.name            = "localmemcache"
+    s.version         = version
+    s.platform        = Gem::Platform::RUBY
+    s.summary         = "Efficiently sharing a hashtable between " +
+        "processes on a local Unix machine."
+
+    s.description = <<-EOF
+
+Localmemcache aims to be faster than using memcached locally by using shared
+memory, but providing a similar interface.
+    EOF
+
+    s.files = manifest 
+    s.extensions = ['configure', 'src/ruby-binding/extconf.rb']
+    s.require_path = 'src/ruby-binding'
+    s.has_rdoc = false
+    s.test_files = Dir['src/test/*.rb']
+
+    s.author = 'Sven C. Koehler'
+    s.email = 'schween@snafu.de'
+    s.homepage = 'http://localmemcache.rubyforge.org/'
+    s.rubyforge_project = 'localmemcache'
+  end
+
+  Rake::GemPackageTask.new(spec) do |p|
+    p.gem_spec = spec
+    p.need_tar = false
+    p.need_zip = false
+  end
+
+end
+

data/VERSION

@@ -0,0 +1 @@
+0.0.1

data/aclocal.m4

@@ -0,0 +1,3 @@
+dnl
+dnl
+dnl