eventmachine 0.12.8-x86-mswin32-60 → 0.12.10-x86-mswin32-60

data/java/src/com/rubyeventmachine/tests/TestTimers.java

@@ -1,89 +1,90 @@
-/**
- * $Id$
- * 
- * Author:: Francis Cianfrocca (gmail: blackhedd)
- * Homepage::  http://rubyeventmachine.com
- * Date:: 15 Jul 2007
- * 
- * See EventMachine and EventMachine::Connection for documentation and
- * usage examples.
- * 
- *
- *----------------------------------------------------------------------------
- *
- * Copyright (C) 2006-07 by Francis Cianfrocca. All Rights Reserved.
- * Gmail: blackhedd
- * 
- * This program is free software; you can redistribute it and/or modify
- * it under the terms of either: 1) the GNU General Public License
- * as published by the Free Software Foundation; either version 2 of the
- * License, or (at your option) any later version; or 2) Ruby's License.
- * 
- * See the file COPYING for complete licensing information.
- *
- *---------------------------------------------------------------------------
- *
- * 
- */
-
-
-package com.rubyeventmachine.tests;
-
-import com.rubyeventmachine.*;
-import java.io.*;
-
-import org.junit.Assert;
-import org.junit.After;
-import org.junit.AfterClass;
-import org.junit.Before;
-import org.junit.BeforeClass;
-import org.junit.Test;
-
-
-public class TestTimers {
-
-	@BeforeClass
-	public static void setUpBeforeClass() throws Exception {
-	}
-
-	@AfterClass
-	public static void tearDownAfterClass() throws Exception {
-	}
-
-	@Before
-	public void setUp() throws Exception {
-	}
-
-	@After
-	public void tearDown() throws Exception {
-	}
-
-
-	
-	@Test
-	public final void test2() throws IOException {
-		Application a = new Application();
-		a.addTimer(0, new Timer() {
-			public void fire() {
-				application.stop();
-			}
-		});
-		a.run();
-		Assert.assertEquals (1, 1); // just to make sure the reactor halts.
-	}
-	
-	@Test
-	public final void test3() throws IOException {
-		Application a = new Application();
-		a.addTimer (0.1, new PeriodicTimer() {
-			int n = 0;
-			public void fire() {
-				n++;
-				if (n == 5)
-					application.stop();
-			}
-		});
-		a.run();
-		Assert.assertEquals(1, 1);
-	}
-}
+/**
+ * $Id$
+ * 
+ * Author:: Francis Cianfrocca (gmail: blackhedd)
+ * Homepage::  http://rubyeventmachine.com
+ * Date:: 15 Jul 2007
+ * 
+ * See EventMachine and EventMachine::Connection for documentation and
+ * usage examples.
+ * 
+ *
+ *----------------------------------------------------------------------------
+ *
+ * Copyright (C) 2006-07 by Francis Cianfrocca. All Rights Reserved.
+ * Gmail: blackhedd
+ * 
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of either: 1) the GNU General Public License
+ * as published by the Free Software Foundation; either version 2 of the
+ * License, or (at your option) any later version; or 2) Ruby's License.
+ * 
+ * See the file COPYING for complete licensing information.
+ *
+ *---------------------------------------------------------------------------
+ *
+ * 
+ */
+
+
+package com.rubyeventmachine.tests;
+
+import com.rubyeventmachine.*;
+import com.rubyeventmachine.application.*;
+import java.io.*;
+
+import org.junit.Assert;
+import org.junit.After;
+import org.junit.AfterClass;
+import org.junit.Before;
+import org.junit.BeforeClass;
+import org.junit.Test;
+
+
+public class TestTimers {
+
+	@BeforeClass
+	public static void setUpBeforeClass() throws Exception {
+	}
+
+	@AfterClass
+	public static void tearDownAfterClass() throws Exception {
+	}
+
+	@Before
+	public void setUp() throws Exception {
+	}
+
+	@After
+	public void tearDown() throws Exception {
+	}
+
+
+	
+	@Test
+	public final void test2() throws IOException {
+		Application a = new Application();
+		a.addTimer(0, new Timer() {
+			public void fire() {
+				application.stop();
+			}
+		});
+		a.run();
+		Assert.assertEquals (1, 1); // just to make sure the reactor halts.
+	}
+	
+	@Test
+	public final void test3() throws IOException {
+		Application a = new Application();
+		a.addTimer (0.1, new PeriodicTimer() {
+			int n = 0;
+			public void fire() {
+				n++;
+				if (n == 5)
+					application.stop();
+			}
+		});
+		a.run();
+		Assert.assertEquals(1, 1);
+	}
+}

data/lib/em/connection.rb

@@ -34,12 +34,14 @@ module EventMachine
     #
     def self.new(sig, *args) #:nodoc:
       allocate.instance_eval do
+        # Store signature
+        @signature = sig
+        associate_callback_target sig
+
         # Call a superclass's #initialize if it has one
         initialize(*args)
 
-        # Store signature and run #post_init
-        @signature = sig
-        associate_callback_target sig
+        # post initialize callback
         post_init
 
         self
@@ -51,9 +53,9 @@ module EventMachine
     def initialize(*args) #:nodoc:
     end
 
-    def associate_callback_target(sig) #:nodoc:
-      # no-op for the time being, to match similar no-op in rubymain.cpp
-    end
+    # def associate_callback_target(sig) #:nodoc:
+    #   # no-op for the time being, to match similar no-op in rubymain.cpp
+    # end
 
     # EventMachine::Connection#post_init is called by the event loop
     # immediately after the network connection has been established,
@@ -136,8 +138,8 @@ module EventMachine
     # a low-level proxy relay for all data inbound for this connection, to the connection given
     # as the argument. This is essentially just a helper method for enable_proxy.
     # See EventMachine::enable_proxy documentation for details.
-    def proxy_incoming_to(conn)
-      EventMachine::enable_proxy(self, conn)
+    def proxy_incoming_to(conn,bufsize=0)
+      EventMachine::enable_proxy(self, conn, bufsize)
     end
 
     # Helper method for EventMachine::disable_proxy(self)
@@ -173,6 +175,10 @@ module EventMachine
       EventMachine::detach_fd @signature
     end
 
+    def get_sock_opt level, option
+      EventMachine::get_sock_opt @signature, level, option
+    end
+
     # EventMachine::Connection#close_connection_after_writing is a variant of close_connection.
     # All of the descriptive comments given for close_connection also apply to
     # close_connection_after_writing, <i>with one exception:</i> If the connection has
@@ -451,7 +457,7 @@ module EventMachine
 
     # Alias for #set_comm_inactivity_timeout.
     def comm_inactivity_timeout= value
-      self.send :set_comm_inactivity_timeout, value
+      self.set_comm_inactivity_timeout value
     end
 
     # comm_inactivity_timeout= allows you to set the inactivity-timeout property for
@@ -464,10 +470,26 @@ module EventMachine
       EventMachine::set_comm_inactivity_timeout @signature, value.to_f
     end
 
+    # pending_connect_timeout is the duration after which a TCP connection in the connecting 
+    # state will fail. It is important to distinguish this value from comm_inactivity_timeout,
+    # which looks at how long since data was passed on an already established connection.
+    # The value is a float in seconds.
+    def pending_connect_timeout
+      EventMachine::get_pending_connect_timeout @signature
+    end
+
+    # Alias for #set_pending_connect_timeout.
+    def pending_connect_timeout= value
+      self.set_pending_connect_timeout value
+    end
+
+    # set_pending_connect_timeout sets the duration after which a TCP connection in a
+    # connecting state will fail. Takes a float in seconds.
+    def set_pending_connect_timeout value
+      EventMachine::set_pending_connect_timeout @signature, value.to_f
+    end
+
     # Reconnect to a given host/port with the current EventMachine::Connection instance
-    #--
-    # EXPERIMENTAL. DO NOT RELY ON THIS METHOD TO REMAIN SUPPORTED.
-    # (03Nov06)
     def reconnect server, port
       EventMachine::reconnect server, port, self
     end
@@ -501,5 +523,42 @@ module EventMachine
     def stream_file_data filename, args={}
       EventMachine::FileStreamer.new( self, filename, args )
     end
+
+    # Enable notify_readable callbacks on this connection. Only possible if the connection was created
+    # using EM.attach and had notify_readable/notify_writable defined on the handler.
+    def notify_readable= mode
+      EventMachine::set_notify_readable @signature, mode
+    end
+
+    # Returns true if the connection is being watched for readability.
+    def notify_readable?
+      EventMachine::is_notify_readable @signature
+    end
+
+    # Enable notify_writable callbacks on this connection. Only possible if the connection was created
+    # using EM.attach and had notify_readable/notify_writable defined on the handler.
+    def notify_writable= mode
+      EventMachine::set_notify_writable @signature, mode
+    end
+
+    # Returns true if the connection is being watched for writability.
+    def notify_writable?
+      EventMachine::is_notify_writable @signature
+    end
+
+    # Pause a connection so that #send_data and #receive_data events are not fired until #resume is called.
+    def pause
+      EventMachine::pause_connection @signature
+    end
+
+    # Resume a connection's #send_data and #receive_data events.
+    def resume
+      EventMachine::resume_connection @signature
+    end
+
+    # True if the connect was paused using #pause.
+    def paused?
+      EventMachine::connection_paused? @signature
+    end
   end
 end

data/lib/em/deferrable.rb

@@ -1,187 +1,192 @@
-#--
-#
-# Author:: Francis Cianfrocca (gmail: blackhedd)
-# Homepage::  http://rubyeventmachine.com
-# Date:: 16 Jul 2006
-# 
-# See EventMachine and EventMachine::Connection for documentation and
-# usage examples.
-#
-#----------------------------------------------------------------------------
-#
-# Copyright (C) 2006-07 by Francis Cianfrocca. All Rights Reserved.
-# Gmail: blackhedd
-# 
-# This program is free software; you can redistribute it and/or modify
-# it under the terms of either: 1) the GNU General Public License
-# as published by the Free Software Foundation; either version 2 of the
-# License, or (at your option) any later version; or 2) Ruby's License.
-# 
-# See the file COPYING for complete licensing information.
-#
-#---------------------------------------------------------------------------
-#
-# 
-
-module EventMachine
-  module Deferrable
-
-    # Specify a block to be executed if and when the Deferrable object receives
-    # a status of :succeeded. See #set_deferred_status for more information.
-    #
-    # Calling this method on a Deferrable object whose status is not yet known
-    # will cause the callback block to be stored on an internal list.
-    # If you call this method on a Deferrable whose status is :succeeded, the
-    # block will be executed immediately, receiving the parameters given to the
-    # prior #set_deferred_status call.
-    #
-    #--
-    # If there is no status, add a callback to an internal list.
-    # If status is succeeded, execute the callback immediately.
-    # If status is failed, do nothing.
-    #
-    def callback &block
-      return unless block
-      if @deferred_status == :succeeded
-        block.call(*@deferred_args)
-      elsif @deferred_status != :failed
-        @callbacks ||= []
-        @callbacks.unshift block # << block
-      end
-    end
-
-    # Specify a block to be executed if and when the Deferrable object receives
-    # a status of :failed. See #set_deferred_status for more information.
-    #--
-    # If there is no status, add an errback to an internal list.
-    # If status is failed, execute the errback immediately.
-    # If status is succeeded, do nothing.
-    #
-    def errback &block
-      return unless block
-      if @deferred_status == :failed
-        block.call(*@deferred_args)
-      elsif @deferred_status != :succeeded
-        @errbacks ||= []
-        @errbacks.unshift block # << block
-      end
-    end
-
-    # Sets the "disposition" (status) of the Deferrable object. See also the large set of
-    # sugarings for this method.
-    # Note that if you call this method without arguments,
-    # no arguments will be passed to the callback/errback.
-    # If the user has coded these with arguments, then the
-    # user code will throw an argument exception.
-    # Implementors of deferrable classes <b>must</b>
-    # document the arguments they will supply to user callbacks.
-    #
-    # OBSERVE SOMETHING VERY SPECIAL here: you may call this method even
-    # on the INSIDE of a callback. This is very useful when a previously-registered
-    # callback wants to change the parameters that will be passed to subsequently-registered
-    # ones.
-    #
-    # You may give either :succeeded or :failed as the status argument.
-    #
-    # If you pass :succeeded, then all of the blocks passed to the object using the #callback
-    # method (if any) will be executed BEFORE the #set_deferred_status method returns. All of the blocks
-    # passed to the object using #errback will be discarded.
-    #
-    # If you pass :failed, then all of the blocks passed to the object using the #errback
-    # method (if any) will be executed BEFORE the #set_deferred_status method returns. All of the blocks
-    # passed to the object using # callback will be discarded.
-    #
-    # If you pass any arguments to #set_deferred_status in addition to the status argument,
-    # they will be passed as arguments to any callbacks or errbacks that are executed.
-    # It's your responsibility to ensure that the argument lists specified in your callbacks and
-    # errbacks match the arguments given in calls to #set_deferred_status, otherwise Ruby will raise
-    # an ArgumentError.
-    #
-    #--
-    # We're shifting callbacks off and discarding them as we execute them.
-    # This is valid because by definition callbacks are executed no more than
-    # once. It also has the magic effect of permitting recursive calls, which
-    # means that a callback can call #set_deferred_status and change the parameters
-    # that will be sent to subsequent callbacks down the chain.
-    #
-    # Changed @callbacks and @errbacks from push/shift to unshift/pop, per suggestion
-    # by Kirk Haines, to work around the memory leak bug that still exists in many Ruby
-    # versions.
-    #
-    # Changed 15Sep07: after processing callbacks or errbacks, CLEAR the other set of
-    # handlers. This gets us a little closer to the behavior of Twisted's "deferred,"
-    # which only allows status to be set once. Prior to making this change, it was possible
-    # to "succeed" a Deferrable (triggering its callbacks), and then immediately "fail" it,
-    # triggering its errbacks! That is clearly undesirable, but it's just as undesirable
-    # to raise an exception is status is set more than once on a Deferrable. The latter
-    # behavior would invalidate the idiom of resetting arguments by setting status from
-    # within a callback or errback, but more seriously it would cause spurious errors
-    # if a Deferrable was timed out and then an attempt was made to succeed it. See the
-    # comments under the new method #timeout.
-    #
-    def set_deferred_status status, *args
-      cancel_timeout
-      @deferred_status = status
-      @deferred_args = args
-      case @deferred_status
-      when :succeeded
-        if @callbacks
-          while cb = @callbacks.pop
-            cb.call(*@deferred_args)
-          end
-        end
-        @errbacks.clear if @errbacks
-      when :failed
-        if @errbacks
-          while eb = @errbacks.pop
-            eb.call(*@deferred_args)
-          end
-        end
-        @callbacks.clear if @callbacks
-      end
-    end
-
-
-    # Setting a timeout on a Deferrable causes it to go into the failed state after
-    # the Timeout expires (passing no arguments to the object's errbacks).
-    # Setting the status at any time prior to a call to the expiration of the timeout
-    # will cause the timer to be cancelled.
-    def timeout seconds
-      cancel_timeout
-      me = self
-      @deferred_timeout = EventMachine::Timer.new(seconds) {me.fail}
-    end
-
-    # Cancels an outstanding timeout if any. Undoes the action of #timeout.
-    #
-    def cancel_timeout
-      if @deferred_timeout
-        @deferred_timeout.cancel
-        @deferred_timeout = nil
-      end
-    end
-
-
-    # Sugar for set_deferred_status(:succeeded, ...)
-    #
-    def succeed *args
-      set_deferred_status :succeeded, *args
-    end
-    alias set_deferred_success succeed
-
-    # Sugar for set_deferred_status(:failed, ...)
-    #
-    def fail *args
-      set_deferred_status :failed, *args
-    end
-    alias set_deferred_failure fail
-  end
-
-
-  # DefaultDeferrable is an otherwise empty class that includes Deferrable.
-  # This is very useful when you just need to return a Deferrable object
-  # as a way of communicating deferred status to some other part of a program.
-  class DefaultDeferrable
-    include Deferrable
-  end
+#--
+#
+# Author:: Francis Cianfrocca (gmail: blackhedd)
+# Homepage::  http://rubyeventmachine.com
+# Date:: 16 Jul 2006
+# 
+# See EventMachine and EventMachine::Connection for documentation and
+# usage examples.
+#
+#----------------------------------------------------------------------------
+#
+# Copyright (C) 2006-07 by Francis Cianfrocca. All Rights Reserved.
+# Gmail: blackhedd
+# 
+# This program is free software; you can redistribute it and/or modify
+# it under the terms of either: 1) the GNU General Public License
+# as published by the Free Software Foundation; either version 2 of the
+# License, or (at your option) any later version; or 2) Ruby's License.
+# 
+# See the file COPYING for complete licensing information.
+#
+#---------------------------------------------------------------------------
+#
+# 
+
+module EventMachine
+  module Deferrable
+
+    # Specify a block to be executed if and when the Deferrable object receives
+    # a status of :succeeded. See #set_deferred_status for more information.
+    #
+    # Calling this method on a Deferrable object whose status is not yet known
+    # will cause the callback block to be stored on an internal list.
+    # If you call this method on a Deferrable whose status is :succeeded, the
+    # block will be executed immediately, receiving the parameters given to the
+    # prior #set_deferred_status call.
+    #
+    #--
+    # If there is no status, add a callback to an internal list.
+    # If status is succeeded, execute the callback immediately.
+    # If status is failed, do nothing.
+    #
+    def callback &block
+      return unless block
+      @deferred_status ||= :unknown
+      if @deferred_status == :succeeded
+        block.call(*@deferred_args)
+      elsif @deferred_status != :failed
+        @callbacks ||= []
+        @callbacks.unshift block # << block
+      end
+    end
+
+    # Specify a block to be executed if and when the Deferrable object receives
+    # a status of :failed. See #set_deferred_status for more information.
+    #--
+    # If there is no status, add an errback to an internal list.
+    # If status is failed, execute the errback immediately.
+    # If status is succeeded, do nothing.
+    #
+    def errback &block
+      return unless block
+      @deferred_status ||= :unknown
+      if @deferred_status == :failed
+        block.call(*@deferred_args)
+      elsif @deferred_status != :succeeded
+        @errbacks ||= []
+        @errbacks.unshift block # << block
+      end
+    end
+
+    # Sets the "disposition" (status) of the Deferrable object. See also the large set of
+    # sugarings for this method.
+    # Note that if you call this method without arguments,
+    # no arguments will be passed to the callback/errback.
+    # If the user has coded these with arguments, then the
+    # user code will throw an argument exception.
+    # Implementors of deferrable classes <b>must</b>
+    # document the arguments they will supply to user callbacks.
+    #
+    # OBSERVE SOMETHING VERY SPECIAL here: you may call this method even
+    # on the INSIDE of a callback. This is very useful when a previously-registered
+    # callback wants to change the parameters that will be passed to subsequently-registered
+    # ones.
+    #
+    # You may give either :succeeded or :failed as the status argument.
+    #
+    # If you pass :succeeded, then all of the blocks passed to the object using the #callback
+    # method (if any) will be executed BEFORE the #set_deferred_status method returns. All of the blocks
+    # passed to the object using #errback will be discarded.
+    #
+    # If you pass :failed, then all of the blocks passed to the object using the #errback
+    # method (if any) will be executed BEFORE the #set_deferred_status method returns. All of the blocks
+    # passed to the object using # callback will be discarded.
+    #
+    # If you pass any arguments to #set_deferred_status in addition to the status argument,
+    # they will be passed as arguments to any callbacks or errbacks that are executed.
+    # It's your responsibility to ensure that the argument lists specified in your callbacks and
+    # errbacks match the arguments given in calls to #set_deferred_status, otherwise Ruby will raise
+    # an ArgumentError.
+    #
+    #--
+    # We're shifting callbacks off and discarding them as we execute them.
+    # This is valid because by definition callbacks are executed no more than
+    # once. It also has the magic effect of permitting recursive calls, which
+    # means that a callback can call #set_deferred_status and change the parameters
+    # that will be sent to subsequent callbacks down the chain.
+    #
+    # Changed @callbacks and @errbacks from push/shift to unshift/pop, per suggestion
+    # by Kirk Haines, to work around the memory leak bug that still exists in many Ruby
+    # versions.
+    #
+    # Changed 15Sep07: after processing callbacks or errbacks, CLEAR the other set of
+    # handlers. This gets us a little closer to the behavior of Twisted's "deferred,"
+    # which only allows status to be set once. Prior to making this change, it was possible
+    # to "succeed" a Deferrable (triggering its callbacks), and then immediately "fail" it,
+    # triggering its errbacks! That is clearly undesirable, but it's just as undesirable
+    # to raise an exception is status is set more than once on a Deferrable. The latter
+    # behavior would invalidate the idiom of resetting arguments by setting status from
+    # within a callback or errback, but more seriously it would cause spurious errors
+    # if a Deferrable was timed out and then an attempt was made to succeed it. See the
+    # comments under the new method #timeout.
+    #
+    def set_deferred_status status, *args
+      cancel_timeout
+      @errbacks ||= nil
+      @callbacks ||= nil
+      @deferred_status = status
+      @deferred_args = args
+      case @deferred_status
+      when :succeeded
+        if @callbacks
+          while cb = @callbacks.pop
+            cb.call(*@deferred_args)
+          end
+        end
+        @errbacks.clear if @errbacks
+      when :failed
+        if @errbacks
+          while eb = @errbacks.pop
+            eb.call(*@deferred_args)
+          end
+        end
+        @callbacks.clear if @callbacks
+      end
+    end
+
+
+    # Setting a timeout on a Deferrable causes it to go into the failed state after
+    # the Timeout expires (passing no arguments to the object's errbacks).
+    # Setting the status at any time prior to a call to the expiration of the timeout
+    # will cause the timer to be cancelled.
+    def timeout seconds
+      cancel_timeout
+      me = self
+      @deferred_timeout = EventMachine::Timer.new(seconds) {me.fail}
+    end
+
+    # Cancels an outstanding timeout if any. Undoes the action of #timeout.
+    #
+    def cancel_timeout
+      @deferred_timeout ||= nil
+      if @deferred_timeout
+        @deferred_timeout.cancel
+        @deferred_timeout = nil
+      end
+    end
+
+
+    # Sugar for set_deferred_status(:succeeded, ...)
+    #
+    def succeed *args
+      set_deferred_status :succeeded, *args
+    end
+    alias set_deferred_success succeed
+
+    # Sugar for set_deferred_status(:failed, ...)
+    #
+    def fail *args
+      set_deferred_status :failed, *args
+    end
+    alias set_deferred_failure fail
+  end
+
+
+  # DefaultDeferrable is an otherwise empty class that includes Deferrable.
+  # This is very useful when you just need to return a Deferrable object
+  # as a way of communicating deferred status to some other part of a program.
+  class DefaultDeferrable
+    include Deferrable
+  end
 end