eventmachine-maglev- 0.12.10 → 1.0.0.beta.4

metadata

@@ -1,16 +1,50 @@
 --- !ruby/object:Gem::Specification
 name: eventmachine-maglev-
 version: !ruby/object:Gem::Version
-  version: 0.12.10
-  prerelease: 
+  version: 1.0.0.beta.4
+  prerelease: 6
 platform: ruby
 authors:
 - Francis Cianfrocca
+- Aman Gupta
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2009-10-24 00:00:00.000000000 Z
-dependencies: []
+date: 2012-07-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake-compiler
+  requirement: &69825862374080 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - =
+      - !ruby/object:Gem::Version
+        version: 0.7.6
+  type: :development
+  prerelease: false
+  version_requirements: *69825862374080
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: &69825862373380 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.7.2
+  type: :development
+  prerelease: false
+  version_requirements: *69825862373380
+- !ruby/object:Gem::Dependency
+  name: bluecloth
+  requirement: &69825862372800 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *69825862372800
 description: ! 'EventMachine implements a fast, single-threaded engine for arbitrary
   network
 
@@ -30,66 +64,85 @@ description: ! 'EventMachine implements a fast, single-threaded engine for arbit
 
   of EventMachine is to enable programs to easily interface with other programs
 
-  using TCP/IP, especially if custom protocols are required.
-
-'
-email: garbagecat10@gmail.com
+  using TCP/IP, especially if custom protocols are required.'
+email:
+- garbagecat10@gmail.com
+- aman@tmm1.net
 executables: []
 extensions:
 - ext/extconf.rb
 - ext/fastfilereader/extconf.rb
-extra_rdoc_files: []
+extra_rdoc_files:
+- README.md
+- docs/DocumentationGuidesIndex.md
+- docs/GettingStarted.md
+- docs/old/ChangeLog
+- docs/old/DEFERRABLES
+- docs/old/EPOLL
+- docs/old/INSTALL
+- docs/old/KEYBOARD
+- docs/old/LEGAL
+- docs/old/LIGHTWEIGHT_CONCURRENCY
+- docs/old/PURE_RUBY
+- docs/old/RELEASE_NOTES
+- docs/old/SMTP
+- docs/old/SPAWNED_PROCESSES
+- docs/old/TODO
 files:
 - .gitignore
-- README
+- .yardopts
+- GNU
+- Gemfile
+- LICENSE
+- README.md
 - Rakefile
-- docs/COPYING
-- docs/ChangeLog
-- docs/DEFERRABLES
-- docs/EPOLL
-- docs/GNU
-- docs/INSTALL
-- docs/KEYBOARD
-- docs/LEGAL
-- docs/LIGHTWEIGHT_CONCURRENCY
-- docs/PURE_RUBY
-- docs/RELEASE_NOTES
-- docs/SMTP
-- docs/SPAWNED_PROCESSES
-- docs/TODO
+- docs/DocumentationGuidesIndex.md
+- docs/GettingStarted.md
+- docs/old/ChangeLog
+- docs/old/DEFERRABLES
+- docs/old/EPOLL
+- docs/old/INSTALL
+- docs/old/KEYBOARD
+- docs/old/LEGAL
+- docs/old/LIGHTWEIGHT_CONCURRENCY
+- docs/old/PURE_RUBY
+- docs/old/RELEASE_NOTES
+- docs/old/SMTP
+- docs/old/SPAWNED_PROCESSES
+- docs/old/TODO
 - eventmachine.gemspec
-- examples/ex_channel.rb
-- examples/ex_queue.rb
-- examples/helper.rb
+- examples/guides/getting_started/01_eventmachine_echo_server.rb
+- examples/guides/getting_started/02_eventmachine_echo_server_that_recognizes_exit_command.rb
+- examples/guides/getting_started/03_simple_chat_server.rb
+- examples/guides/getting_started/04_simple_chat_server_step_one.rb
+- examples/guides/getting_started/05_simple_chat_server_step_two.rb
+- examples/guides/getting_started/06_simple_chat_server_step_three.rb
+- examples/guides/getting_started/07_simple_chat_server_step_four.rb
+- examples/guides/getting_started/08_simple_chat_server_step_five.rb
+- examples/old/ex_channel.rb
+- examples/old/ex_queue.rb
+- examples/old/ex_tick_loop_array.rb
+- examples/old/ex_tick_loop_counter.rb
+- examples/old/helper.rb
 - ext/binder.cpp
 - ext/binder.h
 - ext/cmain.cpp
-- ext/cplusplus.cpp
 - ext/ed.cpp
 - ext/ed.h
 - ext/em.cpp
 - ext/em.h
-- ext/emwin.cpp
-- ext/emwin.h
-- ext/epoll.cpp
-- ext/epoll.h
 - ext/eventmachine.h
-- ext/eventmachine_cpp.h
 - ext/extconf.rb
 - ext/fastfilereader/extconf.rb
 - ext/fastfilereader/mapper.cpp
 - ext/fastfilereader/mapper.h
 - ext/fastfilereader/rubymain.cpp
-- ext/files.cpp
-- ext/files.h
 - ext/kb.cpp
 - ext/page.cpp
 - ext/page.h
 - ext/pipe.cpp
 - ext/project.h
 - ext/rubymain.cpp
-- ext/sigs.cpp
-- ext/sigs.h
 - ext/ssl.cpp
 - ext/ssl.h
 - java/.classpath
@@ -99,26 +152,18 @@ files:
 - java/src/com/rubyeventmachine/EventableChannel.java
 - java/src/com/rubyeventmachine/EventableDatagramChannel.java
 - java/src/com/rubyeventmachine/EventableSocketChannel.java
-- java/src/com/rubyeventmachine/application/Application.java
-- java/src/com/rubyeventmachine/application/Connection.java
-- java/src/com/rubyeventmachine/application/ConnectionFactory.java
-- java/src/com/rubyeventmachine/application/DefaultConnectionFactory.java
-- java/src/com/rubyeventmachine/application/PeriodicTimer.java
-- java/src/com/rubyeventmachine/application/Timer.java
-- java/src/com/rubyeventmachine/tests/ApplicationTest.java
-- java/src/com/rubyeventmachine/tests/ConnectTest.java
-- java/src/com/rubyeventmachine/tests/EMTest.java
-- java/src/com/rubyeventmachine/tests/TestDatagrams.java
-- java/src/com/rubyeventmachine/tests/TestServers.java
-- java/src/com/rubyeventmachine/tests/TestTimers.java
 - lib/em/buftok.rb
 - lib/em/callback.rb
 - lib/em/channel.rb
+- lib/em/completion.rb
 - lib/em/connection.rb
 - lib/em/deferrable.rb
+- lib/em/deferrable/pool.rb
 - lib/em/file_watch.rb
 - lib/em/future.rb
+- lib/em/iterator.rb
 - lib/em/messages.rb
+- lib/em/pool.rb
 - lib/em/process_watch.rb
 - lib/em/processes.rb
 - lib/em/protocols.rb
@@ -126,6 +171,7 @@ files:
 - lib/em/protocols/httpclient.rb
 - lib/em/protocols/httpclient2.rb
 - lib/em/protocols/line_and_text.rb
+- lib/em/protocols/line_protocol.rb
 - lib/em/protocols/linetext2.rb
 - lib/em/protocols/memcache.rb
 - lib/em/protocols/object_protocol.rb
@@ -136,32 +182,32 @@ files:
 - lib/em/protocols/socks4.rb
 - lib/em/protocols/stomp.rb
 - lib/em/protocols/tcptest.rb
+- lib/em/pure_ruby.rb
 - lib/em/queue.rb
+- lib/em/resolver.rb
 - lib/em/spawnable.rb
 - lib/em/streamer.rb
+- lib/em/threaded_resource.rb
+- lib/em/tick_loop.rb
 - lib/em/timers.rb
 - lib/em/version.rb
 - lib/eventmachine.rb
-- lib/evma.rb
-- lib/evma/callback.rb
-- lib/evma/container.rb
-- lib/evma/factory.rb
-- lib/evma/protocol.rb
-- lib/evma/reactor.rb
 - lib/jeventmachine.rb
-- lib/pr_eventmachine.rb
-- setup.rb
 - tasks/cpp.rake_example
+- tasks/package.rake
+- tasks/test.rake
 - tests/client.crt
 - tests/client.key
+- tests/em_test_helper.rb
 - tests/test_attach.rb
 - tests/test_basic.rb
 - tests/test_channel.rb
+- tests/test_completion.rb
 - tests/test_connection_count.rb
 - tests/test_defer.rb
+- tests/test_deferrable.rb
 - tests/test_epoll.rb
 - tests/test_error_handler.rb
-- tests/test_errors.rb
 - tests/test_exc.rb
 - tests/test_file_watch.rb
 - tests/test_futures.rb
@@ -178,25 +224,29 @@ files:
 - tests/test_object_protocol.rb
 - tests/test_pause.rb
 - tests/test_pending_connect_timeout.rb
+- tests/test_pool.rb
 - tests/test_process_watch.rb
 - tests/test_processes.rb
 - tests/test_proxy_connection.rb
 - tests/test_pure.rb
 - tests/test_queue.rb
+- tests/test_resolver.rb
 - tests/test_running.rb
 - tests/test_sasl.rb
 - tests/test_send_file.rb
 - tests/test_servers.rb
+- tests/test_shutdown_hooks.rb
 - tests/test_smtpclient.rb
 - tests/test_smtpserver.rb
 - tests/test_spawn.rb
 - tests/test_ssl_args.rb
 - tests/test_ssl_methods.rb
 - tests/test_ssl_verify.rb
+- tests/test_threaded_resource.rb
+- tests/test_tick_loop.rb
 - tests/test_timers.rb
 - tests/test_ud.rb
-- tests/testem.rb
-- web/whatis
+- tests/test_unbind_reason.rb
 homepage: http://rubyeventmachine.com
 licenses: []
 post_install_message: 
@@ -204,17 +254,10 @@ rdoc_options:
 - --title
 - EventMachine
 - --main
-- README
-- --line-numbers
+- README.md
 - -x
 - lib/em/version
 - -x
-- lib/emva
-- -x
-- lib/evma/
-- -x
-- lib/pr_eventmachine
-- -x
 - lib/jeventmachine
 require_paths:
 - lib
@@ -227,9 +270,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
-  - - ! '>='
+  - - ! '>'
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: eventmachine
 rubygems_version: 1.8.11

data/README

@@ -1,82 +0,0 @@
-= RUBY/EventMachine
-
-Homepage::  http://rubyeventmachine.com
-Rubyforge Page:: http://rubyforge.org/projects/eventmachine
-Google Group:: http://groups.google.com/group/eventmachine
-Mailing List:: http://rubyforge.org/pipermail/eventmachine-talk
-RDoc:: http://eventmachine.rubyforge.org
-IRC:: ##eventmachine on irc.freenode.net
-Copyright:: (C) 2006-07 by Francis Cianfrocca. All Rights Reserved.
-Email:: gmail address: garbagecat10
-
-EventMachine is copyrighted free software made available under the terms
-of either the GPL or Ruby's License. See the file COPYING for full licensing
-information.
-See EventMachine and EventMachine::Connection for documentation and
-usage examples.
-
-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.
-
-A Ruby program uses EventMachine by registering the addresses and ports of
-network servers and clients, and then entering an event-handling loop.
-EventMachine contains glue code in Ruby which will execute callbacks to
-user-supplied code for all significant events occurring in the clients
-and servers. These events include connection acceptance, startup, data-receipt,
-shutdown, and timer events. Arbitrary processing can be performed by user code
-during event callbacks, including sending data to one or more remote network
-peers, startup and shutdown of network connections, and installation of new
-event handlers.
-
-The EventMachine implements a very familiar model for network programming.
-It emphasizes: 1) the maximum possible isolation of user code from network
-objects like sockets; 2) maximum performance and scalability; and 3) extreme
-ease-of-use for user code. It attempts to provide a higher-level interface
-than similar projects which expose a variety of low-level event-handling
-and networking objects to Ruby programs.
-
-The design and implementation of EventMachine grows out of nearly ten years
-of experience writing high-performance, high-scaling network server applications.
-We have taken particular account of the challenges and lessons described as
-the "C10K problem" by Dan Kegel and others.
-
-EventMachine consists of an extension library written in C++ (which can be
-accessed from languages other than Ruby), and a Ruby module which can be dropped
-into user programs. On most platforms, EventMachine uses the
-<tt>select(2)</tt> system call,
-so it will run on a large range of Unix-like systems and on Microsoft
-Windows with good performance and scalability. On Linux 2.6 kernels, EventMachine
-automatically configures itself to use <tt>epoll(4)</tt> instead of
-<tt>select(2),</tt> so scalability on that platform can be significantly
-improved.
-
-Here's a fully-functional echo server written with EventMachine:
-
- require 'eventmachine'
-
- module EchoServer
-   def post_init
-     puts "-- someone connected to the echo server!"
-   end
-
-   def receive_data data
-     send_data ">>>you sent: #{data}"
-     close_connection if data =~ /quit/i
-   end
-
-   def unbind
-     puts "-- someone disconnected from the echo server!"
-   end
- end
-
- EventMachine::run {
-   EventMachine::start_server "127.0.0.1", 8081, EchoServer
- }

data/docs/DEFERRABLES

@@ -1,133 +0,0 @@
-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 deferrables. For more information, see the separate document LIGHTWEIGHT_CONCURRENCY.
-
-=== What are Deferrables?
-
-EventMachine's Deferrable borrows heavily from the "deferred" object in Python's "Twisted" event-handling framework. Here's a minimal example that illustrates Deferrable:
-
- require 'eventmachine'
- 
- class MyClass
-   include EM::Deferrable
- 
-   def print_value x
-     puts "MyClass instance received #{x}"
-   end
- end
- 
- EM.run {
-   df = MyClass.new
-   df.callback {|x|
-     df.print_value(x)
-     EM.stop
-   }
- 
-   EM::Timer.new(2) {
-     df.set_deferred_status :succeeded, 100
-   }
- }
- 
-
-This program will spin for two seconds, print out the string "MyClass instance received 100" and then exit. The Deferrable pattern relies on an unusual metaphor that may be unfamiliar to you, unless you've used Python's Twisted. You may need to read the following material through more than once before you get the idea.
-
-EventMachine::Deferrable is simply a Ruby Module that you can include in your own classes. (There also is a class named EventMachine::DefaultDeferrable for when you want to create one without including it in code of your own.)
-
-An object that includes EventMachine::Deferrable is like any other Ruby object: it can be created whenever you want, returned from your functions, or passed as an argument to other functions.
-
-The Deferrable pattern allows you to specify any number of Ruby code blocks (callbacks or errbacks) that will be executed at some future time when the status of the Deferrable object changes.
-
-How might that be useful? Well, imagine that you're implementing an HTTP server, but you need to make a call to some other server in order to fulfill a client request.
-
-When you receive a request from one of your clients, you can create and return a Deferrable object. Some other section of your program can add a callback to the Deferrable that will cause the client's request to be fulfilled. Simultaneously, you initiate an event-driven or threaded client request to some different server. And then your EM program will continue to process other events and service other client requests.
-
-When your client request to the other server completes some time later, you will call the #set_deferred_status method on the Deferrable object, passing either a success or failure status, and an arbitrary number of parameters (which might include the data you received from the other server).
-
-At that point, the status of the Deferrable object becomes known, and its callback or errback methods are immediately executed. Callbacks and errbacks are code blocks that are attached to Deferrable objects at any time through the methods #callback and #errback.
-
-The deep beauty of this pattern is that it decouples the disposition of one operation (such as a client request to an outboard server) from the subsequent operations that depend on that disposition (which may include responding to a different client or any other operation).
-
-The code which invokes the deferred operation (that will eventually result in a success or failure status together with associated data) is completely separate from the code which depends on that status and data. This achieves one of the primary goals for which threading is typically used in sophisticated applications, with none of the nondeterminacy or debugging difficulties of threads.
-
-As soon as the deferred status of a Deferrable becomes known by way of a call to #set_deferred_status, the Deferrable will IMMEDIATELY execute all of its callbacks or errbacks in the order in which they were added to the Deferrable.
-
-Callbacks and errbacks can be added to a Deferrable object at any time, not just when the object is created. They can even be added after the status of the object has been determined! (In this case, they will be executed immediately when they are added.)
-
-A call to Deferrable#set_deferred_status takes :succeeded or :failed as its first argument. (This determines whether the object will call its callbacks or its errbacks.) #set_deferred_status also takes zero or more additional parameters, that will in turn be passed as parameters to the callbacks or errbacks.
-
-In general, you can only call #set_deferred_status ONCE on a Deferrable object. A call to #set_deferred_status will not return until all of the associated callbacks or errbacks have been called. If you add callbacks or errbacks AFTER making a call to #set_deferred_status, those additional callbacks or errbacks will execute IMMEDIATELY. Any given callback or errback will be executed AT MOST once.
-
-It's possible to call #set_deferred_status AGAIN, during the execution a callback or errback. This makes it possible to change the parameters which will be sent to the callbacks or errbacks farther down the chain, enabling some extremely elegant use-cases. You can transform the data returned from a deferred operation in arbitrary ways as needed by subsequent users, without changing any of the code that generated the original data.
-
-A call to #set_deferred_status will not return until all of the associated callbacks or errbacks have been called. If you add callbacks or errbacks AFTER making a call to #set_deferred_status, those additional callbacks or errbacks will execute IMMEDIATELY.
-
-Let's look at some more sample code. It turns out that many of the internal protocol implementations in the EventMachine package rely on Deferrable. One of these is EM::Protocols::HttpClient.
-
-To make an evented HTTP request, use the module function EM::Protocols::HttpClient#request, which returns a Deferrable object. Here's how:
-
- require 'eventmachine'
- 
- EM.run {
-   df = EM::Protocols::HttpClient.request( :host=>"www.example.com", :request=>"/index.html" )
- 
-   df.callback {|response|
-     puts "Succeeded: #{response[:content]}"
-     EM.stop
-   }
- 
-   df.errback {|response|
-     puts "ERROR: #{response[:status]}"
-     EM.stop
-   }
- }
-
-(See the documentation of EventMachine::Protocols::HttpClient for information on the object returned by #request.)
-
-In this code, we make a call to HttpClient#request, which immediately returns a Deferrable object. In the background, an HTTP client request is being made to www.example.com, although your code will continue to run concurrently.
-
-At some future point, the HTTP client request will complete, and the code in EM::Protocols::HttpClient will process either a valid HTTP response (including returned content), or an error.
-
-At that point, EM::Protocols::HttpClient will call EM::Deferrable#set_deferred_status on the Deferrable object that was returned to your program, as the return value from EM::Protocols::HttpClient.request. You don't have to do anything to make this happen. All you have to do is tell the Deferrable what to do in case of either success, failure, or both.
-
-In our code sample, we set one callback and one errback. The former will be called if the HTTP call succeeds, and the latter if it fails. (For simplicity, we have both of them calling EM#stop to end the program, although real programs would be very unlikely to do this.)
-
-Setting callbacks and errbacks is optional. They are handlers to defined events in the lifecycle of the Deferrable event. It's not an error if you fail to set either a callback, an errback, or both. But of course your program will then fail to receive those notifications.
-
-If through some bug it turns out that #set_deferred_status is never called on a Deferrable object, then that object's callbacks or errbacks will NEVER be called. It's also possible to set a timeout on a Deferrable. If the timeout elapses before any other call to #set_deferred_status, the Deferrable object will behave as is you had called set_deferred_status(:failed) on it.
-
-
-Now let's modify the example to illustrate some additional points:
-
- require 'eventmachine'
- 
- EM.run {
-   df = EM::Protocols::HttpClient.request( :host=>"www.example.com", :request=>"/index.html" )
- 
-   df.callback {|response|
-     df.set_deferred_status :succeeded, response[:content]
-   }
- 
-   df.callback {|string|
-     puts "Succeeded: #{string}"
-     EM.stop
-   }
- 
-   df.errback {|response|
-     puts "ERROR: #{response[:status]}"
-     EM.stop
-   }
- }
-
-
-Just for the sake of illustration, we've now set two callbacks instead of one. If the deferrable operation (the HTTP client-request) succeeds, then both of the callbacks will be executed in order.
-
-But notice that we've also made our own call to #set_deferred_status in the first callback. This isn't required, because the HttpClient implementation already made a call to #set_deferred_status. (Otherwise, of course, the callback would not be executing.)
-
-But we used #set_deferred_status in the first callback in order to change the parameters that will be sent to subsequent callbacks in the chain. In this way, you can construct powerful sequences of layered functionality. If you want, you can even change the status of the Deferrable from :succeeded to :failed, which would abort the chain of callback calls, and invoke the chain of errbacks instead.
-
-Now of course it's somewhat trivial to define two callbacks in the same method, even with the parameter-changing effect we just described. It would be much more interesting to pass the Deferrable to some other function (for example, a function defined in another module or a different gem), that would in turn add callbacks and/or errbacks of its own. That would illustrate the true power of the Deferrable pattern: to isolate the HTTP client-request from other functions that use the data that it returns without caring where those data came from.
-
-Remember that you can add a callback or an errback to a Deferrable at any point in time, regardless of whether the status of the deferred operation is known (more precisely, regardless of when #set_deferred_status is called on the object). Even hours or days later.
-
-When you add a callback or errback to a Deferrable object on which #set_deferred_status has not yet been called, the callback/errback is queued up for future execution, inside the Deferrable object. When you add a callback or errback to a Deferrable on which #set_deferred_status has already been called, the callback/errback will be executed immediately. Your code doesn't have to worry about the ordering, and there are no timing issues, as there would be with a threaded approach.
-
-For more information on Deferrables and their typical usage patterns, look in the EM unit tests. There are also quite a few sugarings (including EM::Deferrable#future) that make typical Deferrable usages syntactically easier to work with.
-

data/docs/LIGHTWEIGHT_CONCURRENCY

@@ -1,70 +0,0 @@
-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.
-
-
-=== What is Lightweight Concurrency?
-
-We use the term "Lightweight Concurrency" (LC) to refer to concurrency mechanisms that are lighter than Ruby threads. By "lighter," we mean: less resource-intensive in one or more dimensions, usually including memory and CPU usage. In general, you turn to LC in the hope of improving the performance and scalability of your programs.
-
-In addition to the two EventMachine mechanisms we will discuss here, Ruby has at least one other LC construct: Fibers, which are currently under development in Ruby 1.9.
-
-The technical feature that makes all of these LC mechanisms different from standard Ruby threads is that they are not scheduled automatically.
-
-When you create and run Ruby threads, you can assume (within certain constraints) that your threads will all be scheduled fairly by Ruby's runtime. Ruby itself is responsible for giving each of your threads its own share of the total runtime.
-
-But with LC, your program is responsible for causing different execution paths to run. In effect, your program has to act as a "thread scheduler." Scheduled entities in LC run to completion and are never preempted. The runtime system has far less work to do since it has no need to interrupt threads or to schedule them fairly. This is what makes LC lighter and faster.
-
-You'll learn exactly how LC scheduling works in practice as we work through specific examples.
-
-
-=== EventMachine Lightweight Concurrency
-
-Recall that EM provides a reactor loop that must be running in order for your programs to perform event-driven logic. An EM program typically has a structure like this:
-
- require 'eventmachine'
-
- # your initializations
-
- EM.run {
-     # perform event-driven I/O here, including network clients,
-     # servers, timers, and thread-pool operations.
- }
-
- # your cleanup
- # end of the program
-
-
-EventMachine#run executes the reactor loop, which causes your code to be called as events of interest to your program occur. The block you pass to EventMachine#run is executed right after the reactor loop starts, and is the right place to start socket acceptors, etc.
-
-Because the reactor loop runs constantly in an EM program (until it is stopped by a call to EventMachine#stop), it has the ability to schedule blocks of code for asynchronous execution. Unlike a pre-emptive thread scheduler, it's NOT able to interrupt code blocks while they execute. But the scheduling capability it does have is enough to enable lightweight concurrency.
-
-
-For information on Spawned Processes, see the separate document SPAWNED_PROCESSES.
-
-For information on Deferrables, see the separate document DEFERRABLES.
-
-
-=== [SIDEBAR]: I Heard That EventMachine Doesn't Work With Ruby Threads.
-
-This is incorrect. EM is fully interoperable with all versions of Ruby threads, and has been since its earliest releases.
-
-It's very true that EM encourages an "evented" (non-threaded) programming style. The specific benefits of event-driven programming are far better performance and scalabiity for well-written programs, and far easier debugging.
-
-The benefit of using threads for similar applications is a possibly more intuitive programming model, as well as the fact that threads are already familiar to most programmers. Also, bugs in threaded programs often fail to show up until programs go into production. These factors create the illusion that threaded programs are easier to write.
-
-However, some operations that occur frequently in professional-caliber applications simply can't be done without threads. (The classic example is making calls to database client-libraries that block on network I/O until they complete.)
-
-EventMachine not only allows the use of Ruby threads in these cases, but it even provides a built-in thread-pool object to make them easier to work with.
-
-You may have heard a persistent criticism that evented I/O is fundamentally incompatible with Ruby threads. It is true that some well-publicized attempts to incorporate event-handling libraries into Ruby were not successful. But EventMachine was designed from the ground up with Ruby compatibility in mind, so EM never suffered from the problems that defeated the earlier attempts.
-
-
-=== [SIDEBAR]: I Heard That EventMachine Doesn't Work Very Well On Windows.
-
-This too is incorrect. EventMachine is an extension written in C++ and Java, and therefore it requires compilation. Many Windows computers (and some Unix computers, especially in production environments) don't have a build stack. Attempting to install EventMachine on a machine without a compiler usually produces a confusing error.
-
-In addition, Ruby has a much-debated issue with Windows compiler versions. Ruby on Windows works best with Visual Studio 6, a compiler version that is long out-of-print, no longer supported by Microsoft, and difficult to obtain. (This problem is not specific to EventMachine.)
-
-Shortly after EventMachine was first released, the compiler issues led to criticism that EM was incompatible with Windows. Since that time, every EventMachine release has been supplied in a precompiled binary form for Windows users, that does not require you to compile the code yourself. EM binary Gems for Windows are compiled using Visual Studio 6.
-
-EventMachine does supply some advanced features (such as Linux EPOLL support, reduced-privilege operation, UNIX-domain sockets, etc.) that have no meaningful implementation on Windows. Apart from these special cases, all EM functionality (including lightweight concurrency) works perfectly well on Windows.
-

data/docs/SMTP

@@ -1,2 +0,0 @@
-This note details the usage of EventMachine's built-in support for SMTP. EM supports both client and server connections, which will be described in separate sections.
-