win32-pipe 0.3.3 → 0.3.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3efdd5d2b5a0d1c4155f89cd532f1f60f56e9efc
-  data.tar.gz: fb14d03d04dfb70e0425d60c38fd248b37d86382
+  metadata.gz: 355028a84c9b976da5abdcd774bdf078ed5d806a
+  data.tar.gz: ca247e57fd842bbbd9752ac521a1d9163622a685
 SHA512:
-  metadata.gz: e67c81f9a4368a9ca83463bdae86c498407478e5cfc8ed96ffc680234d8e9bcf5b4553a5be612990d908fac84ab1b6d15efcde86ea78ab43a671bf1b3f06385e
-  data.tar.gz: 545532d071afaef42922a643c5a835f8e01e0fab14e50ee235d8e4c169c311b7e94db26ce555464a2684232fe219affe08f82f53f660f0b144e429fa903879cc
+  metadata.gz: fcd19fb11d78ae12468876e1ed0602d8fc5800d38f7767ecf1062f4cbc521a8eaf8d70053620d60267232cbed91f7bb372909e41e6e24e102fd3cf2f692bb595
+  data.tar.gz: 607f40aab87ece6503c15804829b33441766efedb999ecd1de2b44a6ff2668460a9ed46fabc2adeeeeba42d2cf0f3b3016c4bda73e7fcd548c9225072259ad53

data/CHANGES

@@ -1,3 +1,11 @@
+== 0.3.4 - 22-Mar-2014
+* Modified the constructor to allow a fourth argument that lets you set the
+  buffer size used by pipes. The default size has been increased to 4k.
+* Use a bonafide FFI::Buffer, and re-use it instead of creating a new buffer
+  for each read/write operation.
+* Thanks go to lionelperrin for the above updates.
+* Added Rake as a development dependency.
+
 == 0.3.3 - 21-Oct-2013
 * Fixed INVALID_HANDLE_VALUE for 64-bit Ruby.
 * Now internally uses a struct for OVERLAPPED event instead of packed string.

data/lib/win32/pipe.rb

@@ -16,9 +16,9 @@ module Win32
     class Error < StandardError; end
 
     # The version of this library
-    VERSION = '0.3.3'
+    VERSION = '0.3.4'
 
-    PIPE_BUFFER_SIZE = 512 #:nodoc:
+    DEFAULT_PIPE_BUFFER_SIZE = 4096 #:nodoc:
     PIPE_TIMEOUT = 5000    #:nodoc:
 
     # Blocking mode is enabled
@@ -59,7 +59,7 @@ module Win32
     OVERLAPPED = FILE_FLAG_OVERLAPPED
 
     # The default pipe mode
-    DEFAULT_PIPE_MODE = NOWAIT
+    DEFAULT_PIPE_MODE = PIPE_WAIT
 
     # The default open mode
     DEFAULT_OPEN_MODE = FILE_ATTRIBUTE_NORMAL | FILE_FLAG_WRITE_THROUGH
@@ -90,7 +90,7 @@ module Win32
     #
     # The default open mode is FILE_ATTRIBUTE_NORMAL | FILE_FLAG_WRITE_THROUGH.
     #
-    def initialize(name, pipe_mode = DEFAULT_PIPE_MODE, open_mode = DEFAULT_OPEN_MODE)
+    def initialize(name, pipe_mode = DEFAULT_PIPE_MODE, open_mode = DEFAULT_OPEN_MODE, pipe_buffer_size = DEFAULT_PIPE_BUFFER_SIZE)
       @name = "\\\\.\\pipe\\" + name
 
       @pipe_mode = pipe_mode.nil? ? DEFAULT_PIPE_MODE : pipe_mode
@@ -98,11 +98,13 @@ module Win32
 
       @pipe         = nil
       @pending_io   = false
-      @buffer       = 0.chr * PIPE_BUFFER_SIZE
+      @buffer       = ''
+      @ffi_buffer   = FFI::Buffer.new( pipe_buffer_size )
       @size         = 0
-      @overlapped   = Overlapped.new
+      @overlapped   = nil
       @transferred  = 0
       @asynchronous = false
+      @pipe_buffer_size = pipe_buffer_size
 
       if open_mode & FILE_FLAG_OVERLAPPED > 0
         @asynchronous = true
@@ -110,6 +112,7 @@ module Win32
 
       if @asynchronous
         @event = CreateEvent(nil, true, true, nil)
+        @overlapped = Overlapped.new
         @overlapped[:hEvent] = @event
       end
     end
@@ -142,22 +145,20 @@ module Win32
     #
     def read
       bytes = FFI::MemoryPointer.new(:ulong)
-      @buffer = 0.chr * PIPE_BUFFER_SIZE
 
       raise Error, "no pipe created" unless @pipe
 
       if @asynchronous
-        bool = ReadFile(@pipe, @buffer, @buffer.size, bytes, @overlapped)
-        error = GetLastError()
-
+        bool = ReadFile(@pipe, @ffi_buffer, @ffi_buffer.size, bytes, @overlapped)
         bytes_read = bytes.read_ulong
 
         if bool && bytes_read > 0
           @pending_io = false
-          @buffer = @buffer[0, bytes_read]
+          @buffer = @ffi_buffer.get_string(0, bytes_read)
           return true
         end
 
+        error = GetLastError()
         if !bool && error == ERROR_IO_PENDING
           @pending_io = true
           return true
@@ -165,28 +166,24 @@ module Win32
 
         return false
       else
-        unless ReadFile(@pipe, @buffer, @buffer.size, bytes, nil)
+        unless ReadFile(@pipe, @ffi_buffer, @ffi_buffer.size, bytes, nil)
           raise SystemCallError.new("ReadFile", FFI.errno)
         end
+        @buffer = @ffi_buffer.get_string(0, bytes.read_ulong)
       end
-
-      @buffer.unpack("A*")
     end
 
     # Writes 'data' to the pipe. You can write data to either end of a
     # named pipe.
     #
     def write(data)
-      @buffer = data
       @size   = data.size
       bytes   = FFI::MemoryPointer.new(:ulong)
 
       raise Error, "no pipe created" unless @pipe
 
       if @asynchronous
-        bool = WriteFile(@pipe, @buffer, @buffer.size, bytes, @overlapped)
-        error = GetLastError()
-
+        bool = WriteFile(@pipe, @data, @data.size, bytes, @overlapped)
         bytes_written = bytes.read_ulong
 
         if bool && bytes_written > 0
@@ -194,6 +191,7 @@ module Win32
           return true
         end
 
+        error = GetLastError()
         if !bool && error == ERROR_IO_PENDING
           @pending_io = true
           return true
@@ -201,7 +199,7 @@ module Win32
 
         return false
       else
-        unless WriteFile(@pipe, @buffer, @buffer.size, bytes, nil)
+        unless WriteFile(@pipe, data, data.size, bytes, nil)
           raise SystemCallError.new("WriteFile", FFI.errno)
         end
 
@@ -239,7 +237,7 @@ module Win32
         end
 
         @transferred = transferred.read_ulong
-        @buffer = @buffer[0, @transferred]
+        @buffer = @ffi_buffer.get_string(0, @transferred)
       end
 
       self

data/lib/win32/pipe/client.rb

@@ -27,8 +27,8 @@ module Win32
     #     puts "Got [#{data}] back from pipe server"
     #  end
     #
-    def initialize(name, pipe_mode = DEFAULT_PIPE_MODE, open_mode = DEFAULT_OPEN_MODE)
-      super(name, pipe_mode, open_mode)
+    def initialize(name, pipe_mode = DEFAULT_PIPE_MODE, open_mode = DEFAULT_OPEN_MODE, pipe_buffer_size = DEFAULT_PIPE_BUFFER_SIZE)
+      super(name, pipe_mode, open_mode, pipe_buffer_size)
 
       @pipe = CreateFile(
         @name,

data/lib/win32/pipe/server.rb

@@ -14,22 +14,22 @@ module Win32
     #--
     # The default pipe_mode also happens to be 0.
     #
-    def initialize(name, pipe_mode = 0, open_mode = Pipe::ACCESS_DUPLEX)
-      super(name, pipe_mode, open_mode)
+    def initialize(name, pipe_mode = 0, open_mode = Pipe::ACCESS_DUPLEX, pipe_buffer_size = DEFAULT_PIPE_BUFFER_SIZE)
+      super(name, pipe_mode, open_mode, pipe_buffer_size)
 
       @pipe = CreateNamedPipe(
         @name,
         @open_mode,
         @pipe_mode,
         PIPE_UNLIMITED_INSTANCES,
-        PIPE_BUFFER_SIZE,
-        PIPE_BUFFER_SIZE,
+        pipe_buffer_size,
+        pipe_buffer_size,
         PIPE_TIMEOUT,
         nil
       )
 
       if @pipe == INVALID_HANDLE_VALUE
-        raise
+        raise SystemCallError.new("CreateNamedPipe", FFI.errno)
       end
 
       if block_given?

data/lib/win32/pipe/windows/structs.rb

@@ -1,18 +1,18 @@
-require 'ffi'
-
-module Windows
-  module Structs
-    extend FFI::Library
-
-    # I'm assuming the anonymous struct for the internal union here.
-    class Overlapped < FFI::Struct
-      layout(
-        :Internal, :uintptr_t,
-        :InternalHigh, :uintptr_t,
-        :Offset, :ulong,
-        :OffsetHigh, :ulong,
-        :hEvent, :uintptr_t
-      )
-    end
-  end
-end
+require 'ffi'
+
+module Windows
+  module Structs
+    extend FFI::Library
+
+    # I'm assuming the anonymous struct for the internal union here.
+    class Overlapped < FFI::Struct
+      layout(
+        :Internal, :uintptr_t,
+        :InternalHigh, :uintptr_t,
+        :Offset, :ulong,
+        :OffsetHigh, :ulong,
+        :hEvent, :uintptr_t
+      )
+    end
+  end
+end

data/test/test_win32_pipe.rb

@@ -14,7 +14,7 @@ class TC_Win32_Pipe < Test::Unit::TestCase
   end
 
   test "version is set to expected value" do
-    assert_equal('0.3.3', Pipe::VERSION)
+    assert_equal('0.3.4', Pipe::VERSION)
   end
 
   test "name method basic functionality" do

data/win32-pipe.gemspec

@@ -2,7 +2,7 @@ require 'rubygems'
 
 Gem::Specification.new do |spec|
 	spec.name       = 'win32-pipe'
-	spec.version    = '0.3.3'
+	spec.version    = '0.3.4'
 	spec.author     = 'Daniel J. Berger'
   spec.license    = 'Artistic 2.0'
 	spec.email      = 'djberg96@gmail.com'
@@ -15,6 +15,7 @@ Gem::Specification.new do |spec|
 	spec.extra_rdoc_files  = ['CHANGES', 'README', 'MANIFEST']
 	
 	spec.add_dependency('ffi')
+	spec.add_dependency('rake')
   spec.add_development_dependency('test-unit')
 	
 	spec.description = <<-EOF

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: win32-pipe
 version: !ruby/object:Gem::Version
-  version: 0.3.3
+  version: 0.3.4
 platform: ruby
 authors:
 - Daniel J. Berger
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-21 00:00:00.000000000 Z
+date: 2014-03-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ffi
@@ -24,6 +24,20 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: test-unit
   requirement: !ruby/object:Gem::Requirement
@@ -50,19 +64,19 @@ extra_rdoc_files:
 - MANIFEST
 files:
 - CHANGES
+- MANIFEST
+- README
+- Rakefile
 - examples/example_client.rb
 - examples/example_client_async.rb
 - examples/example_server.rb
 - examples/example_server_async.rb
+- lib/win32/pipe.rb
 - lib/win32/pipe/client.rb
 - lib/win32/pipe/server.rb
 - lib/win32/pipe/windows/constants.rb
 - lib/win32/pipe/windows/functions.rb
 - lib/win32/pipe/windows/structs.rb
-- lib/win32/pipe.rb
-- MANIFEST
-- Rakefile
-- README
 - test/test_win32_pipe.rb
 - test/test_win32_pipe_client.rb
 - test/test_win32_pipe_server.rb
@@ -87,7 +101,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: win32utils
-rubygems_version: 2.1.9
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: An interface for named pipes on MS Windows