proxymachine 0.2.3 → 0.2.6

data/README.md

@@ -20,20 +20,21 @@ contents of the transmission, then ProxyMachine will make your life easy!
 The idea here is simple. For each client connection, start receiving data
 chunks and placing them into a buffer. Each time a new chunk arrives, send the
 buffer to a user specified block. The block's job is to parse the buffer to
-determine where the connection should proxied. If the buffer contains enough
-data to make a determination, the block returns the address and port of the
-correct backend server. If not, it can choose to either do nothing and wait
-for more data to arrive, or close the connection. Once the block returns an
-address, a connection to the backend is made, the buffer is replayed to the
-backend, and the client and backend connections are hooked up to form a
-straight proxy. This bidirectional proxy continues to exist until either the
-client or backend close the connection.
+determine where the connection should be proxied. If the buffer contains
+enough data to make a determination, the block returns the address and port of
+the correct backend server. If not, it can choose to do nothing and wait for
+more data to arrive, close the connection, or close the connection after
+sending custom data. Once the block returns an address, a connection to the
+backend is made, the buffer is replayed to the backend, and the client and
+backend connections are hooked up to form a transparent proxy. This
+bidirectional proxy continues to exist until either the client or backend
+close the connection.
 
 
 Installation
 ------------
 
-    gem install mojombo-proxymachine -s http://gems.github.com
+    $ gem install proxymachine -s http://gemcutter.org
 
 
 Running
@@ -48,6 +49,19 @@ Running
       -p, --port PORT                  Port to listen on. Default 5432
 
 
+Signals
+-------
+
+    QUIT - Graceful shutdown. Stop accepting connections immediately and
+           wait as long as necessary for all connections to close.
+
+    TERM - Fast shutdown. Stop accepting connections immediately and wait
+           up to 10 seconds for connections to close before forcing
+           termination.
+
+    INT  - Same as TERM
+
+
 Example routing config file
 ---------------------------
 
@@ -63,7 +77,7 @@ Example routing config file
     # header information from the Git protocol is parsed to find the 
     # username and a lookup routine is run on the name to find the correct
     # backend server. If no match can be made yet, do nothing with the
-    # connection yet.
+    # connection.
     proxy do |data|
       if data =~ %r{^....git-upload-pack /([\w\.\-]+)/[\w\.\-]+\000host=\w+\000}
         name = $1
@@ -80,7 +94,7 @@ Valid return values
 `{ :remote => String }` - String is the host:port of the backend server that will be proxied.  
 `{ :remote => String, :data => String }` - Same as above, but send the given data instead.  
 `{ :noop => true }` - Do nothing.  
-`{ :close` => true } - Close the connection.  
+`{ :close => true }` - Close the connection.  
 `{ :close => String }` - Close the connection after sending the String.  
 
 

data/VERSION.yml

@@ -1,4 +1,4 @@
 --- 
 :minor: 2
-:patch: 3
+:patch: 6
 :major: 0

data/bin/proxymachine

@@ -32,7 +32,8 @@ EOF
   opts.parse!
 
   load(options[:config])
-  ProxyMachine.run(options[:host], options[:port])
+  name = options[:config].split('/').last.chomp('.rb')
+  ProxyMachine.run(name, options[:host], options[:port])
 rescue Exception => e
   if e.instance_of?(SystemExit)
     raise

data/examples/long.rb

@@ -0,0 +1,9 @@
+# To try out the graceful exit via SIGQUIT, start up a proxymachine with this
+# configuration, and run the following curl command a few times:
+#     curl http://localhost:5432/ubuntu-releases/9.10/ubuntu-9.10-beta-alternate-amd64.iso \
+#     -H "Host: mirrors.cat.pdx.edu" > /dev/null
+# Then send a SIGQUIT to the process and stop the long downloads one by one.
+
+proxy do |data|
+  { :remote => "mirrors.cat.pdx.edu:80" }
+end

data/lib/proxymachine/client_connection.rb

@@ -2,8 +2,10 @@ module EventMachine
   module Protocols
     class ClientConnection < Connection
       def self.start(host, port)
-        EM.start_server(host, port, self)
+        $server = EM.start_server(host, port, self)
         puts "Listening on #{host}:#{port}"
+        puts "Send QUIT to quit after waiting for all connections to finish."
+        puts "Send TERM or INT to quit after waiting for up to 10 seconds for connections to finish."
       end
 
       def post_init

data/lib/proxymachine.rb

@@ -5,20 +5,30 @@ require 'proxymachine/client_connection'
 require 'proxymachine/server_connection'
 
 class ProxyMachine
-  def self.log(str)
-    puts str if false
+  MAX_FAST_SHUTDOWN_SECONDS = 10
+
+  def self.update_procline
+    $0 = "proxymachine - #{@@name} #{@@listen} - #{self.count} connections"
+  end
+
+  def self.count
+    @@counter
   end
 
   def self.incr
-    @@counter ||= 0
     @@counter += 1
-    log @@counter
+    self.update_procline
+    @@counter
   end
 
   def self.decr
-    @@counter ||= 0
     @@counter -= 1
-    log @@counter
+    if $server.nil?
+      puts "Waiting for #{@@counter} connections to finish."
+    end
+    self.update_procline
+    EM.stop if $server.nil? and @@counter == 0
+    @@counter
   end
 
   def self.set_router(block)
@@ -29,11 +39,45 @@ class ProxyMachine
     @@router
   end
 
-  def self.run(host, port)
+  def self.graceful_shutdown(signal)
+    EM.stop_server($server) if $server
+    puts "Received #{signal} signal. No longer accepting new connections."
+    puts "Waiting for #{ProxyMachine.count} connections to finish."
+    $server = nil
+    EM.stop if ProxyMachine.count == 0
+  end
+
+  def self.fast_shutdown(signal)
+    EM.stop_server($server) if $server
+    puts "Received #{signal} signal. No longer accepting new connections."
+    puts "Maximum time to wait for connections is #{MAX_FAST_SHUTDOWN_SECONDS} seconds."
+    puts "Waiting for #{ProxyMachine.count} connections to finish."
+    $server = nil
+    EM.stop if ProxyMachine.count == 0
+    Thread.new do
+      sleep MAX_FAST_SHUTDOWN_SECONDS
+      exit!
+    end
+  end
+
+  def self.run(name, host, port)
+    @@counter = 0
+    @@name = name
+    @@listen = "#{host}:#{port}"
+    self.update_procline
     EM.epoll
 
     EM.run do
       EventMachine::Protocols::ClientConnection.start(host, port)
+      trap('QUIT') do
+        self.graceful_shutdown('QUIT')
+      end
+      trap('TERM') do
+        self.fast_shutdown('TERM')
+      end
+      trap('INT') do
+        self.fast_shutdown('INT')
+      end
     end
   end
 end

data/proxymachine.gemspec

@@ -2,11 +2,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{proxymachine}
-  s.version = "0.2.3"
+  s.version = "0.2.6"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Tom Preston-Werner"]
-  s.date = %q{2009-08-18}
+  s.date = %q{2009-10-01}
   s.default_executable = %q{proxymachine}
   s.email = %q{tom@mojombo.com}
   s.executables = ["proxymachine"]
@@ -23,6 +23,7 @@ Gem::Specification.new do |s|
      "VERSION.yml",
      "bin/proxymachine",
      "examples/git.rb",
+     "examples/long.rb",
      "examples/transparent.rb",
      "lib/proxymachine.rb",
      "lib/proxymachine/client_connection.rb",
@@ -40,6 +41,7 @@ Gem::Specification.new do |s|
     "test/proxymachine_test.rb",
      "test/test_helper.rb",
      "examples/git.rb",
+     "examples/long.rb",
      "examples/transparent.rb"
   ]
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: proxymachine
 version: !ruby/object:Gem::Version 
-  version: 0.2.3
+  version: 0.2.6
 platform: ruby
 authors: 
 - Tom Preston-Werner
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-08-18 00:00:00 -07:00
+date: 2009-10-01 00:00:00 -07:00
 default_executable: proxymachine
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -40,6 +40,7 @@ files:
 - VERSION.yml
 - bin/proxymachine
 - examples/git.rb
+- examples/long.rb
 - examples/transparent.rb
 - lib/proxymachine.rb
 - lib/proxymachine/client_connection.rb
@@ -79,4 +80,5 @@ test_files:
 - test/proxymachine_test.rb
 - test/test_helper.rb
 - examples/git.rb
+- examples/long.rb
 - examples/transparent.rb