em-ruby-sockets 0.0.1 → 0.0.2

data/lib/em-ruby-sockets/file_streamer.rb

@@ -0,0 +1,127 @@
+module EventMachine::RubySockets
+
+  # Streams a file over a given TCP connection.
+  # It makes use of the fastfilereaderext.so Ruby extension.
+  #
+  #  class MyFileStreamer < EM::RubySockets::TcpClient
+  #    def post_init
+  #      streamer = EM::RubySockets::FileStreamer.new(self, "/tmp/bigfile.tar.gz")
+  #      streamer.callback {
+  #        # file was sent successfully
+  #        disconnect
+  #      }
+  #      streamer.errback {
+  #        # file could not be sent
+  #        disconnect
+  #      }
+  #      streamer.run
+  #    end
+  #  end
+  #
+  class FileStreamer
+    # Wait until next tick to send more data when 50k is still in the outgoing buffer.
+    BackpressureLevel = 50000
+    # Send 16k chunks at a time.
+    ChunkSize = 16384
+
+    # Parameters:
+    #
+    # - [connection] An EventMachine::RubySockets::TcpClient, EventMachine::RubySockets::TcpServer, EventMachine::RubySockets::TlsClient or EventMachine::RubySockets::TlsServer.
+    # - [filename] File path.
+    # - [args] A Hash with options.
+    #
+    # Valid options for _args_:
+    #
+    # - [http_chunks] Use HTTP 1.1 chunked-encoding.
+    #
+    def initialize connection, filename, args = {}
+      @connection = connection
+      @filename = filename
+      @http_chunks = args[:http_chunks]
+    end
+
+    # Set the success callback to be executed upon file transfer completion.
+    def callback &block
+      @on_success_block = block
+    end
+
+    # Set the error callback (errback) to be executed if file transfer fails. The errback
+    # is called by passing a single argument which can be _:invalid_file_ or _:disconnected_.
+    def errback &block
+      @on_error_block = block
+    end
+
+    # Start sending the file. This method must be called after setting both the callback and
+    # errback blocks.
+    def run
+      unless ::File.readable?(@filename) and ::File.file?(@filename)
+        do_error :invalid_file
+        return false
+      end
+
+      @size = ::File.size(@filename)
+      stream_with_mapping
+      true
+    end
+
+    # Returns a Float value indicating the file percentage trasferred at this moment.
+    def percentage_sent
+      @mapping ? (@position.to_f / @size)*100 : 0.0
+    end
+
+
+    private
+
+    def do_success
+      @on_success_block && @on_success_block.call
+    end
+
+    def do_error cause
+      @on_error_block && @on_error_block.call(cause)
+    end
+
+    def stream_with_mapping
+      ensure_mapping_extension_is_present
+
+      @position = 0
+      @mapping = ::EM::FastFileReader::Mapper.new @filename
+      stream_one_chunk
+    end
+
+    # Used internally to stream one chunk at a time over multiple reactor ticks.
+    def stream_one_chunk
+      loop do
+        if @connection.error?
+          @mapping.close
+          do_error :disconnected
+          break
+
+        elsif @position < @size
+          if @connection.get_outbound_data_size > BackpressureLevel
+            ::EM.next_tick { stream_one_chunk }
+            break
+          else
+            len = @size - @position
+            len = ChunkSize if (len > ChunkSize)
+
+            @connection.send_data "#{len.to_s(16)}\r\n"  if @http_chunks
+            @connection.send_data @mapping.get_chunk(@position, len)
+            @connection.send_data "\r\n"  if @http_chunks
+
+            @position += len
+          end
+        else
+          @connection.send_data "0\r\n\r\n"  if @http_chunks
+          @mapping.close
+          do_success
+          break
+        end
+      end
+    end
+
+    def ensure_mapping_extension_is_present
+      @@fastfilereader ||= (require "fastfilereaderext")
+    end
+
+  end
+end

data/lib/em-ruby-sockets/version.rb

@@ -1,5 +1,5 @@
 module EventMachine
   module RubySockets
-    VERSION = "0.0.1"
+    VERSION = "0.0.2"
   end
 end

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 0
-  - 1
-  version: 0.0.1
+  - 2
+  version: 0.0.2
 platform: ruby
 authors: 
 - "I\xC3\xB1aki Baz Castillo"
@@ -61,6 +61,7 @@ files:
 - lib/em-ruby-sockets/errors.rb
 - lib/em-ruby-sockets/tcp_connection.rb
 - lib/em-ruby-sockets/tcp_client.rb
+- lib/em-ruby-sockets/file_streamer.rb
 has_rdoc: true
 homepage: https://github.com/ibc/em-ruby-sockets
 licenses: []