libuv 1.0.0 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a3fdf4a79e7b5985a3f094717f5a9c2ffe62f3df
-  data.tar.gz: 0f89e89ea0ef13b59a164e3cdc5a108a57f5b822
+  metadata.gz: d13aec5db12ee41ad8e672bda901a128d7e29fd3
+  data.tar.gz: 554f2bd2a9ff1d9a69af2551a48a944e3af5cd91
 SHA512:
-  metadata.gz: 3620a3921345db547e886a42fe143a38272b4d81575906e31a32ca5b984a3fb15e08239b1bf4b08a89e17c4fcc7c336b67b879616434657b38747f42c87a429b
-  data.tar.gz: 49cce94c651ba27b4ecfbb08e443fde71527fc159c34f58fab336344b361c94ec3d02439f325c3fd748cee960a52aab7d38ccef8b6a24d271dedf532f86762d9
+  metadata.gz: f8362798abe6237ea412ff7ff03fbfa27a47d3606e1f8e318ae8f33555c7e23b59e8f3c84f1ab8453b08464b69cfc1fc568a5127bcc13718f02fd5fc7cb78bf6
+  data.tar.gz: 7f82bc4fff20b9f0a380d3bfe76b2790b5d602679f0943cbe50835bba88a5988f09c7fab31e04d2cd43bc268e2aeec8c8cbcab626ef2a3a451c3fd2e530fbc66

data/README.md

@@ -1,14 +1,14 @@
 # Libuv FFI bindings for Ruby
 
-[![Build Status](https://travis-ci.org/cotag/libuv.png?branch=master)](https://travis-ci.org/cotag/libuv)
+[![Build Status](https://travis-ci.org/cotag/libuv.svg?branch=master)](https://travis-ci.org/cotag/libuv)
 
 [Libuv](https://github.com/joyent/libuv) is a cross platform asynchronous IO implementation that powers NodeJS. It supports sockets, both UDP and TCP, filesystem watch, TTY, Pipes and other asynchronous primitives like timer, check, prepare and idle.
 
-The Libuv gem contains Libuv and a Ruby wrapper that implements [pipelined promises](http://en.wikipedia.org/wiki/Futures_and_promises#Promise_pipelining) for asynchronous flow control
+The Libuv gem contains Libuv and a Ruby wrapper that implements [pipelined promises](http://en.wikipedia.org/wiki/Futures_and_promises#Promise_pipelining) for asynchronous flow control and [coroutines](http://en.wikipedia.org/wiki/Coroutine) for untangling evented code
 
 ## Usage
 
-Create a new libuv loop or use a default one
+using promises
 
 ```ruby
   require 'libuv'
@@ -21,7 +21,6 @@ Create a new libuv loop or use a default one
     timer = loop.timer do
       puts "5 seconds passed"
       timer.close
-      loop.stop
     end
     timer.catch do |error|
       puts "error with timer: #{error}"
@@ -33,6 +32,31 @@ Create a new libuv loop or use a default one
   end
 ```
 
+using coroutines (if a somewhat abstract example)
+
+```ruby
+  require 'libuv'
+  require 'libuv/coroutines'
+
+  loop = Libuv::Loop.default
+  loop.run do
+    begin
+      timer = loop.timer do
+        puts "5 seconds passed"
+        timer.close
+      end
+      timer.start(5000)
+
+      # co-routine waits for timer to close
+      co timer
+
+      puts "timer handle was closed"
+    rescue => error
+      puts "error with timer: #{error}"
+    end
+  end
+```
+
 Check out the [yard documentation](http://rubydoc.info/gems/libuv/Libuv/Loop)
 
 
@@ -69,7 +93,7 @@ Windows users will additionally require:
 
 
 
-## Libuv features supported
+## Features
 
 * TCP (with TLS support)
 * UDP
@@ -87,3 +111,4 @@ Windows users will additionally require:
 * File manipulation
 * Errors (with a catch-all fallback for anything unhandled on the event loop)
 * Work queue (thread pool)
+* Coroutines (optional - makes use of Fibers)

data/lib/libuv/coroutines.rb

@@ -0,0 +1,46 @@
+require 'fiber'
+
+class ::Libuv::Loop
+    @@use_fibers = true
+end
+
+class Object
+    private
+
+
+    # Takes a Promise response and turns it into a co-routine
+    # for code execution without using callbacks
+    #
+    # @param *promises [::Libuv::Q::Promise] a number of promises that will be combined into a single promise
+    # @return [Object] Returns the result of a single promise or an array of results if provided multiple promises
+    # @raise [Exception] if the promise is rejected
+    def co(*yieldable, &block)
+        f = Fiber.current
+        wasError = false
+
+        # Convert the input into a promise
+        if yieldable.length == 1
+            promise = yieldable[0]
+        else
+            promise = ::Libuv::Loop.current.all(*yieldable)
+        end
+
+        # Use the promise to resume the Fiber
+        promise.then(proc { |res|
+            f.resume res
+        }, proc { |err|
+            wasError = true
+            f.resume err
+        })
+
+        # Passed independently as this is often overwritten for performance
+        promise.progress(block) if block_given?
+
+        # Assign the result from the resume
+        result = Fiber.yield
+
+        # Either return the result or raise an error
+        raise result if wasError
+        result
+    end
+end

data/lib/libuv/ext/ext.rb

@@ -91,6 +91,7 @@ module Libuv
         attach_function :accept, :uv_accept, [:uv_stream_t, :uv_stream_t], :int, :blocking => true
         attach_function :read_start, :uv_read_start, [:uv_stream_t, :uv_alloc_cb, :uv_read_cb], :int, :blocking => true
         attach_function :read_stop, :uv_read_stop, [:uv_stream_t], :int, :blocking => true
+        attach_function :try_write, :uv_try_write, [:uv_stream_t, :pointer, :uint], :int, :blocking => true
         attach_function :write, :uv_write, [:uv_write_t, :uv_stream_t, :pointer, :uint, :uv_write_cb], :int, :blocking => true
         attach_function :write2, :uv_write2, [:uv_write_t, :uv_stream_t, :pointer, :uint, :uv_stream_t, :uv_write_cb], :int, :blocking => true
         attach_function :is_readable, :uv_is_readable, [:uv_stream_t], :int, :blocking => true
@@ -116,6 +117,7 @@ module Libuv
         attach_function :udp_set_multicast_ttl, :uv_udp_set_multicast_ttl, [:uv_udp_t, :int], :int, :blocking => true
         attach_function :udp_set_broadcast, :uv_udp_set_broadcast, [:uv_udp_t, :int], :int, :blocking => true
         attach_function :udp_set_ttl, :uv_udp_set_ttl, [:uv_udp_t, :int], :int, :blocking => true
+        attach_function :udp_try_send, :uv_udp_try_send, [:uv_udp_t, :pointer, :int, :sockaddr_in], :int, :blocking => true
         attach_function :udp_send, :uv_udp_send, [:uv_udp_send_t, :uv_udp_t, :pointer, :int, :sockaddr_in, :uv_udp_send_cb], :int, :blocking => true
         attach_function :udp_recv_start, :uv_udp_recv_start, [:uv_udp_t, :uv_alloc_cb, :uv_udp_recv_cb], :int, :blocking => true
         attach_function :udp_recv_stop, :uv_udp_recv_stop, [:uv_udp_t], :int, :blocking => true

data/lib/libuv/loop.rb

@@ -7,6 +7,7 @@ module Libuv
 
         LOOPS = ThreadSafe::Cache.new
         CRITICAL = Mutex.new
+        @@use_fibers = false
 
 
         module ClassMethods
@@ -122,14 +123,24 @@ module Libuv
                 begin
                     @reactor_thread = Thread.current
                     LOOPS[@reactor_thread] = @loop
-                    yield  @loop_notify.promise if block_given?
+                    if block_given?
+                        if @@use_fibers
+                            Fiber.new { yield @loop_notify.promise }.resume
+                        else
+                            yield @loop_notify.promise
+                        end
+                    end
                     ::Libuv::Ext.run(@pointer, run_type)  # This is blocking
                 ensure
                     @reactor_thread = nil
                     @run_queue.clear
                 end
             elsif block_given?
-                schedule { yield  @loop_notify.promise }
+                if @@use_fibers
+                    schedule { Fiber.new { yield @loop_notify.promise }.resume }
+                else
+                    schedule { yield @loop_notify.promise }
+                end
             end
             @loop
         end

data/lib/libuv/mixins/stream.rb

@@ -36,6 +36,20 @@ module Libuv
             reject(error) if error
         end
 
+        def try_write(data)
+            assert_type(String, data, WRITE_ERROR)
+
+            buffer1 = ::FFI::MemoryPointer.from_string(data)
+            buffer  = ::Libuv::Ext.buf_init(buffer1, data.respond_to?(:bytesize) ? data.bytesize : data.size)
+
+            result = ::Libuv::Ext.try_write(handle, buffer, 1)
+            buffer1.free
+
+            error = check_result result
+            raise error if error
+            return result
+        end
+
         def write(data)
             # NOTE:: Similar to udp.rb -> send
             deferred = @loop.defer
@@ -43,10 +57,8 @@ module Libuv
                 begin
                     assert_type(String, data, WRITE_ERROR)
 
-                    size        = data.respond_to?(:bytesize) ? data.bytesize : data.size
-                    buffer1     = ::Libuv::Ext.malloc size
-                    buffer1.write_string data
-                    buffer      = ::Libuv::Ext.buf_init(buffer1, size)
+                    buffer1 = ::FFI::MemoryPointer.from_string(data)
+                    buffer  = ::Libuv::Ext.buf_init(buffer1, data.respond_to?(:bytesize) ? data.bytesize : data.size)
 
                     # local as this variable will be available until the handle is closed
                     @write_callbacks ||= {}
@@ -57,7 +69,7 @@ module Libuv
                     if error
                         @write_callbacks.delete req.address
                         ::Libuv::Ext.free(req)
-                        ::Libuv::Ext.free(buffer1)
+                        buffer1.free
                         deferred.reject(error)
 
                         reject(error)       # close the handle
@@ -112,7 +124,7 @@ module Libuv
             deferred, buffer1 = @write_callbacks.delete req.address
 
             ::Libuv::Ext.free(req)
-            ::Libuv::Ext.free(buffer1)
+            buffer1.free
 
             resolve deferred, status
         end

data/lib/libuv/timer.rb

@@ -21,6 +21,10 @@ module Libuv
             return if @closed
             @stopped = false
 
+            # prevent timeouts less than 0 (very long time otherwise as cast to an unsigned)
+            # and you probably don't want to wait a few lifetimes
+            timeout = 0 if timeout < 0
+
             timeout = timeout.to_i
             repeat = repeat.to_i
 

data/lib/libuv/udp.rb

@@ -15,6 +15,7 @@ module Libuv
 
             udp_ptr = ::Libuv::Ext.create_handle(:uv_udp)
             error = check_result(::Libuv::Ext.udp_init(loop.handle, udp_ptr))
+            @request_refs = {}
 
             super(udp_ptr, error)
         end
@@ -39,7 +40,7 @@ module Libuv
             return [] if @closed
             sockaddr, len = get_sockaddr_and_len
             check_result! ::Libuv::Ext.udp_getsockname(handle, sockaddr, len)
-            get_ip_and_port(UV::Sockaddr.new(sockaddr), len.get_int(0))
+            get_ip_and_port(::Libuv::Ext::Sockaddr.new(sockaddr), len.get_int(0))
         end
 
         def join(multicast_address, interface_address)
@@ -76,6 +77,29 @@ module Libuv
             reject(error) if error
         end
 
+        def try_send(ip, port, data)
+            assert_type(String, ip, IP_ARGUMENT_ERROR)
+            assert_type(Integer, port, PORT_ARGUMENT_ERROR)
+            assert_type(String, data, SEND_DATA_ERROR)
+
+            sockaddr = create_sockaddr(ip, port)
+
+            buffer1 = ::FFI::MemoryPointer.from_string(data)
+            buffer  = ::Libuv::Ext.buf_init(buffer1, data.respond_to?(:bytesize) ? data.bytesize : data.size)
+
+            result = ::Libuv::Ext.udp_try_send(
+                handle,
+                buffer,
+                1,
+                sockaddr
+            )
+            buffer1.free
+
+            error = check_result result
+            raise error if error
+            return result
+        end
+
         def send(ip, port, data)
             # NOTE:: Similar to stream.rb -> write
             deferred = @loop.defer
@@ -87,34 +111,25 @@ module Libuv
 
                     sockaddr = create_sockaddr(ip, port)
 
-                    # local as this variable will be avaliable until the handle is closed
-                    @sent_callbacks ||= []
+                    # Save a reference to this request
+                    req = send_req
+                    buffer1 = ::FFI::MemoryPointer.from_string(data)
+                    buffer  = ::Libuv::Ext.buf_init(buffer1, data.respond_to?(:bytesize) ? data.bytesize : data.size)
+                    @request_refs[req.address] = [deferred, buffer1]
 
-                    #
-                    # create the curried callback
-                    #
-                    callback = FFI::Function.new(:void, [:pointer, :int]) do |req, status|
-                        ::Libuv::Ext.free(req)
-                        # remove the callback from the array
-                        # assumes sends are done in order
-                        promise = @sent_callbacks.shift[0]
-                        resolve promise, status
-                    end
-
-                    #
                     # Save the callback and return the promise
-                    #
-                    @sent_callbacks << [deferred, callback]
                     error = check_result ::Libuv::Ext.udp_send(
-                        send_req,
+                        req,
                         handle,
-                        buf_init(data),
+                        buffer,
                         1,
                         sockaddr,
-                        callback
+                        callback(:send_complete)
                     )
                     if error
-                        @sent_callbacks.pop
+                        @request_refs.delete req.address
+                        ::Libuv::Ext.free(req)
+                        buffer1.free
                         deferred.reject(error)
                         reject(error)       # close the handle
                     end
@@ -177,10 +192,6 @@ module Libuv
             ::Libuv::Ext.create_request(:uv_udp_send)
         end
 
-        def buf_init(data)
-            ::Libuv::Ext.buf_init(FFI::MemoryPointer.from_string(data), data.respond_to?(:bytesize) ? data.bytesize : data.size)
-        end
-
         def create_sockaddr(ip, port)
             ips = IPAddr.new(ip)
             if ips.ipv4?
@@ -237,5 +248,14 @@ module Libuv
                 @receive_size = nil
             end
         end
+
+        def send_complete(req, status)
+            deferred, buffer1 = @request_refs.delete req.address
+
+            ::Libuv::Ext.free(req)
+            buffer1.free
+
+            resolve deferred, status
+        end
     end
 end

data/lib/libuv/version.rb

@@ -1,3 +1,3 @@
 module Libuv
-    VERSION = '1.0.0'
+    VERSION = '1.0.2'
 end

data/spec/coroutines_spec.rb

@@ -0,0 +1,136 @@
+require 'libuv'
+require 'libuv/coroutines' # adds support for coroutines
+
+
+describe Object do
+	before :each do
+		@log = []
+		@general_failure = []
+
+		@loop = Libuv::Loop.default
+		@timeout = @loop.timer do
+			@timeout.close
+			@loop.stop
+			@general_failure << "test timed out"
+		end
+		@timeout.start(5000)
+	end
+	
+	describe 'serial execution' do
+		it "should wait for work to complete and return the result" do
+			@loop.run { |logger|
+				logger.progress do |level, errorid, error|
+					begin
+						@general_failure << "Log called: #{level}: #{errorid}\n#{error.message}\n#{error.backtrace.join("\n") if error.backtrace}\n"
+					rescue Exception => e
+						@general_failure << "error in logger #{e.inspect}"
+					end
+				end
+
+
+				@log << co(@loop.work(proc {
+					sleep 1
+					'work done'
+				}))
+				@log << 'after work'
+
+				@timeout.close
+				@loop.stop
+			}
+
+			expect(@general_failure).to eq([])
+			expect(@log).to eq(['work done', 'after work'])
+		end
+
+		it "should raise an error if the promise is rejected" do
+			@loop.run { |logger|
+				logger.progress do |level, errorid, error|
+					begin
+						@general_failure << "Log called: #{level}: #{errorid}\n#{error.message}\n#{error.backtrace.join("\n") if error.backtrace}\n"
+					rescue Exception => e
+						@general_failure << "error in logger #{e.inspect}"
+					end
+				end
+
+				begin
+					@log << co(@loop.work(proc {
+						raise 'rejected'
+					}))
+					@log << 'after work'
+				rescue => e
+					@log << e.message
+				end
+
+				@timeout.close
+				@loop.stop
+			}
+
+			expect(@general_failure).to eq([])
+			expect(@log).to eq(['rejected'])
+		end
+
+		it "should return the results of multiple promises" do
+			@loop.run { |logger|
+				logger.progress do |level, errorid, error|
+					begin
+						@general_failure << "Log called: #{level}: #{errorid}\n#{error.message}\n#{error.backtrace.join("\n") if error.backtrace}\n"
+					rescue Exception => e
+						@general_failure << "error in logger #{e.inspect}"
+					end
+				end
+
+
+				job1 = @loop.work(proc {
+					sleep 1
+					'job1'
+				})
+
+				job2 = @loop.work(proc {
+					sleep 1
+					'job2'
+				})
+
+				# Job1 and Job2 are executed in parallel
+				result1, result2 = co(job1, job2)
+
+				@log << result1
+				@log << result2
+				@log << 'after work'
+
+				@timeout.close
+				@loop.stop
+			}
+
+			expect(@general_failure).to eq([])
+			expect(@log).to eq(['job1', 'job2', 'after work'])
+		end
+
+
+		it "should provide a callback option for progress events" do
+			@loop.run { |logger|
+				logger.progress do |level, errorid, error|
+					begin
+						@general_failure << "Log called: #{level}: #{errorid}\n#{error.message}\n#{error.backtrace.join("\n") if error.backtrace}\n"
+					rescue Exception => e
+						@general_failure << "error in logger #{e.inspect}"
+					end
+				end
+
+				timer = @loop.timer
+				timer.start(0)
+				co(timer) do
+					@log << 'in timer'
+					timer.close  # close will resolve the promise
+				end
+
+				@log << 'after timer'
+
+				@timeout.close
+				@loop.stop
+			}
+
+			expect(@log).to eq(['in timer', 'after timer'])
+			expect(@general_failure).to eq([])
+		end
+	end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: libuv
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.2
 platform: ruby
 authors:
 - Bulat Shakirzyanov
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-20 00:00:00.000000000 Z
+date: 2014-08-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ffi
@@ -117,6 +117,7 @@ files:
 - lib/libuv.rb
 - lib/libuv/async.rb
 - lib/libuv/check.rb
+- lib/libuv/coroutines.rb
 - lib/libuv/dns.rb
 - lib/libuv/error.rb
 - lib/libuv/ext/ext.rb
@@ -153,6 +154,7 @@ files:
 - lib/libuv/work.rb
 - libuv.gemspec
 - spec/async_spec.rb
+- spec/coroutines_spec.rb
 - spec/cpu_spec.rb
 - spec/defer_spec.rb
 - spec/dns_spec.rb
@@ -175,15 +177,19 @@ files:
 - ext/libuv/common.gypi
 - ext/libuv/configure.ac
 - ext/libuv/gyp_uv.py
+- ext/libuv/img/banner.png
+- ext/libuv/img/logos.svg
 - ext/libuv/include/android-ifaddrs.h
 - ext/libuv/include/pthread-fixes.h
 - ext/libuv/include/stdint-msvc2008.h
 - ext/libuv/include/tree.h
+- ext/libuv/include/uv-aix.h
 - ext/libuv/include/uv-bsd.h
 - ext/libuv/include/uv-darwin.h
 - ext/libuv/include/uv-errno.h
 - ext/libuv/include/uv-linux.h
 - ext/libuv/include/uv-sunos.h
+- ext/libuv/include/uv-threadpool.h
 - ext/libuv/include/uv-unix.h
 - ext/libuv/include/uv-version.h
 - ext/libuv/include/uv-win.h
@@ -209,6 +215,7 @@ files:
 - ext/libuv/src/heap-inl.h
 - ext/libuv/src/inet.c
 - ext/libuv/src/queue.h
+- ext/libuv/src/threadpool.c
 - ext/libuv/src/unix/aix.c
 - ext/libuv/src/unix/android-ifaddrs.c
 - ext/libuv/src/unix/async.c
@@ -221,6 +228,7 @@ files:
 - ext/libuv/src/unix/fs.c
 - ext/libuv/src/unix/fsevents.c
 - ext/libuv/src/unix/getaddrinfo.c
+- ext/libuv/src/unix/getnameinfo.c
 - ext/libuv/src/unix/internal.h
 - ext/libuv/src/unix/kqueue.c
 - ext/libuv/src/unix/linux-core.c
@@ -242,7 +250,6 @@ files:
 - ext/libuv/src/unix/sunos.c
 - ext/libuv/src/unix/tcp.c
 - ext/libuv/src/unix/thread.c
-- ext/libuv/src/unix/threadpool.c
 - ext/libuv/src/unix/timer.c
 - ext/libuv/src/unix/tty.c
 - ext/libuv/src/unix/udp.c
@@ -258,6 +265,7 @@ files:
 - ext/libuv/src/win/fs-event.c
 - ext/libuv/src/win/fs.c
 - ext/libuv/src/win/getaddrinfo.c
+- ext/libuv/src/win/getnameinfo.c
 - ext/libuv/src/win/handle-inl.h
 - ext/libuv/src/win/handle.c
 - ext/libuv/src/win/internal.h
@@ -273,7 +281,6 @@ files:
 - ext/libuv/src/win/stream.c
 - ext/libuv/src/win/tcp.c
 - ext/libuv/src/win/thread.c
-- ext/libuv/src/win/threadpool.c
 - ext/libuv/src/win/timer.c
 - ext/libuv/src/win/tty.c
 - ext/libuv/src/win/udp.c
@@ -337,6 +344,7 @@ files:
 - ext/libuv/test/test-get-loadavg.c
 - ext/libuv/test/test-get-memory.c
 - ext/libuv/test/test-getaddrinfo.c
+- ext/libuv/test/test-getnameinfo.c
 - ext/libuv/test/test-getsockname.c
 - ext/libuv/test/test-hrtime.c
 - ext/libuv/test/test-idle.c
@@ -362,6 +370,7 @@ files:
 - ext/libuv/test/test-pipe-server-close.c
 - ext/libuv/test/test-platform-output.c
 - ext/libuv/test/test-poll-close.c
+- ext/libuv/test/test-poll-closesocket.c
 - ext/libuv/test/test-poll.c
 - ext/libuv/test/test-process-title.c
 - ext/libuv/test/test-ref.c
@@ -390,6 +399,7 @@ files:
 - ext/libuv/test/test-tcp-shutdown-after-write.c
 - ext/libuv/test/test-tcp-try-write.c
 - ext/libuv/test/test-tcp-unexpected-read.c
+- ext/libuv/test/test-tcp-write-queue-order.c
 - ext/libuv/test/test-tcp-write-to-half-open-connection.c
 - ext/libuv/test/test-tcp-writealot.c
 - ext/libuv/test/test-thread.c
@@ -410,6 +420,8 @@ files:
 - ext/libuv/test/test-udp-open.c
 - ext/libuv/test/test-udp-options.c
 - ext/libuv/test/test-udp-send-and-recv.c
+- ext/libuv/test/test-udp-send-immediate.c
+- ext/libuv/test/test-udp-try-send.c
 - ext/libuv/test/test-walk-handles.c
 - ext/libuv/test/test-watcher-cross-stop.c
 - ext/libuv/uv.gyp
@@ -440,6 +452,7 @@ specification_version: 4
 summary: libuv bindings for Ruby
 test_files:
 - spec/async_spec.rb
+- spec/coroutines_spec.rb
 - spec/cpu_spec.rb
 - spec/defer_spec.rb
 - spec/dns_spec.rb