net-ssh 4.2.0 → 7.0.1

data/lib/net/ssh/buffered_io.rb

@@ -1,135 +1,135 @@
 require 'net/ssh/buffer'
 require 'net/ssh/loggable'
-require 'net/ssh/ruby_compat'
-
-module Net; module SSH
-
-  # This module is used to extend sockets and other IO objects, to allow
-  # them to be buffered for both read and write. This abstraction makes it
-  # quite easy to write a select-based event loop
-  # (see Net::SSH::Connection::Session#listen_to).
-  #
-  # The general idea is that instead of calling #read directly on an IO that
-  # has been extended with this module, you call #fill (to add pending input
-  # to the internal read buffer), and then #read_available (to read from that
-  # buffer). Likewise, you don't call #write directly, you call #enqueue to
-  # add data to the write buffer, and then #send_pending or #wait_for_pending_sends
-  # to actually send the data across the wire.
-  #
-  # In this way you can easily use the object as an argument to IO.select,
-  # calling #fill when it is available for read, or #send_pending when it is
-  # available for write, and then call #enqueue and #read_available during
-  # the idle times.
-  #
-  #   socket = TCPSocket.new(address, port)
-  #   socket.extend(Net::SSH::BufferedIo)
-  #
-  #   ssh.listen_to(socket)
-  #
-  #   ssh.loop do
-  #     if socket.available > 0
-  #       puts socket.read_available
-  #       socket.enqueue("response\n")
-  #     end
-  #   end
-  #
-  # Note that this module must be used to extend an instance, and should not
-  # be included in a class. If you do want to use it via an include, then you
-  # must make sure to invoke the private #initialize_buffered_io method in
-  # your class' #initialize method:
-  #
-  #   class Foo < IO
-  #     include Net::SSH::BufferedIo
-  #
-  #     def initialize
-  #       initialize_buffered_io
-  #       # ...
-  #     end
-  #   end
-  module BufferedIo
-    include Loggable
-
-    # Called when the #extend is called on an object, with this module as the
-    # argument. It ensures that the modules instance variables are all properly
-    # initialized.
-    def self.extended(object) #:nodoc:
-      # need to use __send__ because #send is overridden in Socket
-      object.__send__(:initialize_buffered_io)
-    end
 
-    # Tries to read up to +n+ bytes of data from the remote end, and appends
-    # the data to the input buffer. It returns the number of bytes read, or 0
-    # if no data was available to be read.
-    def fill(n=8192)
-      input.consume!
-      data = recv(n)
-      debug { "read #{data.length} bytes" }
-      input.append(data)
-      return data.length
-    rescue EOFError => e
-      @input_errors << e
-      return 0
-    end
+module Net
+  module SSH
+    # This module is used to extend sockets and other IO objects, to allow
+    # them to be buffered for both read and write. This abstraction makes it
+    # quite easy to write a select-based event loop
+    # (see Net::SSH::Connection::Session#listen_to).
+    #
+    # The general idea is that instead of calling #read directly on an IO that
+    # has been extended with this module, you call #fill (to add pending input
+    # to the internal read buffer), and then #read_available (to read from that
+    # buffer). Likewise, you don't call #write directly, you call #enqueue to
+    # add data to the write buffer, and then #send_pending or #wait_for_pending_sends
+    # to actually send the data across the wire.
+    #
+    # In this way you can easily use the object as an argument to IO.select,
+    # calling #fill when it is available for read, or #send_pending when it is
+    # available for write, and then call #enqueue and #read_available during
+    # the idle times.
+    #
+    #   socket = TCPSocket.new(address, port)
+    #   socket.extend(Net::SSH::BufferedIo)
+    #
+    #   ssh.listen_to(socket)
+    #
+    #   ssh.loop do
+    #     if socket.available > 0
+    #       puts socket.read_available
+    #       socket.enqueue("response\n")
+    #     end
+    #   end
+    #
+    # Note that this module must be used to extend an instance, and should not
+    # be included in a class. If you do want to use it via an include, then you
+    # must make sure to invoke the private #initialize_buffered_io method in
+    # your class' #initialize method:
+    #
+    #   class Foo < IO
+    #     include Net::SSH::BufferedIo
+    #
+    #     def initialize
+    #       initialize_buffered_io
+    #       # ...
+    #     end
+    #   end
+    module BufferedIo
+      include Loggable
+
+      # Called when the #extend is called on an object, with this module as the
+      # argument. It ensures that the modules instance variables are all properly
+      # initialized.
+      def self.extended(object) # :nodoc:
+        # need to use __send__ because #send is overridden in Socket
+        object.__send__(:initialize_buffered_io)
+      end
 
-    # Read up to +length+ bytes from the input buffer. If +length+ is nil,
-    # all available data is read from the buffer. (See #available.)
-    def read_available(length=nil)
-      input.read(length || available)
-    end
+      # Tries to read up to +n+ bytes of data from the remote end, and appends
+      # the data to the input buffer. It returns the number of bytes read, or 0
+      # if no data was available to be read.
+      def fill(n = 8192)
+        input.consume!
+        data = recv(n)
+        debug { "read #{data.length} bytes" }
+        input.append(data)
+        return data.length
+      rescue EOFError => e
+        @input_errors << e
+        return 0
+      end
 
-    # Returns the number of bytes available to be read from the input buffer.
-    # (See #read_available.)
-    def available
-      input.available
-    end
+      # Read up to +length+ bytes from the input buffer. If +length+ is nil,
+      # all available data is read from the buffer. (See #available.)
+      def read_available(length = nil)
+        input.read(length || available)
+      end
 
-    # Enqueues data in the output buffer, to be written when #send_pending
-    # is called. Note that the data is _not_ sent immediately by this method!
-    def enqueue(data)
-      output.append(data)
-    end
+      # Returns the number of bytes available to be read from the input buffer.
+      # (See #read_available.)
+      def available
+        input.available
+      end
 
-    # Returns +true+ if there is data waiting in the output buffer, and
-    # +false+ otherwise.
-    def pending_write?
-      output.length > 0
-    end
+      # Enqueues data in the output buffer, to be written when #send_pending
+      # is called. Note that the data is _not_ sent immediately by this method!
+      def enqueue(data)
+        output.append(data)
+      end
 
-    # Sends as much of the pending output as possible. Returns +true+ if any
-    # data was sent, and +false+ otherwise.
-    def send_pending
-      if output.length > 0
-        sent = send(output.to_s, 0)
-        debug { "sent #{sent} bytes" }
-        output.consume!(sent)
-        return sent > 0
-      else
-        return false
+      # Returns +true+ if there is data waiting in the output buffer, and
+      # +false+ otherwise.
+      def pending_write?
+        output.length > 0
       end
-    end
 
-    # Calls #send_pending repeatedly, if necessary, blocking until the output
-    # buffer is empty.
-    def wait_for_pending_sends
-      send_pending
-      while output.length > 0
-        result = Net::SSH::Compat.io_select(nil, [self]) or next
-        next unless result[1].any?
+      # Sends as much of the pending output as possible. Returns +true+ if any
+      # data was sent, and +false+ otherwise.
+      def send_pending
+        if output.length > 0
+          sent = send(output.to_s, 0)
+          debug { "sent #{sent} bytes" }
+          output.consume!(sent)
+          return sent > 0
+        else
+          return false
+        end
+      end
+
+      # Calls #send_pending repeatedly, if necessary, blocking until the output
+      # buffer is empty.
+      def wait_for_pending_sends
         send_pending
+        while output.length > 0
+          result = IO.select(nil, [self]) or next
+          next unless result[1].any?
+
+          send_pending
+        end
       end
-    end
 
-    public # these methods are primarily for use in tests
+      public # these methods are primarily for use in tests
 
-      def write_buffer #:nodoc:
+      def write_buffer # :nodoc:
         output.to_s
       end
 
-      def read_buffer #:nodoc:
+      def read_buffer # :nodoc:
         input.to_s
       end
 
-    private
+      private
 
       #--
       # Can't use attr_reader here (after +private+) without incurring the
@@ -137,6 +137,7 @@ module Net; module SSH
       #++
 
       def input; @input; end
+
       def output; @output; end
 
       # Initializes the intput and output buffers for this object. This method
@@ -150,54 +151,52 @@ module Net; module SSH
         @output = Net::SSH::Buffer.new
         @output_errors = []
       end
-  end
-
-
+    end
 
-  # Fixes for two issues by Miklós Fazekas:
-  #
-  #   * if client closes a forwarded connection, but the server is
-  #     reading, net-ssh terminates with IOError socket closed.
-  #   * if client force closes (RST) a forwarded connection, but
-  #     server is reading, net-ssh terminates with [an exception]
-  #
-  # See:
-  #
-  #    http://net-ssh.lighthouseapp.com/projects/36253/tickets/7
-  #    http://github.com/net-ssh/net-ssh/tree/portfwfix
-  #
-  module ForwardedBufferedIo
-    def fill(n=8192)
-      begin
-        super(n)
-      rescue Errno::ECONNRESET => e
-        debug { "connection was reset => shallowing exception:#{e}" }
-        return 0
-      rescue IOError => e
-        if e.message =~ /closed/ then
+    # Fixes for two issues by Miklós Fazekas:
+    #
+    #   * if client closes a forwarded connection, but the server is
+    #     reading, net-ssh terminates with IOError socket closed.
+    #   * if client force closes (RST) a forwarded connection, but
+    #     server is reading, net-ssh terminates with [an exception]
+    #
+    # See:
+    #
+    #    http://net-ssh.lighthouseapp.com/projects/36253/tickets/7
+    #    http://github.com/net-ssh/net-ssh/tree/portfwfix
+    #
+    module ForwardedBufferedIo
+      def fill(n = 8192)
+        begin
+          super(n)
+        rescue Errno::ECONNRESET => e
           debug { "connection was reset => shallowing exception:#{e}" }
           return 0
-        else
-          raise
+        rescue IOError => e
+          if e.message =~ /closed/ then
+            debug { "connection was reset => shallowing exception:#{e}" }
+            return 0
+          else
+            raise
+          end
         end
       end
-    end
 
-    def send_pending
-      begin
-        super
-      rescue Errno::ECONNRESET => e
-        debug { "connection was reset => shallowing exception:#{e}" }
-        return 0
-      rescue IOError => e
-        if e.message =~ /closed/ then
+      def send_pending
+        begin
+          super
+        rescue Errno::ECONNRESET => e
           debug { "connection was reset => shallowing exception:#{e}" }
           return 0
-        else
-          raise
+        rescue IOError => e
+          if e.message =~ /closed/ then
+            debug { "connection was reset => shallowing exception:#{e}" }
+            return 0
+          else
+            raise
+          end
         end
       end
     end
   end
-
-end; end
+end