Changeset 617

Timestamp:

12/13/07 19:48:35 (1 year ago)

Author:

blackhedd

Message:

additional documentation

Files:

• version_0/lib/em/processes.rb (modified) (1 diff)
• version_0/tests/test_processes.rb (modified) (1 diff)

version_0/lib/em/processes.rb

@@ -26 +26 @@
-
-module EventMachine
+
+        # EM::DeferrableChildProcess is a sugaring of a common use-case
+        # involving EM::popen.
+        # Call the #open method on EM::DeferrableChildProcess, passing
+        # a command-string. #open immediately returns an EM::Deferrable
+        # object. It also schedules the forking of a child process, which
+        # will execute the command passed to #open.
+        # When the forked child terminates, the Deferrable will be signalled
+        # and execute its callbacks, passing the data that the child process
+        # wrote to stdout.
+        #
-        class DeferrableChildProcess < EventMachine::Connection
-                include EventMachine::Deferrable
-
+                # Sugars a common use-case involving forked child processes.
+                # #open takes a String argument containing an shell command
+                # string (including arguments if desired). #open immediately
+                # returns an EventMachine::Deferrable object, without blocking.
+                #
+                # It also invokes EventMachine#popen to run the passed-in
+                # command in a forked child process.
+                #
+                # When the forked child terminates, the Deferrable that
+                # #open calls its callbacks, passing the data returned
+                # from the child process.
+                #
-                def self.open cmd
-                        EventMachine.popen( cmd, DeferrableChildProcess )

version_0/tests/test_processes.rb

@@ -30 +30 @@
-class TestProcesses < Test::Unit::TestCase
-
+        # EM::DeferrableChildProcess is a sugaring of a common use-case
+        # involving EM::popen.
+        # Call the #open method on EM::DeferrableChildProcess, passing
+        # a command-string. #open immediately returns an EM::Deferrable
+        # object. It also schedules the forking of a child process, which
+        # will execute the command passed to #open.
+        # When the forked child terminates, the Deferrable will be signalled
+        # and execute its callbacks, passing the data that the child process
+        # wrote to stdout.
+        #
-        def test_deferrable_child_process
-                ls = ""
-                EM.run {
-
+ -ltr
-                        d.callback {|data_from_child|
-                                ls = data_from_child