socket_accept_filter 1.0.0

data/LICENSE

@@ -0,0 +1,27 @@
+Copyright 2005 Eric Hodel, The Robot Co-op.  All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions
+are met:
+
+1. Redistributions of source code must retain the above copyright
+   notice, this list of conditions and the following disclaimer.
+2. Redistributions in binary form must reproduce the above copyright
+   notice, this list of conditions and the following disclaimer in the
+   documentation and/or other materials provided with the distribution.
+3. Neither the names of the authors nor the names of their contributors
+   may be used to endorse or promote products derived from this software
+   without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE AUTHORS ``AS IS'' AND ANY EXPRESS
+OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHORS OR CONTRIBUTORS BE
+LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY,
+OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
+OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
+BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
+WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
+OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
+EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+

data/Manifest.txt

@@ -0,0 +1,6 @@
+LICENSE
+Manifest.txt
+README
+Rakefile
+lib/socket_accept_filter.rb
+test/test_socket_accept_filter.rb

data/README

@@ -0,0 +1,63 @@
+= socket_accept_filter
+
+Rubyforge Project:
+
+http://rubyforge.org/projects/rctools/
+
+Documentation:
+
+http://dev.robotcoop.com/Libraries/socket_accept_filter
+
+== About
+
+Socket#set_accept_filter allows you to enable accept filters on server sockets.
+
+In FreeBSD accept filters allow you to delay the return from an accept() call
+until enough data arrives on the connection for processing avoiding extra
+context switches while waiting for the missing data.
+
+Consult the accf_data(9), accf_http(9) and accept_filter(9) man pages for
+further details.
+
+== Installing socket_accept_filter
+
+Run FreeBSD (or any BSD, I think).
+
+Then install the gem:
+
+  $ sudo gem install socket_accept_filter
+
+== Using socket_accept_filter
+
+=== Regular sockets
+
+  require 'rubygems'
+  require 'socket'
+  require 'socket_accept_filter'
+  
+  server = TCPServer.new host, port
+  server.set_accept_filter 'dataready'
+
+Then use the server socket as you would ordinarily.
+
+=== WEBrick
+
+  require 'rubygems'
+  require 'socket'
+  require 'socket_accept_filter'
+  require 'webrick'  
+  
+  class MyServer < WEBrick::HTTPServer
+    
+    def listen(*args)
+      super
+      
+      @listeners.each do |server|
+        server.set_accept_filter 'httpready'
+      end
+    end
+    
+  end
+
+Then use MyServer where you would ordinarily use WEBrick::HTTPServer.
+

data/Rakefile

@@ -0,0 +1,71 @@
+require 'rubygems'
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+require 'rake/gempackagetask'
+
+$VERBOSE = nil
+
+spec = Gem::Specification.new do |s|
+  s.name = 'socket_accept_filter'
+  s.version = '1.0.0'
+  s.summary = 'Allows use of FreeBSD\'s accept filters for sockets.'
+  s.description = <<-EOF
+A library that makes setting the SO_ACCEPTFILTER socket option easy.  Only
+known to work on FreeBSD.
+  EOF
+  s.author = 'Eric Hodel'
+  s.email = 'eric@robotcoop.com'
+
+  s.has_rdoc = true
+  s.files = File.read('Manifest.txt').split($/)
+  s.require_path = 'lib'
+
+  s.test_files = Dir.glob('test/test_*.rb')
+
+  s.add_dependency 'RubyInline', '>= 3.5.0'
+end
+
+desc 'Run tests'
+task :default => [ :test ]
+
+Rake::TestTask.new('test') do |t|
+  t.libs << 'test'
+  t.pattern = 'test/test_*.rb'
+  t.verbose = true
+end
+
+desc 'Update Manifest.txt'
+task :update_manifest do
+  sh "find . -type f | sed -e 's%./%%' | egrep -v 'svn|swp|~' | egrep -v '^(doc|pkg)/' | sort > Manifest.txt"
+end
+
+desc 'Generate RDoc'
+Rake::RDocTask.new :rdoc do |rd|
+  rd.rdoc_dir = 'doc'
+  rd.rdoc_files.add 'lib', 'README', 'LICENSE'
+  rd.main = 'README'
+  rd.options << '-d' if `which dot` =~ /\/dot/
+end
+
+desc 'Generate RDoc for dev.robotcoop.com'
+Rake::RDocTask.new :dev_rdoc do |rd|
+  rd.rdoc_dir = '../../../www/trunk/dev/html/Libraries/socket_accept_filter'
+  rd.rdoc_files.add 'lib', 'README', 'LICENSE'
+  rd.main = 'README'
+  rd.options << '-d' if `which dot` =~ /\/dot/
+end
+
+desc 'Build Gem'
+Rake::GemPackageTask.new spec do |pkg|
+  pkg.need_tar = true
+end
+
+desc 'Clean up'
+task :clean => [ :clobber_rdoc, :clobber_package ]
+
+desc 'Clean up'
+task :clobber => [ :clean ]
+
+# vim: syntax=ruby
+

data/lib/socket_accept_filter.rb

@@ -0,0 +1,68 @@
+require 'inline'
+require 'socket'
+
+class BasicSocket
+
+  inline do |builder|
+    builder.include '<sys/types.h>'
+    builder.include '<sys/socket.h>'
+    builder.include '<string.h>'
+
+    builder.include '"ruby.h"'
+    builder.include '"rubyio.h"'
+    builder.include '"rubysig.h"'
+
+    builder.add_compile_flags "-Wall"
+    builder.add_compile_flags "-W"
+    builder.add_compile_flags "-Wpointer-arith"
+    builder.add_compile_flags "-Wcast-qual"
+    builder.add_compile_flags "-Wcast-align"
+    builder.add_compile_flags "-Wwrite-strings"
+    builder.add_compile_flags "-Wmissing-noreturn"
+    builder.add_compile_flags "-Werror"
+
+    builder.add_to_init <<-EOC
+      VALUE rb_cSocket = rb_path2class("Socket");
+      VALUE mConst = rb_path2class("Socket::Constants");
+      rb_define_const(rb_cSocket, "SO_ACCEPTFILTER", INT2FIX(SO_ACCEPTFILTER));
+      rb_define_const(mConst,     "SO_ACCEPTFILTER", INT2FIX(SO_ACCEPTFILTER));
+    EOC
+
+    builder.c_raw <<-EOC
+      static
+      VALUE
+      bsock_set_accept_filter(int argc, VALUE *argv, VALUE sock) {
+        VALUE filter_name;
+        OpenFile *sptr;
+        int s;
+        struct accept_filter_arg afa;
+
+        rb_scan_args(argc, argv, "10", &filter_name);
+
+        GetOpenFile(sock, sptr);
+        s = fileno(sptr->f);
+
+        if ((unsigned long)RSTRING(filter_name)->len > sizeof(afa.af_name))
+          rb_raise(rb_eArgError, "accept filter name is too long");
+
+        bzero(&afa, sizeof(afa));
+        strncpy(afa.af_name, StringValueCStr(filter_name), sizeof(afa.af_name));
+        setsockopt(s, SOL_SOCKET, SO_ACCEPTFILTER, &afa, sizeof(afa));
+
+        return Qnil;
+      }
+    EOC
+  end
+
+  ##
+  # Enables the accept filter named +filter+ on +socket+.
+  #
+  # FreeBSD comes with the filters "httpready" and "dataready".  You may need
+  # to load kernel modules to enable these filters.
+  #
+  # See accept_filter(9), accf_data(9) and accf_http(9).
+
+  alias set_accept_filter bsock_set_accept_filter
+
+end
+

data/test/test_socket_accept_filter.rb

@@ -0,0 +1,38 @@
+#!/usr/local/bin/ruby -w
+
+require 'test/unit'
+require 'socket'
+
+require 'rubygems'
+require 'socket_accept_filter'
+
+class TestSocketAcceptFilter < Test::Unit::TestCase
+
+  def setup
+    @server = TCPServer.new 'localhost', 0
+  end
+
+  def test_set_accept_filter
+    options = @server.getsockopt Socket::SOL_SOCKET, Socket::SO_ACCEPTFILTER
+    assert_equal "\0" * 256, options
+
+    @server.set_accept_filter 'httpready'
+
+    options = @server.getsockopt Socket::SOL_SOCKET, Socket::SO_ACCEPTFILTER
+    expected = "\0" * 256
+    expected[0...9] = 'httpready'
+    assert_equal expected, options
+  end
+
+  def test_set_accept_filter_name_too_long
+    assert_nothing_raised do
+      @server.set_accept_filter 'a' * 16 # HACK depends on header file
+    end
+
+    assert_raises ArgumentError do
+      @server.set_accept_filter 'a' * 17
+    end
+  end
+
+end
+

metadata

@@ -0,0 +1,59 @@
+--- !ruby/object:Gem::Specification 
+rubygems_version: 0.8.11.6
+specification_version: 1
+name: socket_accept_filter
+version: !ruby/object:Gem::Version 
+  version: 1.0.0
+date: 2006-03-23 00:00:00 -08:00
+summary: Allows use of FreeBSD's accept filters for sockets.
+require_paths: 
+- lib
+email: eric@robotcoop.com
+homepage: 
+rubyforge_project: 
+description: A library that makes setting the SO_ACCEPTFILTER socket option easy.  Only known to work on FreeBSD.
+autorequire: 
+default_executable: 
+bindir: bin
+has_rdoc: true
+required_ruby_version: !ruby/object:Gem::Version::Requirement 
+  requirements: 
+  - - ">"
+    - !ruby/object:Gem::Version 
+      version: 0.0.0
+  version: 
+platform: ruby
+signing_key: 
+cert_chain: 
+post_install_message: 
+authors: 
+- Eric Hodel
+files: 
+- LICENSE
+- Manifest.txt
+- README
+- Rakefile
+- lib/socket_accept_filter.rb
+- test/test_socket_accept_filter.rb
+test_files: 
+- test/test_socket_accept_filter.rb
+rdoc_options: []
+
+extra_rdoc_files: []
+
+executables: []
+
+extensions: []
+
+requirements: []
+
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: RubyInline
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Version::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 3.5.0
+    version: