eventmachine 0.12.2 → 0.12.4

data/Rakefile

@@ -0,0 +1,191 @@
+#!/usr/bin/env rake
+#--
+# Ruby/EventMachine
+#   http://rubyeventmachine.com
+#   Copyright (C) 2006-07 by Francis Cianfrocca
+#
+#   This program is copyrighted free software. You may use it under
+#   the terms of either the GPL or Ruby's License. See the file
+#   COPYING in the EventMachine distribution for full licensing
+#   information.
+#
+# $Id$
+#++
+
+### OLD RAKE: ###
+# # The tasks and external gemspecs we used to generate binary gems are now
+# # obsolete. Use Patrick Hurley's gembuilder to build binary gems for any
+# # desired platform.
+# # To build a binary gem on Win32, ensure that the include and lib paths
+# # both contain the proper references to OPENSSL. Use the static version
+# # of the libraries, not the dynamic, otherwise we expose the user to a
+# # runtime dependency.
+# 
+# # To build a binary gem for win32, first build rubyeventmachine.so
+# # using VC6 outside of the build tree (the normal way: ruby extconf.rb,
+# # and then nmake). Then copy rubyeventmachine.so into the lib directory,
+# # and run rake gemwin32.
+#
+
+require 'rubygems'  unless defined?(Gem)
+require 'rake'      unless defined?(Rake)
+require 'rake/gempackagetask'
+
+Package = true # Build zips and tarballs?
+Dir.glob('tasks/*.rake').each { |r| Rake.application.add_import r }
+
+# e.g. rake EVENTMACHINE_LIBRARY=java for forcing java build tasks as defaults!
+$eventmachine_library = :java if RUBY_PLATFORM =~ /java/ || ENV['EVENTMACHINE_LIBRARY'] == 'java'
+$eventmachine_library = :pure_ruby if ENV['EVENTMACHINE_LIBRARY'] == 'pure_ruby'
+
+MAKE = ENV['MAKE'] || if RUBY_PLATFORM =~ /mswin/ # mingw uses make.
+  'nmake'
+else
+  'make'
+end
+
+# If running under rubygems...
+__DIR__ ||= File.expand_path(File.dirname(__FILE__))
+if Gem.path.map{|path| Dir.chdir(path){ Dir.pwd } rescue path }.any? {|path| %r(^#{Regexp.escape path}) =~ __DIR__}
+  task :default => :gem_build
+else
+  desc "Build gemspec, then build eventmachine, then run tests."
+  task :default => [:build, :test]
+end
+
+desc ":default build when running under rubygems."
+task :gem_build => :build
+
+desc "Build extension (or EVENTMACHINE_LIBRARY) and place in lib"
+build_task = 'ext:build'
+build_task = 'java:build' if $eventmachine_library == :java
+build_task = :dummy_build if $eventmachine_library == :pure_ruby
+task :build => build_task do |t|
+  Dir.glob('{ext,java/src,ext/fastfilereader}/*.{so,bundle,dll,jar}').each do |f|
+    mv f, "lib"
+  end
+end
+
+task :dummy_build
+
+# Basic clean definition, this is enhanced by imports aswell.
+task :clean do
+  chdir 'ext' do
+    sh "#{MAKE} clean" if test ?e, 'Makefile'
+  end
+  chdir 'ext/fastfilereader' do
+    sh "#{MAKE} clean" if test ?e, 'Makefile'
+  end
+  Dir.glob('**/Makefile').each { |file| rm file }
+  Dir.glob('**/*.{o,so,bundle,class,jar,dll,log}').each { |file| rm file }
+  Dir.glob('ext/**/conftest.dSYM').each{ |file| rm_rf file }
+end
+
+Spec = Gem::Specification.new do |s|
+  s.name              = "eventmachine"
+  s.summary           = "Ruby/EventMachine library"
+  s.platform          = Gem::Platform::RUBY
+
+  s.has_rdoc          = true
+  s.rdoc_options      = %w(--title EventMachine --main docs/README --line-numbers)
+  s.extra_rdoc_files  = Dir['docs/*']
+
+  s.files             = %w(Rakefile) + Dir["{bin,tests,lib,ext,java,tasks}/**/*"]
+
+  s.require_path      = 'lib'
+
+  # TODO / XXX - should we enable this? rubygems fails the install if anything 
+  # is broken. What we could do is CI submission, though, and always terminate
+  # with a positive code...
+  # s.test_file         = "tests/testem.rb"
+  s.extensions        = "Rakefile"
+
+  s.author            = "Francis Cianfrocca"
+  s.email             = "garbagecat10@gmail.com"
+  s.rubyforge_project = 'eventmachine'
+  s.homepage          = "http://rubyeventmachine.com"
+
+  # Pulled in from readme, as code to pull from readme was not working!
+  # Might be worth removing as no one seems to use gem info anyway.
+  s.description = <<-EOD
+EventMachine implements a fast, single-threaded engine for arbitrary network
+communications. It's extremely easy to use in Ruby. EventMachine wraps all
+interactions with IP sockets, allowing programs to concentrate on the
+implementation of network protocols. It can be used to create both network
+servers and clients. To create a server or client, a Ruby program only needs
+to specify the IP address and port, and provide a Module that implements the
+communications protocol. Implementations of several standard network protocols
+are provided with the package, primarily to serve as examples. The real goal
+of EventMachine is to enable programs to easily interface with other programs
+using TCP/IP, especially if custom protocols are required.
+  EOD
+
+  require 'lib/eventmachine_version'
+  s.version = EventMachine::VERSION
+end
+
+namespace :ext do
+  ext_sources = FileList['ext/*.{h,cpp,rb,c}']
+  ffr_sources = FileList['ext/fastfilereader/*.{h,cpp,rb}']
+  
+  desc "Build C++ extension"
+  task :build => [:make]
+  
+  desc "make extensions"
+  task :make => ext_sources + ['ext/Makefile'] do
+    chdir 'ext' do
+      sh MAKE
+    end
+  end
+  task :make => ffr_sources + ['ext/fastfilereader/Makefile'] do
+    chdir 'ext/fastfilereader' do
+      sh MAKE
+    end
+  end
+  
+  desc 'Compile the makefile'
+  file 'ext/Makefile' => ext_sources do
+    chdir 'ext' do
+      ruby 'extconf.rb'
+    end
+  end
+
+  desc 'Compile fastfilereader makefile'
+  file 'ext/fastfilereader/Makefile' => ffr_sources do
+    chdir 'ext/fastfilereader' do
+      ruby 'extconf.rb'
+    end
+  end
+end
+  
+namespace :java do
+  # This task creates the JRuby JAR file and leaves it in the lib directory.
+  # This step is required before executing the jgem task.
+  desc "Build java extension"
+  task :build => [:jar] do |t|
+    chdir('java/src') do
+      mv 'em_reactor.jar', '../../lib/em_reactor.jar'
+    end
+  end
+  
+  desc "compile .java to .class"
+  task :compile do
+    chdir('java/src') do
+      sh 'javac com/rubyeventmachine/*.java'
+    end
+  end
+  
+  desc "compile .classes to .jar"
+  task :jar => [:compile] do
+    chdir('java/src') do
+      sh "jar -cf em_reactor.jar com/rubyeventmachine/*.class"
+    end
+  end
+end
+
+task :gemspec => :clobber do
+  open("eventmachine.gemspec", 'w') { |f| f.write Spec.to_ruby }
+end
+
+task :clobber => :clean
+task :test => :build

data/docs/ChangeLog

@@ -0,0 +1,183 @@
+# $Id$
+#
+#
+
+#-------------------------------------------------------------
+01Oct06: Replaced EventMachine#open_datagram_server with a version that can take
+a Class or a Module, instead of just a Module. Thanks to Tobias Gustafsson for
+pointing out the missing case.
+
+04Oct06: Supported subsecond timer resolutions, per request by Jason Roelofs.
+05Oct06: Added EventMachine#set_quantum, which sets the timer resolution.
+15Nov06: Added Connection#set_comm_inactivity_timeout.
+15Nov06: Checked in a Line-and-Text Protocol Handler.
+18Nov06: Checked in a Header-and-Body Protocol Handler.
+22Nov06: Changed EventMachine#reconnect: no longer excepts when called on an
+         already-connected handler.
+28Nov06: Supported a binary-unix gem.
+19Dec06: Added EventMachine#set_effective_user.
+05Jan07: Upped max outstanding timers to 1000.
+15May07: Applied Solaris patches from Brett Eisenberg
+22May07: Cleaned up the license text in all the source files.
+22May07: Released version 0.7.2
+
+23May07: Per suggestion from Bill Kelly, fixed a bug with the initialization
+ 	of the network libraries under Windows. The goal is to enable EM to
+	be used without Ruby.
+28May07: Applied patch from Bill Kelly, refactors the declarations of
+	event names to make EM easier to use from C programs without Ruby.
+31May07: Added a preliminary implementation of EventMachine#popen.
+01Jun07: Added EM, a "pseudo-alias" for EventMachine.
+01Jun07: Added EM#next_tick.
+01Jun07: Added EM::Connection#get_outbound_data_size
+05Jun07: Removed the code which loads a pure-Ruby EM library in case the
+	compiled extension is unavailable. Suggested by Moshe Litvin.
+06Jun07: Preliminary epoll implementation.
+12Jun07: Added an evented popen implementation that, like Ruby's, is
+	full-duplex and makes the subprocess PID available to the caller.
+06Jul07: Performance-tweaked the callback dispatcher in eventmachine.rb.
+10Jul07: Released version 0.8.0.
+12Jul07: Applied patches from Tim Pease to fix Solaris build problems.
+15Jul07: Created a new provisional source branch, experiments/jruby-1.
+	This is a preliminary implementation of the EM reactor in Java,
+	suitable for use with JRuby.
+17Jul07: Added EventMachine#stop_server, per request from Kirk Haines,
+	and associated unit tests.
+22Jul07: Added EventMachine#stream_file_data. This is a very fast and scalable
+	way of sending data from static files over network connections. It
+	has separate implementations for small files and large file, and
+	has tunings to minimize memory consumption.
+26Jul07: Added some patches by Kirk Haines to improve the behavior of
+	EM::Connection#send_file_data_to_connection.
+26Jul07: Added a C++ module for directly integrating EM into C++ programs
+	with no Ruby dependencies. Needs example code.
+29Jul07: Added EventMachine::Protocols::LineText2.
+29Jul07: Added EventMachine::Protocols::Stomp.
+30Jul07: Added sys/stat.h to project.h to fix compilation bug on Darwin.
+13Aug07: Added EventMachine#reactor_running?
+15Aug07: Added parameters for EventMachine::Connection:start_tls that can be
+	used to specify client-side private keys and certificates.
+17Aug07: Added EventMachine#run_block, a sugaring for a common use case.
+24Aug07: Added a preliminary keyboard handler. Needs docs and testing on
+	windows.
+26Aug07: Created EventMachine::Spawnable, an implementation of Erlang-like
+	processes.
+27Aug07: Silenced some -w warnings, requested by James Edward Gray II.
+30Aug07: Added cookies to EM::HttpClient#request.
+04Sep07: Added an initial implementation of an evented SMTP client.
+04Sep07: Added an initial implementation of an evented SMTP server.
+10Sep07: Changed EM#spawn to run spawned blocks in the context of the
+	SpawnedProcess object, not of whatever was the active object at the
+	time of the spawn.
+14Sep07: Heartbeats weren't working with EPOLL. Noticed by Brian Candler.
+15Sep07: Added some features, tests and documents to Deferrable.
+16Sep07: Added [:content] parameter to EM::Protocols::SmtpClient#send.
+16Sep07: Bumped version to 0.9.0 in anticipation of a release.
+18Sep07: Released version 0.9.0.
+19Sep07: Added #receive_reset to EM::Protocols::SmtpServer.
+19Sep07: User overrides of EM::Protocols::SmtpServer#receive_recipient can now
+	return a Deferrable. Also fixed bug: SmtpClient now raises a protocol
+	error if none of its RCPT TO: commands are accepted by the server.
+26Sep07: Fixed missing keyboard support for Windows.
+03Oct07: Added a default handler for RuntimeErrors emitted from user-written
+	code. Suggested by Brian Candler.
+19Oct07: Set the SO_BROADCAST option automatically on all UDP sockets.
+10Nov07: Forced integer conversion of send_datagram's port parameter.
+Suggested by Matthieu Riou.
+12Nov07: Added saslauth.rb, a protocol module to replace the Cyrus SASL
+daemons saslauthd and pwcheck.
+15Nov07: Fixed bug reported by Mark Zvillius. We were failing to dispatch
+	zero-length datagrams under certain conditions.
+19Nov07: Added EventMachine#set_max_timers. Requested by Matthieu Riou and
+	others.
+19Nov07: Fixed bug with EM::Connection#start_tls. Was not working with server
+	connections. Reported by Michael S. Fischer.
+26Nov07: Supported a hack for EventMachine#popen so it can return an exit
+	status from subprocesses. Requested by Michael S. Fischer.
+30Nov07: Changed Pipe descriptors so that the child-side of the socketpair is
+	NOT set nonblocking. Suggested by Duane Johnson.
+05Dec07: Re-enabled the pure-Ruby implementation.
+06Dec07: Released Version 0.10.0.
+13Dec07: Added EM::DeferrableChildProcess
+24Dec07: Added a SASL client for simple password authentication.
+27Dec07: Removed the hookable error handler. No one was using it and it significantly
+	degraded performance.
+30Dec07: Implemented Kqueue support for OSX and BSD.
+04Jan08: Fixed bug in epoll ("Bad file descriptor"), patch supplied by Chris
+	Heath.
+04Jan08: Fixed bug reported by Michael S. Fischer. We were terminating
+	SSL connections that sent data before the handshake was complete.
+08Jan08: Added an OpenBSD branch for extconf.rb, contributed by Guillaume
+	Sellier.
+19Jan08: Added EM::Connection::get_sockname per request by Michael Fischer.
+19Jan08: Supported IPv6 addresses.
+30Apr08: Set the NODELAY option on sockets that we connect to other servers.
+	Omission noted by Roger Pack.
+14May08: Generated a 0.12 release.
+15May08: Supported EM#get_sockname for acceptors (TCP server sockets).
+	Requested by Roger Pack.
+15May08; Accepted a patch from Dan Aquino that allows the interval of a
+	PeriodicTimer to be changed on the fly.
+15Jun08: Supported nested calls to EM#run. Many people contributed ideas to
+	this, notably raggi and tmm1.
+20Jul08: Accepted patch from tmm1 for EM#fork_reactor.
+28Jul08: Added a Postgres3 implementation, written by FCianfrocca.
+14Aug08: Added a patch by Mike Murphy to support basic auth in the http
+client.
+28Aug08: Added a patch by tmm1 to fix a longstanding problem with Java
+data-sends.
+13Sep08: Added LineText2#set_binary_mode, a back-compatibility alias.
+13Sep08: Modified the load order of protocol libraries in eventmachine.rb
+	to permit a modification of HeaderAndContentProtocol.
+13Sep08: Modified HeaderAndContent to use LineText2, which is less buggy
+	than LineAndTextProtocol. This change may be reversed if we can fix
+	the bugs in buftok.
+13Sep08: Improved the password handling in the Postgres protocol handler.
+15Sep08: Added attach/detach, contributed by Aman Gupta (tmm1) and Riham Aldakkak,
+	to support working with file descriptors not created in the reactor.
+16Sep08: Added an optional version string to the HTTP client. This is a hack
+	that allows a client to specify a version 1.0 request, which
+	keeps the server from sending a chunked response. The right way to
+	solve this, of course, is to support chunked responses.
+23Sep08: ChangeLog Summary for Merge of branches/raggi
+Most notable work and patches by Aman Gupta, Roger Pack, and James Tucker. 
+Patches / Tickets also submitted by: Jeremy Evans, aanand, darix, mmmurf, 
+danielaquino, macournoyer.
+ - Moved docs into docs/ dir
+ - Major refactor of rakefile, added generic rakefile helpers in tasks
+ - Added example CPP build rakefile in tasks/cpp.rake
+ - Moved rake tests out to tasks/tests.rake
+ - Added svn ignores where appropriate
+ - Fixed jruby build on older java platforms
+ - Gem now builds from Rakefile rather than directly via extconf
+ - Gem unified for jruby, C++ and pure ruby.
+ - Correction for pure C++ build, removing ruby dependency
+ - Fix for CYGWIN builds on ipv6
+ - Major refactor for extconf.rb
+ - Working mingw builds
+ - extconf optionally uses pkg_config over manual configuration
+ - extconf builds for 1.9 on any system that has 1.9
+ - extconf no longer links pthread explicitly
+ - looks for kqueue on all *nix systems
+ - better error output on std::runtime_error, now says where it came from
+ - Fixed some tests on jruby
+ - Added test for general send_data flaw, required for a bugfix in jruby build
+ - Added timeout to epoll tests
+ - Added fixes for java reactor ruby api
+ - Small addition of some docs in httpclient.rb and httpcli2.rb
+ - Some refactor and fixes in smtpserver.rb
+ - Added parenthesis where possible to avoid excess ruby warnings
+ - Refactor of $eventmachine_library logic for accuracy and maintenance, jruby
+ - EM::start_server now supports unix sockets
+ - EM::connect now supports unix sockets
+ - EM::defer @threadqueue now handled more gracefully
+ - Added better messages on exceptions raised
+ - Fix edge case in timer fires
+ - Explicitly require buftok.rb
+ - Add protocols to autoload, rather than require them all immediately
+ - Fix a bug in pr_eventmachine for outbound_q
+ - Refactors to take some of the use of defer out of tests.
+ - Fixes in EM.defer under start/stop conditions. Reduced scope of threads.
+23Sep08: Added patch from tmm1 to avoid popen errors on exit.
+30Sep08: Added File.exists? checks in the args for start_tls, as suggested by
+  Brian Lopez (brianmario).

data/{DEFERRABLES → docs/DEFERRABLES}

@@ -1,4 +1,4 @@
-$Id: DEFERRABLES 668 2008-01-04 23:00:34Z blackhedd $
+$Id$
 
 [DOCUMENT UNDER CONSTRUCTION]
 

data/docs/INSTALL

@@ -0,0 +1,15 @@
+$Id$
+
+If you have obtained an EventMachine source-tarball (.tar.gz):
+unzip and untar the tarball, and enter the directory that is
+created. In that directory, say:
+ruby setup.rb
+(You may need to be root to execute this command.)
+
+To create documentation for EventMachine, simply type:
+rdoc
+in the distro directory. Rdocs will be created in subdirectory doc.
+
+If you have obtained a gem version of EventMachine, install it in the
+usual way (gem install eventmachine). You may need superuser privileges
+to execute this command.

data/{LIGHTWEIGHT_CONCURRENCY → docs/LIGHTWEIGHT_CONCURRENCY}

@@ -1,4 +1,4 @@
-$Id: LIGHTWEIGHT_CONCURRENCY 668 2008-01-04 23:00:34Z blackhedd $
+$Id$
 
 EventMachine (EM) adds two different formalisms for lightweight concurrency to the Ruby programmer's toolbox: spawned processes and deferrables. This note will show you how to use them.
 

data/{PURE_RUBY → docs/PURE_RUBY}

@@ -1,4 +1,4 @@
-$Id: PURE_RUBY 668 2008-01-04 23:00:34Z blackhedd $
+$Id$
 
 EventMachine is supplied in three alternative versions.
 

data/{README → docs/README}

@@ -1,4 +1,4 @@
-$Id: README 668 2008-01-04 23:00:34Z blackhedd $
+$Id$
 
 = RUBY/EventMachine
 

data/{RELEASE_NOTES → docs/RELEASE_NOTES}

@@ -1,4 +1,4 @@
-$Id: RELEASE_NOTES 668 2008-01-04 23:00:34Z blackhedd $
+$Id$
 
 RUBY/EventMachine RELEASE NOTES
 

data/{SMTP → docs/SMTP}

@@ -1,4 +1,4 @@
-$Id: SMTP 668 2008-01-04 23:00:34Z blackhedd $
+$Id$
 
 
 [DOCUMENT UNDER CONSTRUCTION]

data/{SPAWNED_PROCESSES → docs/SPAWNED_PROCESSES}

@@ -1,4 +1,4 @@
-$Id: SPAWNED_PROCESSES 668 2008-01-04 23:00:34Z blackhedd $
+$Id$
 
 [DOCUMENT UNDER CONSTRUCTION]