c_buffer 0.1.2 → 0.1.3

data/README

@@ -7,16 +7,18 @@
  #  author      hugo benichi
  #  email       hugo.benichi@m4x.org
  #  copyright   2012 hugo benichi  
- #  version     0.1.0
+ #  version     0.1.3
  #
  ##
  
   installation:  
  
-    run "rake install" in the root directory
+    run in the root directory
+      rake gem_install
+    
     it will compile the gem library and produce a .gem package for ruby
     it will then install the .gem automatically
     
-  usage, test: 
+  usage: 
   
     cf test/test_cbuffer.rb

data/ext/c_buffer/c_buffer.c

@@ -79,7 +79,7 @@ DLL void
 }
 
 
-DLL void    
+DLL int   
   cbuffer_open(
     cbuffer*      buf, 
     const char*   address
@@ -88,8 +88,12 @@ DLL void
   buf-> output = fopen(address, "w" );
   
   if( !(buf->output) )
+  {
     fprintf(stderr, "cbuffer.c: error while opening file %s\n", address);
-    
+    return -1;
+  }
+   
+  return 0;  
 }
 
 
@@ -155,7 +159,7 @@ DLL int
   while(1)
   { 
     fwrite( buf->outbound->mem, 1, buf-> chunk, buf-> output);
-    count += 1;
+    count += buf->chunk;
     if( buf->stop == buf->outbound )
       break;
     buf->outbound = buf->outbound->next;
@@ -164,3 +168,35 @@ DLL int
   fclose(buf->output);
   return count;
 }
+
+
+DLL int
+  cbuffer_read(cbuffer* buf, int (*reader)(char*, void*) , void* context)
+{  
+  while( !( buf->start ) || buf->inbound == buf->start); 
+  // busy wait while the first buffer is written
+
+  buf->outbound = buf->start;
+  
+  int count = 0;
+  while( !( buf->stop ) )
+  { 
+    reader( buf->outbound->mem, context);
+    
+    count += buf->chunk;
+
+    buf->outbound = buf->outbound->next;
+    while(buf->outbound == buf->inbound); //busy wait
+  }
+  
+  while(1)
+  { 
+    reader( buf->outbound->mem, context);
+    count += buf->chunk;
+    if( buf->stop == buf->outbound )
+      break;
+    buf->outbound = buf->outbound->next;
+  }
+   
+  return count;
+}

data/ext/c_buffer/c_buffer.h

@@ -11,6 +11,7 @@
 typedef   struct cbuffer    cbuffer;
 typedef   struct link       link;
   
+typedef   int (*reader)(char*,void*);
     
 struct
   cbuffer               // 192 bytes on 32bits machines and 352 bytes on 64bits machines
@@ -32,11 +33,13 @@ struct
   };
 
 
-DLL   cbuffer*  cbuffer_new       (int chunk, int size);    //  size is n_chunk * chunk
-DLL   void      cbuffer_free      (cbuffer*);               // don't forget to close output if open
-DLL   void      cbuffer_open      (cbuffer*, const char* ); // open a new file at the given path
+DLL   cbuffer*  cbuffer_new       (int chunk, int size);      //  size is n_chunk * chunk
+DLL   void      cbuffer_free      (cbuffer*);                 // don't forget to close output if open
+DLL   int       cbuffer_open      (cbuffer*, const char* );   // open a new file at the given path
+
+DLL   char*     cbuffer_next      (cbuffer*);                 // blocking, return the next buffer memory inline
+DLL   char*     cbuffer_has_next  (cbuffer*);                 // non-blocking, return null if not ready
+DLL   void      cbuffer_stop      (cbuffer*);                 // flag for stopping (cut the circular list)
+DLL   int       cbuffer_write     (cbuffer*);                 // blocking, write everything untill stop
+DLL   int       cbuffer_read      (cbuffer*, reader, void*);  // blocking, passes memory chunk written to to a user defined handling function 'reader'
 
-DLL   char*     cbuffer_next      (cbuffer*);               // blocking, return the next buffer memory inline
-DLL   char*     cbuffer_has_next  (cbuffer*);               // non-blocking, return null if not ready
-DLL   void      cbuffer_stop      (cbuffer*);               // flag for stopping (cut the circular list)
-DLL   int       cbuffer_write     (cbuffer*);               // blocking, write everything untill stop

data/ext/c_buffer/extconf.rb

@@ -0,0 +1,3 @@
+require 'mkmf'
+
+create_makefile 'c_buffer/c_buffer'

data/rakefile.rb

@@ -23,10 +23,11 @@ task :test_local do
 end
 
 task :gem_install => :gem_build do
-  gemfile = Dir.new("./").entries.select{ |f| f =~ /cbuffer-[\d]+\.[\d]+\.[\d]+.gem/ }[0]
-  sh "gem install %s" % gemfile
+  gemfile = Dir.new("./").entries.select{ |f| f =~ /c_buffer-[\d]+\.[\d]+\.[\d]+.gem/ }[0]
+  puts "installing %s" % gemfile
+  sh "gem install --local %s" % gemfile
 end
 
-task :gem_build => :compile do
+task :gem_build do
   sh "gem build %s.gemspec" % name
 end

data/test/test_c_buffer.rb

@@ -1,17 +1,21 @@
 require 'c_buffer'
 
-repet   = 126
+repet   = 16 #126
 chunk   = 1024*126
 length  = chunk * 64
+data    = Array.new(chunk){rand 255}
 
+puts "data dump test"
+  CBuffer.new( path: "./data", chunk: chunk, length: length ).tap{ |buf| 
+    buf.output
+    repet.times{ |i| buf.input.put_array_of_uchar 0, data }
+    buf.stop
+  }
 
-buf = CBuffer.new( path: "./data", chunk: chunk, length: length )
-buf.write{ |count| puts "wrote #{count} bytes of data" }
-
-data = Array.new(chunk){rand 255}
-
-repet.times do |i|
-  buf.next.put_array_of_uchar 0, data
-end
-
-buf.stop
+puts "reader test"
+  CBuffer.new( chunk: chunk, length: length ).tap{ |buf| 
+    count = 0
+    buf.read{ |data| puts "total data read: %i bytes" % count += data.length }
+    repet.times{ |i| buf.input.put_array_of_uchar 0, data }
+    buf.stop 
+  }

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: c_buffer
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-07-05 00:00:00.000000000 Z
+date: 2012-07-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ffi
-  requirement: &19284820 !ruby/object:Gem::Requirement
+  requirement: &22493360 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,19 +21,18 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *19284820
+  version_requirements: *22493360
 description: A simple circular buffer and its Ruby interface to go along RbScope and
   RbVisa. Perfect for staging high throughput input data to low throughput I/O.
 email: hugo.benichi@m4x.org
 executables: []
-extensions: []
+extensions:
+- ext/c_buffer/extconf.rb
 extra_rdoc_files: []
 files:
-- lib/c_buffer.rb
-- lib/c_buffer/c_buffer.so
-- lib/c_buffer/c_buffer.dll
 - ext/c_buffer/c_buffer.c
 - ext/c_buffer/c_buffer.h
+- ext/c_buffer/extconf.rb
 - rakefile.rb
 - README
 - test/test_c_buffer.rb

data/lib/c_buffer.rb

@@ -1,79 +0,0 @@
-##
- #  
- #                          CBuffer 
- #    
- #  Simple circular buffer for staging data before writing to disk
- #  
- #  author      hugo benichi
- #  email       hugo.benichi@m4x.org
- #  copyright   2012 hugo benichi  
- #  version     0.1.1
- #
- ##
- 
-# Main class and namespace of the program
-# This class should be instancied to use a buffer
-class CBuffer
-
-  require 'ffi'
-
-  # the API module wraps the native functions of cbuffer.c
-  module API
-    extend FFI::Library
-    lib_type = ENV["OS"] ? "dll" : "so"
-    #ffi_lib $LOAD_PATH.map{ |p| p + "/cbuffer/cbuffer.#{lib_type}" }    
-    ffi_lib File.dirname(__FILE__) + "/c_buffer/c_buffer.#{lib_type}"
-    [
-      [ :cbuffer_new,      [:int32, :int32],      :pointer                    ],
-      [ :cbuffer_free,     [:pointer],            :void                       ],
-      [ :cbuffer_open,     [:pointer, :pointer],  :void                       ],
-      [ :cbuffer_next,     [:pointer],            :pointer, :blocking => true ],
-      [ :cbuffer_has_next, [:pointer],            :pointer                    ],
-      [ :cbuffer_stop,     [:pointer],            :void                       ],
-      [ :cbuffer_write,    [:pointer],            :int32,   :blocking => true ],
-    ].each{ |sig| attach_function *sig }
-  end
-  
-  # the CBufferRaw class wraps the native struct memory used to store the buffer memory
-  # not used at the momentm here for reference only
-  class CBufferRaw < FFI::Struct
-    layout  :inbound,   :pointer,
-            :outbound,  :pointer, 
-            :start,     :pointer,
-            :stop,      :pointer,
-            :output,    :pointer,
-            :chunk,     :int   
-  end
-  
-  def initialize args 
-    chunk   = args[:chunk]  || 1
-    length  = args[:length] || 2
-    path    = args[:path]   || 1
-    @struct = API::cbuffer_new chunk, length
-    API::cbuffer_open @struct, path
-    self
-  end
-
-  def write &block
-    running = true
-    self.define_singleton_method :stop do
-      API.cbuffer_stop @struct
-      sleep 1 while running
-      API.cbuffer_free @struct
-    end
-    Thread.new do
-      begin
-        count = API.cbuffer_write @struct
-        running = false
-        block.call(count) if block 
-      catch
-        puts "error in writing thread"
-      end
-    end
-  end
-
-  def next
-    API.cbuffer_next @struct
-  end
-
-end