eventmachine 1.0.0.beta.3-java → 1.0.0.beta.4-java

data/lib/em/completion.rb

@@ -0,0 +1,304 @@
+# = EM::Completion
+#
+# A completion is a callback container for various states of completion. In
+# it's most basic form it has a start state and a finish state.
+#
+# This implementation includes some hold-back from the EM::Deferrable
+# interface in order to be compatible - but it has a much cleaner
+# implementation.
+#
+# In general it is preferred that this implementation be used as a state
+# callback container than EM::DefaultDeferrable or other classes including
+# EM::Deferrable. This is because it is generally more sane to keep this level
+# of state in a dedicated state-back container. This generally leads to more
+# malleable interfaces and software designs, as well as eradicating nasty bugs
+# that result from abstraction leakage.
+#
+# == Basic Usage
+#
+# As already mentioned, the basic usage of a Completion is simply for its two
+# final states, :succeeded and :failed.
+#
+# An asynchronous operation will complete at some future point in time, and
+# users often want to react to this event. API authors will want to expose
+# some common interface to react to these events.
+#
+# In the following example, the user wants to know when a short lived
+# connection has completed its exchange with the remote server. The simple
+# protocol just waits for an ack to its message.
+#
+#    class Protocol < EM::Connection
+#      include EM::P::LineText2
+#
+#      def initialize(message, completion)
+#        @message, @completion = message, completion
+#        @completion.completion { close_connection }
+#        @completion.timeout(1, :timeout)
+#      end
+#
+#      def post_init
+#        send_data(@message)
+#      end
+#
+#      def receive_line(line)
+#        case line
+#        when /ACK/i
+#          @completion.succeed line
+#        when /ERR/i
+#          @completion.fail :error, line
+#        else
+#          @completion.fail :unknown, line
+#        end
+#      end
+#  
+#      def unbind
+#        @completion.fail :disconnected unless @completion.completed?
+#      end
+#    end
+#
+#    class API
+#      attr_reader :host, :port
+#
+#      def initialize(host = 'example.org', port = 8000)
+#        @host, @port = host, port
+#      end
+#
+#      def request(message)
+#        completion = EM::Deferrable::Completion.new
+#        EM.connect(host, port, Protocol, message, completion)
+#        completion
+#      end
+#    end
+#
+#    api = API.new
+#    completion = api.request('stuff')
+#    completion.callback do |line|
+#      puts "API responded with: #{line}"
+#    end
+#    completion.errback do |type, line|
+#      case type
+#      when :error
+#        puts "API error: #{line}"
+#      when :unknown
+#        puts "API returned unknown response: #{line}"
+#      when :disconnected
+#        puts "API server disconnected prematurely"
+#      when :timeout
+#        puts "API server did not respond in a timely fashion"
+#      end
+#    end
+#
+# == Advanced Usage
+#
+# This completion implementation also supports more state callbacks and
+# arbitrary states (unlike the original Deferrable API). This allows for basic
+# stateful process encapsulation. One might use this to setup state callbacks
+# for various states in an exchange like in the basic usage example, except
+# where the applicaiton could be made to react to "connected" and
+# "disconnected" states additionally.
+#
+#    class Protocol < EM::Connection
+#      def initialize(completion)
+#        @response = []
+#        @completion = completion
+#        @completion.stateback(:disconnected) do
+#          @completion.succeed @response.join
+#        end
+#      end
+#
+#      def connection_completed
+#        @host, @port = Socket.unpack_sockaddr_in get_peername
+#        @completion.change_state(:connected, @host, @port)
+#        send_data("GET http://example.org/ HTTP/1.0\r\n\r\n")
+#      end
+#
+#      def receive_data(data)
+#        @response << data
+#      end
+#
+#      def unbind
+#        @completion.change_state(:disconnected, @host, @port)
+#      end
+#    end
+#
+#    completion = EM::Deferrable::Completion.new
+#    completion.stateback(:connected) do |host, port|
+#      puts "Connected to #{host}:#{port}"
+#    end
+#    completion.stateback(:disconnected) do |host, port|
+#      puts "Disconnected from #{host}:#{port}"
+#    end
+#    completion.callback do |response|
+#      puts response
+#    end
+#
+#    EM.connect('example.org', 80, Protocol, completion)
+#
+# == Timeout
+#
+# The Completion also has a timeout. The timeout is global and is not aware of
+# states apart from completion states. The timeout is only engaged if #timeout
+# is called, and it will call fail if it is reached.
+#
+# == Completion states
+#
+# By default there are two completion states, :succeeded and :failed. These
+# states can be modified by subclassing and overrding the #completion_states
+# method. Completion states are special, in that callbacks for all completion
+# states are explcitly cleared when a completion state is entered. This
+# prevents errors that could arise from accidental unterminated timeouts, and
+# other such user errors.
+#
+# == Other notes
+#
+# Several APIs have been carried over from EM::Deferrable for compatibility
+# reasons during a transitionary period. Specifically cancel_errback and
+# cancel_callback are implemented, but their usage is to be strongly
+# discouraged. Due to the already complex nature of reaction systems, dynamic
+# callback deletion only makes the problem much worse. It is always better to
+# add correct conditionals to the callback code, or use more states, than to
+# address such implementaiton issues with conditional callbacks.
+
+module EventMachine
+
+  class Completion
+    # This is totally not used (re-implemented), it's here in case people check
+    # for kind_of?
+    include EventMachine::Deferrable
+
+    attr_reader :state, :value
+
+    def initialize
+      @state = :unknown
+      @callbacks = Hash.new { |h,k| h[k] = [] }
+      @value = []
+      @timeout_timer = nil
+    end
+
+    # Enter the :succeeded state, setting the result value if given.
+    def succeed(*args)
+      change_state(:succeeded, *args)
+    end
+    # The old EM method:
+    alias set_deferred_success succeed
+
+    # Enter the :failed state, setting the result value if given.
+    def fail(*args)
+      change_state(:failed, *args)
+    end
+    # The old EM method:
+    alias set_deferred_failure fail
+
+    # Statebacks are called when you enter (or are in) the named state.
+    def stateback(state, *a, &b)
+      # The following is quite unfortunate special casing for :completed
+      # statebacks, but it's a necessary evil for latent completion
+      # definitions.
+
+      if :completed == state || !completed? || @state == state
+        @callbacks[state] << EM::Callback(*a, &b)
+      end
+      execute_callbacks
+      self
+    end
+
+    # Callbacks are called when you enter (or are in) a :succeeded state.
+    def callback(*a, &b)
+      stateback(:succeeded, *a, &b)
+    end
+
+    # Errbacks are called when you enter (or are in) a :failed state.
+    def errback(*a, &b)
+      stateback(:failed, *a, &b)
+    end
+
+    # Completions are called when you enter (or are in) either a :failed or a
+    # :succeeded state. They are stored as a special (reserved) state called
+    # :completed.
+    def completion(*a, &b)
+      stateback(:completed, *a, &b)
+    end
+
+    # Enter a new state, setting the result value if given. If the state is one
+    # of :succeeded or :failed, then :completed callbacks will also be called.
+    def change_state(state, *args)
+      @value = args
+      @state = state
+
+      EM.schedule { execute_callbacks }
+    end
+
+    # The old EM method:
+    alias set_deferred_status change_state
+
+    # Indicates that we've reached some kind of completion state, by default
+    # this is :succeeded or :failed. Due to these semantics, the :completed
+    # state is reserved for internal use.
+    def completed?
+      completion_states.any? { |s| state == s }
+    end
+
+    # Completion states simply returns a list of completion states, by default
+    # this is :succeeded and :failed.
+    def completion_states
+      [:succeeded, :failed]
+    end
+
+    # Schedule a time which if passes before we enter a completion state, this
+    # deferrable will be failed with the given arguments.
+    def timeout(time, *args)
+      cancel_timeout
+      @timeout_timer = EM::Timer.new(time) do
+        fail(*args) unless completed?
+      end
+    end
+
+    # Disable the timeout
+    def cancel_timeout
+      if @timeout_timer
+        @timeout_timer.cancel
+        @timeout_timer = nil
+      end
+    end
+
+    # Remove an errback. N.B. Some errbacks cannot be deleted. Usage is NOT
+    # recommended, this is an anti-pattern.
+    def cancel_errback(*a, &b)
+      @callbacks[:failed].delete(EM::Callback(*a, &b))
+    end
+
+    # Remove a callback. N.B. Some callbacks cannot be deleted. Usage is NOT
+    # recommended, this is an anti-pattern.
+    def cancel_callback(*a, &b)
+      @callbacks[:succeeded].delete(EM::Callback(*a, &b))
+    end
+
+    private
+    # Execute all callbacks for the current state. If in a completed state, then
+    # call any statebacks associated with the completed state.
+    def execute_callbacks
+      execute_state_callbacks(state)
+      if completed?
+        execute_state_callbacks(:completed)
+        clear_dead_callbacks
+        cancel_timeout
+      end
+    end
+
+    # Iterate all callbacks for a given state, and remove then call them.
+    def execute_state_callbacks(state)
+      while callback = @callbacks[state].shift
+        callback.call(*value)
+      end
+    end
+
+    # If we enter a completion state, clear other completion states after all
+    # callback chains are completed. This means that operation specific
+    # callbacks can't be dual-called, which is most common user error.
+    def clear_dead_callbacks
+      completion_states.each do |state|
+        @callbacks[state].clear
+      end
+    end
+  end
+end

data/lib/em/connection.rb

@@ -1,5 +1,5 @@
 module EventMachine
-  class FileNotFoundException < Exception # :nodoc:
+  class FileNotFoundException < Exception
   end
 
   # EventMachine::Connection is a class that is instantiated
@@ -8,7 +8,7 @@ module EventMachine
   # to a remote server or accepted locally from a remote client.)
   # When a Connection object is instantiated, it <i>mixes in</i>
   # the functionality contained in the user-defined module
-  # specified in calls to EventMachine#connect or EventMachine#start_server.
+  # specified in calls to {EventMachine.connect} or {EventMachine.start_server}.
   # User-defined handler modules may redefine any or all of the standard
   # methods defined here, as well as add arbitrary additional code
   # that will also be mixed in.
@@ -22,17 +22,30 @@ module EventMachine
   #
   # This class is never instantiated by user code, and does not publish an
   # initialize method. The instance methods of EventMachine::Connection
-  # which may be called by the event loop are: post_init, receive_data,
-  # and unbind. All of the other instance methods defined here are called
-  # only by user code.
+  # which may be called by the event loop are:
   #
+  # * {#post_init}
+  # * {#connection_completed}
+  # * {#receive_data}
+  # * {#unbind}
+  # * {#ssl_verify_peer} (if TLS is used)
+  # * {#ssl_handshake_completed}
+  #
+  # All of the other instance methods defined here are called  only by user code.
+  #
+  # @see file:docs/GettingStarted.md EventMachine tutorial
   class Connection
-    attr_accessor :signature # :nodoc:
+    # @private
+    attr_accessor :signature
+
+    # @private
+    alias original_method method
 
     # Override .new so subclasses don't have to call super and can ignore
     # connection-specific arguments
     #
-    def self.new(sig, *args) #:nodoc:
+    # @private
+    def self.new(sig, *args)
       allocate.instance_eval do
         # Store signature
         @signature = sig
@@ -50,28 +63,26 @@ module EventMachine
 
     # Stubbed initialize so legacy superclasses can safely call super
     #
-    def initialize(*args) #:nodoc:
+    # @private
+    def initialize(*args)
     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,
+    # Called by the event loop immediately after the network connection has been established,
     # and before resumption of the network loop.
     # This method is generally not called by user code, but is called automatically
     # by the event loop. The base-class implementation is a no-op.
     # This is a very good place to initialize instance variables that will
     # be used throughout the lifetime of the network connection.
     #
+    # @see #connection_completed
+    # @see #unbind
+    # @see #send_data
+    # @see #receive_data
     def post_init
     end
 
-    # EventMachine::Connection#receive_data is called by the event loop
-    # whenever data has been received by the network connection.
-    # It is never called by user code.
-    # receive_data is called with a single parameter, a String containing
+    # Called by the event loop whenever data has been received by the network connection.
+    # It is never called by user code. {#receive_data} is called with a single parameter, a String containing
     # the network protocol data, which may of course be binary. You will
     # generally redefine this method to perform your own processing of the incoming data.
     #
@@ -89,52 +100,126 @@ module EventMachine
     # in your redefined implementation of receive_data. For a better understanding
     # of this, read through the examples of specific protocol handlers in EventMachine::Protocols
     #
-    # The base-class implementation of receive_data (which will be invoked if
-    # you don't redefine it) simply prints the size of each incoming data packet
-    # to stdout.
+    # The base-class implementation (which will be invoked only if you didn't override it in your protocol handler)
+    # simply prints incoming data packet size to stdout.
+    #
+    # @param [String] data Opaque incoming data.
+    # @note Depending on the protocol, buffer sizes and OS networking stack configuration, incoming data may or may not be "a complete message".
+    #       It is up to this handler to detect content boundaries to determine whether all the content (for example, full HTTP request)
+    #       has been received and can be processed.
     #
+    # @see #post_init
+    # @see #connection_completed
+    # @see #unbind
+    # @see #send_data
+    # @see file:docs/GettingStarted.md EventMachine tutorial
     def receive_data data
       puts "............>>>#{data.length}"
     end
 
-    # #ssl_handshake_completed is called by EventMachine when the SSL/TLS handshake has
+    # Called by EventMachine when the SSL/TLS handshake has
     # been completed, as a result of calling #start_tls to initiate SSL/TLS on the connection.
     #
-    # This callback exists because #post_init and #connection_completed are <b>not</b> reliable
-    # for indicating when an SSL/TLS connection is ready to have it's certificate queried for.
+    # This callback exists because {#post_init} and {#connection_completed} are **not** reliable
+    # for indicating when an SSL/TLS connection is ready to have its certificate queried for.
     #
-    # See #get_peer_cert for application and example.
+    # @see #get_peer_cert
     def ssl_handshake_completed
     end
 
-    # #ssl_verify_peer is called by EventMachine when :verify_peer => true has been passed to #start_tls.
+    # Called by EventMachine when :verify_peer => true has been passed to {#start_tls}.
     # It will be called with each certificate in the certificate chain provided by the remote peer.
-    # The cert will be passed as a String in PEM format, the same as in #get_peer_cert. It is up to user defined
+    #
+    # The cert will be passed as a String in PEM format, the same as in {#get_peer_cert}. It is up to user defined
     # code to perform a check on the certificates. The return value from this callback is used to accept or deny the peer.
     # A return value that is not nil or false triggers acceptance. If the peer is not accepted, the connection
-    # will be subsequently closed. See 'tests/test_ssl_verify.rb' for a simple example.
+    # will be subsequently closed.
+    #
+    # @example This server always accepts all peers
+    #
+    #   module AcceptServer
+    #     def post_init
+    #       start_tls(:verify_peer => true)
+    #     end
+    #
+    #     def ssl_verify_peer(cert)
+    #       true
+    #     end
+    #
+    #     def ssl_handshake_completed
+    #       $server_handshake_completed = true
+    #     end
+    #   end
+    #
+    #
+    # @example This server never accepts any peers
+    #
+    #   module DenyServer
+    #     def post_init
+    #       start_tls(:verify_peer => true)
+    #     end
+    #
+    #     def ssl_verify_peer(cert)
+    #       # Do not accept the peer. This should now cause the connection to shut down
+    #       # without the SSL handshake being completed.
+    #       false
+    #     end
+    #
+    #     def ssl_handshake_completed
+    #       $server_handshake_completed = true
+    #     end
+    #   end
+    #
+    # @see #start_tls
     def ssl_verify_peer(cert)
     end
 
-    # EventMachine::Connection#unbind is called by the framework whenever a connection
-    # (either a server or client connection) is closed. The close can occur because
-    # your code intentionally closes it (see close_connection and close_connection_after_writing),
+    # called by the framework whenever a connection (either a server or client connection) is closed.
+    # The close can occur because your code intentionally closes it (using {#close_connection} and {#close_connection_after_writing}),
     # because the remote peer closed the connection, or because of a network error.
     # You may not assume that the network connection is still open and able to send or
     # receive data when the callback to unbind is made. This is intended only to give
     # you a chance to clean up associations your code may have made to the connection
     # object while it was open.
     #
+    # If you want to detect which peer has closed the connection, you can override {#close_connection} in your protocol handler
+    # and set an @ivar.
+    #
+    # @example Overriding Connection#close_connection to distinguish connections closed on our side
+    #
+    #   class MyProtocolHandler < EventMachine::Connection
+    #
+    #     # ...
+    #
+    #     def close_connection(*args)
+    #       @intentionally_closed_connection = true
+    #       super(*args)
+    #     end
+    #
+    #     def unbind
+    #       if @intentionally_closed_connection
+    #         # ...
+    #       end
+    #     end
+    #
+    #     # ...
+    #
+    #   end
+    #
+    # @see #post_init
+    # @see #connection_completed
+    # @see file:docs/GettingStarted.md EventMachine tutorial
     def unbind
     end
 
-    # EventMachine::Connection#proxy_target_unbound is called by the reactor after attempting
-    # to relay incoming data to a descriptor (set as a proxy target descriptor with
-    # EventMachine::enable_proxy) that has already been closed.
+    # Called by the reactor after attempting to relay incoming data to a descriptor (set as a proxy target descriptor with
+    # {EventMachine.enable_proxy}) that has already been closed.
+    #
+    # @see EventMachine.enable_proxy
     def proxy_target_unbound
     end
 
-    # EventMachine::Connection#proxy_completed is called when the reactor finished proxying all
+    # called when the reactor finished proxying all
     # of the requested bytes.
     def proxy_completed
     end
@@ -142,12 +227,13 @@ module EventMachine
     # EventMachine::Connection#proxy_incoming_to is called only by user code. It sets up
     # 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.
+    #
+    # @see EventMachine.enable_proxy
     def proxy_incoming_to(conn,bufsize=0)
       EventMachine::enable_proxy(self, conn, bufsize)
     end
 
-    # Helper method for EventMachine::disable_proxy(self)
+    # A helper method for {EventMachine.disable_proxy}
     def stop_proxying
       EventMachine::disable_proxy(self)
     end
@@ -165,17 +251,17 @@ module EventMachine
     # However, it's not guaranteed that a future version of EventMachine will not change
     # this behavior.
     #
-    # close_connection will <i>silently discard</i> any outbound data which you have
-    # sent to the connection using EventMachine::Connection#send_data but which has not
+    # {#close_connection} will *silently discard* any outbound data which you have
+    # sent to the connection using {EventMachine::Connection#send_data} but which has not
     # yet been sent across the network. If you want to avoid this behavior, use
-    # EventMachine::Connection#close_connection_after_writing.
+    # {EventMachine::Connection#close_connection_after_writing}.
     #
     def close_connection after_writing = false
       EventMachine::close_connection @signature, after_writing
     end
 
-    # EventMachine::Connection#detach will remove the given connection from the event loop.
-    # The connection's socket remains open and its file descriptor number is returned
+    # Removes given connection from the event loop.
+    # The connection's socket remains open and its file descriptor number is returned.
     def detach
       EventMachine::detach_fd @signature
     end
@@ -184,42 +270,51 @@ module EventMachine
       EventMachine::get_sock_opt @signature, level, option
     end
 
-    # EventMachine::Connection#close_connection_after_writing is a variant of close_connection.
+    def set_sock_opt level, optname, optval
+      EventMachine::set_sock_opt @signature, level, optname, optval
+    end
+
+    # 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
+    # close_connection_after_writing, *with one exception*: if the connection has
     # outbound data sent using send_dat but which has not yet been sent across the network,
-    # close_connection_after_writing will schedule the connection to be closed <i>after</i>
+    # close_connection_after_writing will schedule the connection to be closed *after*
     # all of the outbound data has been safely written to the remote peer.
     #
     # Depending on the amount of outgoing data and the speed of the network,
     # considerable time may elapse between your call to close_connection_after_writing
     # and the actual closing of the socket (at which time the unbind callback will be called
-    # by the event loop). During this time, you <i>may not</i> call send_data to transmit
+    # by the event loop). During this time, you *may not* call send_data to transmit
     # additional data (that is, the connection is closed for further writes). In very
-    # rare cases, you may experience a receive_data callback after your call to close_connection_after_writing,
+    # rare cases, you may experience a receive_data callback after your call to {#close_connection_after_writing},
     # depending on whether incoming data was in the process of being received on the connection
-    # at the moment when you called close_connection_after_writing. Your protocol handler must
+    # at the moment when you called {#close_connection_after_writing}. Your protocol handler must
     # be prepared to properly deal with such data (probably by ignoring it).
     #
+    # @see #close_connection
+    # @see #send_data
     def close_connection_after_writing
       close_connection true
     end
 
-    # EventMachine::Connection#send_data is only called by user code, never by
-    # the event loop. You call this method to send data to the remote end of the
-    # network connection. send_data is called with a single String argument, which
-    # may of course contain binary data. You can call send_data any number of times.
-    # send_data is an instance method of an object derived from EventMachine::Connection
-    # and containing your mixed-in handler code), so if you call it without qualification
-    # within a callback function, the data will be sent to the same network connection
-    # that generated the callback. Calling self.send_data is exactly equivalent.
+    # Call this method to send data to the remote end of the network connection. It takes a single String argument,
+    # which may contain binary data. Data is buffered to be sent at the end of this event loop tick (cycle).
+    #
+    # When used in a method that is event handler (for example, {#post_init} or {#connection_completed}, it will send
+    # data to the other end of the connection that generated the event.
+    # You can also call {#send_data} to write to other connections. For more information see The Chat Server Example in the
+    # {file:docs/GettingStarted.md EventMachine tutorial}.
+    #
+    # If you want to send some data and then immediately close the connection, make sure to use {#close_connection_after_writing}
+    # instead of {#close_connection}.
     #
-    # You can also call send_data to write to a connection <i>other than the one
-    # whose callback you are calling send_data from.</i> This is done by recording
-    # the value of the connection in any callback function (the value self), in any
-    # variable visible to other callback invocations on the same or different
-    # connection objects. (Need an example to make that clear.)
     #
+    # @param [String] data Data to send asynchronously
+    #
+    # @see file:docs/GettingStarted.md EventMachine tutorial
+    # @see Connection#receive_data
+    # @see Connection#post_init
+    # @see Connection#unbind
     def send_data data
       data = data.to_s
       size = data.bytesize if data.respond_to?(:bytesize)
@@ -228,56 +323,58 @@ module EventMachine
     end
 
     # Returns true if the connection is in an error state, false otherwise.
-    # In general, you can detect the occurrence of communication errors or unexpected
-    # disconnection by the remote peer by handing the #unbind method. In some cases, however,
-    # it's useful to check the status of the connection using #error? before attempting to send data.
-    # This function is synchronous: it will return immediately without blocking.
     #
+    # In general, you can detect the occurrence of communication errors or unexpected
+    # disconnection by the remote peer by handing the {#unbind} method. In some cases, however,
+    # it's useful to check the status of the connection using {#error?} before attempting to send data.
+    # This function is synchronous but it will return immediately without blocking.
     #
+    # @return [Boolean] true if the connection is in an error state, false otherwise
     def error?
-      EventMachine::report_connection_error_status(@signature) != 0
+      errno = EventMachine::report_connection_error_status(@signature)
+      case errno
+      when 0
+        false
+      when -1
+        true
+      else
+        EventMachine::ERRNOS[errno]
+      end
     end
 
-    # #connection_completed is called by the event loop when a remote TCP connection
-    # attempt completes successfully. You can expect to get this notification after calls
-    # to EventMachine#connect. Remember that EventMachine makes remote connections
-    # asynchronously, just as with any other kind of network event. #connection_completed
+    # Called by the event loop when a remote TCP connection attempt completes successfully.
+    # You can expect to get this notification after calls to {EventMachine.connect}. Remember that EventMachine makes remote connections
+    # asynchronously, just as with any other kind of network event. This method
     # is intended primarily to assist with network diagnostics. For normal protocol
-    # handling, use #post_init to perform initial work on a new connection (such as
-    # send an initial set of data).
-    # #post_init will always be called. #connection_completed will only be called in case
-    # of a successful completion. A connection-attempt which fails will receive a call
-    # to #unbind after the failure.
+    # handling, use #post_init to perform initial work on a new connection (such as sending initial set of data).
+    # {Connection#post_init} will always be called. This method will only be called in case of a successful completion.
+    # A connection attempt which fails will result a call to {Connection#unbind} after the failure.
+    #
+    # @see Connection#post_init
+    # @see Connection#unbind
+    # @see file:docs/GettingStarted.md EventMachine tutorial
     def connection_completed
     end
 
-    # Call #start_tls at any point to initiate TLS encryption on connected streams.
+    # Call {#start_tls} at any point to initiate TLS encryption on connected streams.
     # The method is smart enough to know whether it should perform a server-side
-    # or a client-side handshake. An appropriate place to call #start_tls is in
-    # your redefined #post_init method, or in the #connection_completed handler for
+    # or a client-side handshake. An appropriate place to call {#start_tls} is in
+    # your redefined {#post_init} method, or in the {#connection_completed} handler for
     # an outbound connection.
     #
-    # #start_tls takes an optional parameter hash that allows you to specify certificate
-    # and other options to be used with this Connection object. Here are the currently-supported
-    # options:
     #
-    # * :cert_chain_file :
-    # takes a String, which is interpreted as the name of a readable file in the
-    # local filesystem. The file is expected to contain a chain of X509 certificates in
-    # PEM format, with the most-resolved certificate at the top of the file, successive
-    # intermediate certs in the middle, and the root (or CA) cert at the bottom.
+    # @option args [String] :cert_chain_file (nil) local path of a readable file that contants  a chain of X509 certificates in
+    #                                              the [PEM format](http://en.wikipedia.org/wiki/Privacy_Enhanced_Mail),
+    #                                              with the most-resolved certificate at the top of the file, successive intermediate
+    #                                              certs in the middle, and the root (or CA) cert at the bottom.
     #
-    # * :private_key_file :
-    # takes a String, which is interpreted as the name of a readable file in the
-    # local filesystem. The file must contain a private key in PEM format.
+    # @option args [String] :private_key_file (nil) local path of a readable file that must contain a private key in the [PEM format](http://en.wikipedia.org/wiki/Privacy_Enhanced_Mail).
     #
-    # * :verify_peer :
-    # takes either true or false. Default is false. This indicates whether a server should request a
-    # certificate from a peer, to be verified by user code. If true, the #ssl_verify_peer callback
-    # on the Connection object is called with each certificate in the certificate chain provided by
-    # the peer. See documentation on #ssl_verify_peer for how to use this.
+    # @option args [String] :verify_peer (false)    indicates whether a server should request a certificate from a peer, to be verified by user code.
+    #                                               If true, the {#ssl_verify_peer} callback on the {EventMachine::Connection} object is called with each certificate
+    #                                               in the certificate chain provided by the peer. See documentation on {#ssl_verify_peer} for how to use this.
     #
-    # === Usage example:
+    # @example Using TLS with EventMachine
     #
     #  require 'rubygems'
     #  require 'eventmachine'
@@ -288,101 +385,106 @@ module EventMachine
     #    end
     #  end
     #
-    #  EM.run {
-    #    EM.start_server("127.0.0.1", 9999, Handler)
-    #  }
+    #   EventMachine.run do
+    #    EventMachine.start_server("127.0.0.1", 9999, Handler)
+    #  end
+    #
+    # @param [Hash] args
     #
-    #--
-    # TODO: support passing an encryption parameter, which can be string or Proc, to get a passphrase
+    # @todo support passing an encryption parameter, which can be string or Proc, to get a passphrase
     # for encrypted private keys.
-    # TODO: support passing key material via raw strings or Procs that return strings instead of
+    # @todo support passing key material via raw strings or Procs that return strings instead of
     # just filenames.
-    # What will get nasty is whether we have to define a location for storing this stuff as files.
-    # In general, the OpenSSL interfaces for dealing with certs and keys in files are much better
-    # behaved than the ones for raw chunks of memory.
     #
+    # @see #ssl_verify_peer
     def start_tls args={}
       priv_key, cert_chain, verify_peer = args.values_at(:private_key_file, :cert_chain_file, :verify_peer)
 
       [priv_key, cert_chain].each do |file|
         next if file.nil? or file.empty?
         raise FileNotFoundException,
-          "Could not find #{file} for start_tls" unless File.exists? file
+        "Could not find #{file} for start_tls" unless File.exists? file
       end
 
       EventMachine::set_tls_parms(@signature, priv_key || '', cert_chain || '', verify_peer)
       EventMachine::start_tls @signature
     end
 
-    # If SSL/TLS is active on the connection, #get_peer_cert returns the remote X509 certificate
-    # as a String, in the popular PEM format. This can then be used for arbitrary validation
+    # If [TLS](http://en.wikipedia.org/wiki/Transport_Layer_Security) is active on the connection, returns the remote [X509 certificate](http://en.wikipedia.org/wiki/X.509)
+    # as a string, in the popular [PEM format](http://en.wikipedia.org/wiki/Privacy_Enhanced_Mail). This can then be used for arbitrary validation
     # of a peer's certificate in your code.
     #
-    # This should be called in/after the #ssl_handshake_completed callback, which indicates
+    # This should be called in/after the {#ssl_handshake_completed} callback, which indicates
     # that SSL/TLS is active. Using this callback is important, because the certificate may not
     # be available until the time it is executed. Using #post_init or #connection_completed is
     # not adequate, because the SSL handshake may still be taking place.
     #
-    # #get_peer_cert will return <b>nil</b> if:
+    # This method will return `nil` if:
     #
-    # * EventMachine is not built with OpenSSL support
-    # * SSL/TLS is not active on the connection
-    # * SSL/TLS handshake is not yet complete
+    # * EventMachine is not built with [OpenSSL](http://www.openssl.org) support
+    # * [TLS](http://en.wikipedia.org/wiki/Transport_Layer_Security) is not active on the connection
+    # * TLS handshake is not yet complete
     # * Remote peer for any other reason has not presented a certificate
     #
-    # === Example:
     #
-    #  module Handler
+    # @example Getting peer TLS certificate information in EventMachine
     #
-    #   def post_init
-    #     puts "Starting TLS"
-    #     start_tls
-    #   end
+    #  module Handler
+    #    def post_init
+    #      puts "Starting TLS"
+    #      start_tls
+    #    end
     #
-    #   def ssl_handshake_completed
-    #     puts get_peer_cert
-    #     close_connection
-    #   end
+    #    def ssl_handshake_completed
+    #      puts get_peer_cert
+    #      close_connection
+    #    end
     #
-    #   def unbind
-    #     EventMachine::stop_event_loop
-    #   end
+    #    def unbind
+    #      EventMachine::stop_event_loop
+    #    end
+    #  end
     #
+    #   EventMachine.run do
+    #     EventMachine.connect "mail.google.com", 443, Handler
     #  end
     #
-    #  EM.run {
-    #   EventMachine::connect "mail.google.com", 443, Handler
-    #  }
-    #
-    # Output:
-    #  -----BEGIN CERTIFICATE-----
-    #  MIIDIjCCAougAwIBAgIQbldpChBPqv+BdPg4iwgN8TANBgkqhkiG9w0BAQUFADBM
-    #  MQswCQYDVQQGEwJaQTElMCMGA1UEChMcVGhhd3RlIENvbnN1bHRpbmcgKFB0eSkg
-    #  THRkLjEWMBQGA1UEAxMNVGhhd3RlIFNHQyBDQTAeFw0wODA1MDIxNjMyNTRaFw0w
-    #  OTA1MDIxNjMyNTRaMGkxCzAJBgNVBAYTAlVTMRMwEQYDVQQIEwpDYWxpZm9ybmlh
-    #  MRYwFAYDVQQHEw1Nb3VudGFpbiBWaWV3MRMwEQYDVQQKEwpHb29nbGUgSW5jMRgw
-    #  FgYDVQQDEw9tYWlsLmdvb2dsZS5jb20wgZ8wDQYJKoZIhvcNAQEBBQADgY0AMIGJ
-    #  AoGBALlkxdh2QXegdElukCSOV2+8PKiONIS+8Tu9K7MQsYpqtLNC860zwOPQ2NLI
-    #  3Zp4jwuXVTrtzGuiqf5Jioh35Ig3CqDXtLyZoypjZUQcq4mlLzHlhIQ4EhSjDmA7
-    #  Ffw9y3ckSOQgdBQWNLbquHh9AbEUjmhkrYxIqKXeCnRKhv6nAgMBAAGjgecwgeQw
-    #  KAYDVR0lBCEwHwYIKwYBBQUHAwEGCCsGAQUFBwMCBglghkgBhvhCBAEwNgYDVR0f
-    #  BC8wLTAroCmgJ4YlaHR0cDovL2NybC50aGF3dGUuY29tL1RoYXd0ZVNHQ0NBLmNy
-    #  bDByBggrBgEFBQcBAQRmMGQwIgYIKwYBBQUHMAGGFmh0dHA6Ly9vY3NwLnRoYXd0
-    #  ZS5jb20wPgYIKwYBBQUHMAKGMmh0dHA6Ly93d3cudGhhd3RlLmNvbS9yZXBvc2l0
-    #  b3J5L1RoYXd0ZV9TR0NfQ0EuY3J0MAwGA1UdEwEB/wQCMAAwDQYJKoZIhvcNAQEF
-    #  BQADgYEAsRwpLg1dgCR1gYDK185MFGukXMeQFUvhGqF8eT/CjpdvezyKVuz84gSu
-    #  6ccMXgcPQZGQN/F4Xug+Q01eccJjRSVfdvR5qwpqCj+6BFl5oiKDBsveSkrmL5dz
-    #  s2bn7TdTSYKcLeBkjXxDLHGBqLJ6TNCJ3c4/cbbG5JhGvoema94=
-    #  -----END CERTIFICATE-----
+    #  # Will output:
+    #  # -----BEGIN CERTIFICATE-----
+    #  # MIIDIjCCAougAwIBAgIQbldpChBPqv+BdPg4iwgN8TANBgkqhkiG9w0BAQUFADBM
+    #  # MQswCQYDVQQGEwJaQTElMCMGA1UEChMcVGhhd3RlIENvbnN1bHRpbmcgKFB0eSkg
+    #  # THRkLjEWMBQGA1UEAxMNVGhhd3RlIFNHQyBDQTAeFw0wODA1MDIxNjMyNTRaFw0w
+    #  # OTA1MDIxNjMyNTRaMGkxCzAJBgNVBAYTAlVTMRMwEQYDVQQIEwpDYWxpZm9ybmlh
+    #  # MRYwFAYDVQQHEw1Nb3VudGFpbiBWaWV3MRMwEQYDVQQKEwpHb29nbGUgSW5jMRgw
+    #  # FgYDVQQDEw9tYWlsLmdvb2dsZS5jb20wgZ8wDQYJKoZIhvcNAQEBBQADgY0AMIGJ
+    #  # AoGBALlkxdh2QXegdElukCSOV2+8PKiONIS+8Tu9K7MQsYpqtLNC860zwOPQ2NLI
+    #  # 3Zp4jwuXVTrtzGuiqf5Jioh35Ig3CqDXtLyZoypjZUQcq4mlLzHlhIQ4EhSjDmA7
+    #  # Ffw9y3ckSOQgdBQWNLbquHh9AbEUjmhkrYxIqKXeCnRKhv6nAgMBAAGjgecwgeQw
+    #  # KAYDVR0lBCEwHwYIKwYBBQUHAwEGCCsGAQUFBwMCBglghkgBhvhCBAEwNgYDVR0f
+    #  # BC8wLTAroCmgJ4YlaHR0cDovL2NybC50aGF3dGUuY29tL1RoYXd0ZVNHQ0NBLmNy
+    #  # bDByBggrBgEFBQcBAQRmMGQwIgYIKwYBBQUHMAGGFmh0dHA6Ly9vY3NwLnRoYXd0
+    #  # ZS5jb20wPgYIKwYBBQUHMAKGMmh0dHA6Ly93d3cudGhhd3RlLmNvbS9yZXBvc2l0
+    #  # b3J5L1RoYXd0ZV9TR0NfQ0EuY3J0MAwGA1UdEwEB/wQCMAAwDQYJKoZIhvcNAQEF
+    #  # BQADgYEAsRwpLg1dgCR1gYDK185MFGukXMeQFUvhGqF8eT/CjpdvezyKVuz84gSu
+    #  # 6ccMXgcPQZGQN/F4Xug+Q01eccJjRSVfdvR5qwpqCj+6BFl5oiKDBsveSkrmL5dz
+    #  # s2bn7TdTSYKcLeBkjXxDLHGBqLJ6TNCJ3c4/cbbG5JhGvoema94=
+    #  # -----END CERTIFICATE-----
     #
     # You can do whatever you want with the certificate String, such as load it
-    # as a certificate object using the OpenSSL library, and check it's fields.
+    # as a certificate object using the OpenSSL library, and check its fields.
+    #
+    # @return [String] the remote [X509 certificate](http://en.wikipedia.org/wiki/X.509), in the popular [PEM format](http://en.wikipedia.org/wiki/Privacy_Enhanced_Mail),
+    #                  if TLS is active on the connection
+    #
+    # @see Connection#start_tls
+    # @see Connection#ssl_handshake_completed
     def get_peer_cert
       EventMachine::get_peer_cert @signature
     end
 
 
-    # send_datagram is for sending UDP messages.
+    # Sends UDP messages.
+    #
     # This method may be called from any Connection object that refers
     # to an open datagram socket (see EventMachine#open_datagram_socket).
     # The method sends a UDP (datagram) packet containing the data you specify,
@@ -399,10 +501,10 @@ module EventMachine
     # but to be really safe, send messages smaller than the Ethernet-packet
     # size (typically about 1400 bytes). Some very restrictive WANs
     # will either drop or truncate packets larger than about 500 bytes.
-    #--
-    # Added the Integer wrapper around the port parameter per suggestion by
-    # Matthieu Riou, after he passed a String and spent hours tearing his hair out.
     #
+    # @param [String] data              Data to send asynchronously
+    # @param [String] recipient_address IP address of the recipient
+    # @param [String] recipient_port    Port of the recipient
     def send_datagram data, recipient_address, recipient_port
       data = data.to_s
       size = data.bytesize if data.respond_to?(:bytesize)
@@ -411,13 +513,16 @@ module EventMachine
     end
 
 
-    # #get_peername is used with stream-connections to obtain the identity
+    # This method is used with stream-connections to obtain the identity
     # of the remotely-connected peer. If a peername is available, this method
     # returns a sockaddr structure. The method returns nil if no peername is available.
     # You can use Socket.unpack_sockaddr_in and its variants to obtain the
     # values contained in the peername structure returned from #get_peername.
     #
+    # @example How to get peer IP address and port with EventMachine
+    #
     #  require 'socket'
+    #
     #  module Handler
     #    def receive_data data
     #      port, ip = Socket.unpack_sockaddr_in(get_peername)
@@ -428,27 +533,39 @@ module EventMachine
       EventMachine::get_peername @signature
     end
 
-    # #get_sockname is used with stream-connections to obtain the identity
+    # Used with stream-connections to obtain the identity
     # of the local side of the connection. If a local name is available, this method
     # returns a sockaddr structure. The method returns nil if no local name is available.
-    # You can use Socket#unpack_sockaddr_in and its variants to obtain the
-    # values contained in the local-name structure returned from #get_sockname.
+    # You can use {Socket.unpack_sockaddr_in} and its variants to obtain the
+    # values contained in the local-name structure returned from this method.
+    #
+    # @example
+    #
+    #  require 'socket'
+    #
+    #  module Handler
+    #    def receive_data data
+    #      port, ip = Socket.unpack_sockaddr_in(get_sockname)
+    #      puts "got #{data.inspect}"
+    #    end
+    #  end
     def get_sockname
       EventMachine::get_sockname @signature
     end
 
     # Returns the PID (kernel process identifier) of a subprocess
-    # associated with this Connection object. For use with EventMachine#popen
+    # associated with this Connection object. For use with {EventMachine.popen}
     # and similar methods. Returns nil when there is no meaningful subprocess.
-    #--
     #
+    # @return [Integer]
     def get_pid
       EventMachine::get_subprocess_pid @signature
     end
 
-    # Returns a subprocess exit status. Only useful for #popen. Call it in your
-    # #unbind handler.
+    # Returns a subprocess exit status. Only useful for {EventMachine.popen}. Call it in your
+    # {#unbind} handler.
     #
+    # @return [Integer]
     def get_status
       EventMachine::get_subprocess_status @signature
     end
@@ -462,88 +579,97 @@ module EventMachine
       EventMachine::get_comm_inactivity_timeout @signature
     end
 
-    # Alias for #set_comm_inactivity_timeout.
-    def comm_inactivity_timeout= value
-      self.set_comm_inactivity_timeout value
-    end
-
-    # comm_inactivity_timeout= allows you to set the inactivity-timeout property for
+    # Allows you to set the inactivity-timeout property for
     # a network connection or datagram socket. Specify a non-negative float value in seconds.
     # If the value is greater than zero, the connection or socket will automatically be closed
     # if no read or write activity takes place for at least that number of seconds.
     # Specify a value of zero to indicate that no automatic timeout should take place.
     # Zero is the default value.
-    def set_comm_inactivity_timeout value
+    def comm_inactivity_timeout= value
       EventMachine::set_comm_inactivity_timeout @signature, value.to_f
     end
+    alias set_comm_inactivity_timeout comm_inactivity_timeout=
 
-    # 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
+      # The duration after which a TCP connection in the connecting state will fail.
+      # It is important to distinguish this value from {EventMachine::Connection#comm_inactivity_timeout},
+      # which looks at how long since data was passed on an already established connection.
+      # The value is a float in seconds.
+      #
+      # @return [Float] The duration after which a TCP connection in the connecting state will fail, in seconds.
+      def pending_connect_timeout
+        EventMachine::get_pending_connect_timeout @signature
+      end
 
-    # Alias for #set_pending_connect_timeout.
+    # Sets the duration after which a TCP connection in a
+    # connecting state will fail.
+    #
+    # @param [Float, #to_f] value Connection timeout in seconds
     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
+    alias set_pending_connect_timeout pending_connect_timeout=
 
-    # Reconnect to a given host/port with the current EventMachine::Connection instance
-    def reconnect server, port
-      EventMachine::reconnect server, port, self
-    end
+      # Reconnect to a given host/port with the current instance
+      #
+      # @param [String] server Hostname or IP address
+      # @param [Integer] port  Port to reconnect to
+      def reconnect server, port
+        EventMachine::reconnect server, port, self
+      end
 
 
-    # Like EventMachine::Connection#send_data, this sends data to the remote end of
-    # the network connection.  EventMachine::Connection@send_file_data takes a
+    # Like {EventMachine::Connection#send_data}, this sends data to the remote end of
+    # the network connection. {EventMachine::Connection#send_file_data} takes a
     # filename as an argument, though, and sends the contents of the file, in one
-    # chunk. Contributed by Kirk Haines.
+    # chunk.
+    #
+    # @param [String] filename Local path of the file to send
     #
+    # @see #send_data
+    # @author Kirk Haines
     def send_file_data filename
       EventMachine::send_file_data @signature, filename
     end
 
     # Open a file on the filesystem and send it to the remote peer. This returns an
-    # object of type EventMachine::Deferrable. The object's callbacks will be executed
+    # object of type {EventMachine::Deferrable}. The object's callbacks will be executed
     # on the reactor main thread when the file has been completely scheduled for
-    # transmission to the remote peer. Its errbacks will be called in case of an error
-    # (such as file-not-found). #stream_file_data employs various strategems to achieve
-    # the fastest possible performance, balanced against minimum consumption of memory.
-    #
-    # You can control the behavior of #stream_file_data with the optional arguments parameter.
-    # Currently-supported arguments are:
-    # :http_chunks, a boolean flag which defaults false. If true, this flag streams the
-    # file data in a format compatible with the HTTP chunked-transfer encoding.
+    # transmission to the remote peer. Its errbacks will be called in case of an error (such as file-not-found).
+    # This method employs various strategies to achieve the fastest possible performance,
+    # balanced against minimum consumption of memory.
     #
     # Warning: this feature has an implicit dependency on an outboard extension,
-    # evma_fastfilereader. You must install this extension in order to use #stream_file_data
+    # evma_fastfilereader. You must install this extension in order to use {#stream_file_data}
     # with files larger than a certain size (currently 8192 bytes).
     #
+    # @option args [Boolean] :http_chunks (false) If true, this method will stream the file data in a format
+    #                                             compatible with the HTTP chunked-transfer encoding
+    #
+    # @param [String] filename Local path of the file to stream
+    # @param [Hash] args Options
+    #
+    # @return [EventMachine::Deferrable]
     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.
+    # Watches connection for readability. Only possible if the connection was created
+    # using {EventMachine.attach} and had {EventMachine.notify_readable}/{EventMachine.notify_writable} defined on the handler.
+    #
+    # @see #notify_readable?
     def notify_readable= mode
       EventMachine::set_notify_readable @signature, mode
     end
 
-    # Returns true if the connection is being watched for readability.
+    # @return [Boolean] 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.
+    # Watches connection for writeability. Only possible if the connection was created
+    # using {EventMachine.attach} and had {EventMachine.notify_readable}/{EventMachine.notify_writable} defined on the handler.
+    #
+    # @see #notify_writable?
     def notify_writable= mode
       EventMachine::set_notify_writable @signature, mode
     end
@@ -553,19 +679,23 @@ module EventMachine
       EventMachine::is_notify_writable @signature
     end
 
-    # Pause a connection so that #send_data and #receive_data events are not fired until #resume is called.
+    # Pause a connection so that {#send_data} and {#receive_data} events are not fired until {#resume} is called.
+    # @see #resume
     def pause
       EventMachine::pause_connection @signature
     end
 
-    # Resume a connection's #send_data and #receive_data events.
+    # Resume a connection's {#send_data} and {#receive_data} events.
+    # @see #pause
     def resume
       EventMachine::resume_connection @signature
     end
 
-    # True if the connect was paused using #pause.
+    # @return [Boolean] true if the connect was paused using {EventMachine::Connection#pause}.
+    # @see #pause
+    # @see #resume
     def paused?
       EventMachine::connection_paused? @signature
     end
   end
-end
+end