win32-pipe 0.2.2 → 0.3.0

data/CHANGES

@@ -1,46 +1,51 @@
-== 0.2.2 - 19-Mar-2012
-* Added test-unit 2.x as a development dependency.
-* Refactored some tests to use features of test-unit 2.x.
-* Refactored the Rakefile.
-
-== 0.2.1 - 9-Aug-2009
-* License changed to Artistic 2.0.
-* Test and example files renamed.
-* Gemspec updates, including license and description.
-* Updates to the Rakefile, including the removal of old C rake tasks, as
-  well as the addition of tasks to run the example programs.
-
-== 0.2.0 - 28-May-2008
-* Now pure Ruby.
-* Major interface change. Pipe::Server.new and Pipe::Client.new replace the
-  Pipe.new_server and Pipe.new_client methods, respectively.
-* An optional 3rd argument, the open mode, is now accepted which allows finer
-  control over how pipes are created.
-* Several pipe mode and open mode constants were added.
-* The asynchronous pipe server actually works now.
-* Added the Pipe#name method.
-* Added the Pipe#asynchronous? method.
-* Added the Pipe#size method as an alias for Pipe#length.
-* Added a Rakefile with tasks for testing and installation.
-* Added a gemspec and uploaded a gem file to RubyForge.
-* Merged the doc files into the README and/or replaced them with inlined
-  comments that are RDoc friendly.
-
-== 0.1.2 - 1-Mar-2005
-* Moved the 'examples' directory to the toplevel directory.
-* Made the CHANGES and README files rdoc friendly.
-
-== 0.1.1 - 25-Aug-2004
-* Added many more tests to the test suite.
-* Moved the example programs to doc/examples.
-* Fixed minor bugs in the asynchronous client and server test programs.
-* Removed the pipe.html file.  You can generate your own html documentation
-  using rd2 on the pipe.rd file.
-
-== 0.1.0 - 13-Feb-2004
-* Asynchronous support added (thanks Park Heesob)
-* Sample test programs added.  See files under 'test'.
-* Documentation updates.
-
-== 0.0.1 - 20-Nov-2003
-* Initial release
+== 0.3.0 - 8-Sep-2012
+* Converted to FFI. Now works with JRuby, too.
+* Native errors are now raised as SystemCallErrors.
+* Test updates, gemspec dependency updates, etc.
+
+== 0.2.2 - 19-Mar-2012
+* Added test-unit 2.x as a development dependency.
+* Refactored some tests to use features of test-unit 2.x.
+* Refactored the Rakefile.
+
+== 0.2.1 - 9-Aug-2009
+* License changed to Artistic 2.0.
+* Test and example files renamed.
+* Gemspec updates, including license and description.
+* Updates to the Rakefile, including the removal of old C rake tasks, as
+  well as the addition of tasks to run the example programs.
+
+== 0.2.0 - 28-May-2008
+* Now pure Ruby.
+* Major interface change. Pipe::Server.new and Pipe::Client.new replace the
+  Pipe.new_server and Pipe.new_client methods, respectively.
+* An optional 3rd argument, the open mode, is now accepted which allows finer
+  control over how pipes are created.
+* Several pipe mode and open mode constants were added.
+* The asynchronous pipe server actually works now.
+* Added the Pipe#name method.
+* Added the Pipe#asynchronous? method.
+* Added the Pipe#size method as an alias for Pipe#length.
+* Added a Rakefile with tasks for testing and installation.
+* Added a gemspec and uploaded a gem file to RubyForge.
+* Merged the doc files into the README and/or replaced them with inlined
+  comments that are RDoc friendly.
+
+== 0.1.2 - 1-Mar-2005
+* Moved the 'examples' directory to the toplevel directory.
+* Made the CHANGES and README files rdoc friendly.
+
+== 0.1.1 - 25-Aug-2004
+* Added many more tests to the test suite.
+* Moved the example programs to doc/examples.
+* Fixed minor bugs in the asynchronous client and server test programs.
+* Removed the pipe.html file.  You can generate your own html documentation
+  using rd2 on the pipe.rd file.
+
+== 0.1.0 - 13-Feb-2004
+* Asynchronous support added (thanks Park Heesob)
+* Sample test programs added.  See files under 'test'.
+* Documentation updates.
+
+== 0.0.1 - 20-Nov-2003
+* Initial release

data/MANIFEST

@@ -1,15 +1,17 @@
-* MANIFEST
-* README
-* CHANGES
-* Rakefile
-* win32-pipe.gemspec
-* examples/example_server.rb
-* examples/example_server_async.rb
-* examples/example_client.rb
-* examples/example_client_async.rb
-* lib/win32/pipe.rb
-* lib/win32/pipe/client.rb
-* lib/win32/pipe/server.rb
-* test/test_win32_pipe.rb
-* test/test_win32_pipe_client.rb
-* test/test_win32_pipe_server.rb
+* MANIFEST
+* README
+* CHANGES
+* Rakefile
+* win32-pipe.gemspec
+* examples/example_server.rb
+* examples/example_server_async.rb
+* examples/example_client.rb
+* examples/example_client_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
+* test/test_win32_pipe.rb
+* test/test_win32_pipe_client.rb
+* test/test_win32_pipe_server.rb

data/README

@@ -1,55 +1,52 @@
-== Description
-   A Ruby interface for named pipes on Windows.
-
-== Prerequisites
-* windows-pr 0.8.5 or later
-
-== Installation
-=== Gem Installation
-   gem install win32-pipe
-=== Local
-   rake install
-
-== Synopsis
-   require 'win32/pipe'
-   include Win32
-    
-   # In server.rb
-   pipe_server = Pipe::Server.new("foo_pipe")
-   pipe_server.connect
-   data = pipe_server.read
-   puts "Got #{data} from client"
-   pipe_server.close
-    
-   # In client.rb (run from a different shell)
-   pipe_client = Pipe::Client.new("foo_pipe")
-   pipe_client.write("Hello World")
-   pipe_client.close
-
-== What's a named pipe?
-   A pipe with a name - literally. In practice, it will feel more like a cross
-   between a socket and a pipe. At least, it does to me.
-
-== What good is it?
-   My hope is that it can be used in certain circumstances where a fork might
-   be desirable, but which is not possible on Windows. It could also be handy
-   for the traditional "piping data to a server" usage. And if you come up
-   with anything cool, please let us all know!
-
-== Future Plans
-   Add transactions
-
-== License
-   Artistic
-
-== Warranty
-   This package is provided "as is" and without any express or
-   implied warranties, including, without limitation, the implied
-   warranties of merchantability and fitness for a particular purpose.
-
-== Copyright
-   (C) 2003-2009, Daniel J. Berger, All Rights Reserved.
-
-== Authors
-   Daniel Berger
-   Park Heesob
+== Description
+  A Ruby interface for named pipes on Windows.
+
+== Prerequisites
+  ffi
+
+== Installation
+  gem install win32-pipe
+
+== Synopsis
+  require 'win32/pipe'
+  include Win32
+    
+  # In server.rb
+  pipe_server = Pipe::Server.new("foo_pipe")
+  pipe_server.connect
+  data = pipe_server.read
+  puts "Got #{data} from client"
+  pipe_server.close
+   
+  # In client.rb (run from a different shell)
+  pipe_client = Pipe::Client.new("foo_pipe")
+  pipe_client.write("Hello World")
+  pipe_client.close
+
+== What's a named pipe?
+  A pipe with a name - literally. In practice, it will feel more like a cross
+  between a socket and a pipe. At least, it does to me.
+
+== What good is it?
+  My hope is that it can be used in certain circumstances where a fork might
+  be desirable, but which is not possible on Windows. It could also be handy
+  for the traditional "piping data to a server" usage. And if you come up
+  with anything cool, please let us all know!
+
+== Future Plans
+  Add transactions
+
+== License
+  Artistic 2.0
+
+== Warranty
+  This package is provided "as is" and without any express or
+  implied warranties, including, without limitation, the implied
+  warranties of merchantability and fitness for a particular purpose.
+
+== Copyright
+  (C) 2003-2012, Daniel J. Berger, All Rights Reserved.
+
+== Authors
+  Daniel Berger
+  Park Heesob

data/Rakefile

@@ -1,48 +1,68 @@
-require 'rake'
-require 'rake/clean'
-require 'rake/testtask'
-
-CLEAN.include("**/*.gem")
-
-namespace :gem do
-  desc 'Create the win32-pipe gem'
-  task :create => [:clean] do
-    spec = eval(IO.read('win32-pipe.gemspec'))
-    Gem::Builder.new(spec).build
-  end
-
-  desc 'Install the win32-pipe gem'
-  task :install => [:create] do
-    file = Dir['*.gem'].first
-    sh "gem install #{file}"
-  end
-end
-
-namespace :example do
-  desc 'Run the asynchronous client example program'
-  task :async_client do
-    ruby '-Ilib examples/example_client_async.rb'
-  end
-
-  desc 'Run the client example program'
-  task :client do
-    ruby '-Ilib examples/example_client.rb'
-  end
-
-  desc 'Run the asynchronous server example program'
-  task :async_server do
-    ruby '-Ilib examples/example_server_async.rb'
-  end
-
-  desc 'Run the server example program'
-  task :server do
-    ruby '-Ilib examples/example_server.rb'
-  end
-end
-
-Rake::TestTask.new do |test|
-  test.warning = true
-  test.verbose = true
-end
-
-task :default => :test
+require 'rake'
+require 'rake/clean'
+require 'rake/testtask'
+
+CLEAN.include("**/*.gem")
+
+namespace :gem do
+  desc 'Create the win32-pipe gem'
+  task :create => [:clean] do
+    spec = eval(IO.read('win32-pipe.gemspec'))
+    Gem::Builder.new(spec).build
+  end
+
+  desc 'Install the win32-pipe gem'
+  task :install => [:create] do
+    file = Dir['*.gem'].first
+    sh "gem install #{file}"
+  end
+end
+
+namespace :example do
+  desc 'Run the asynchronous client example program'
+  task :async_client do
+    ruby '-Ilib examples/example_client_async.rb'
+  end
+
+  desc 'Run the client example program'
+  task :client do
+    ruby '-Ilib examples/example_client.rb'
+  end
+
+  desc 'Run the asynchronous server example program'
+  task :async_server do
+    ruby '-Ilib examples/example_server_async.rb'
+  end
+
+  desc 'Run the server example program'
+  task :server do
+    ruby '-Ilib examples/example_server.rb'
+  end
+end
+
+namespace :test do
+  Rake::TestTask.new(:base) do |test|
+    test.warning = true
+    test.verbose = true
+    test.test_files = FileList['test\test_win32_pipe.rb']
+  end
+
+  Rake::TestTask.new(:client) do |test|
+    test.warning = true
+    test.verbose = true
+    test.test_files = FileList['test\test_win32_pipe_client.rb']
+  end
+
+  Rake::TestTask.new(:server) do |test|
+    test.warning = true
+    test.verbose = true
+    test.test_files = FileList['test\test_win32_pipe_server.rb']
+  end
+
+  Rake::TestTask.new(:all) do |test|
+    test.warning = true
+    test.verbose = true
+  end
+end
+
+task :default => 'test:all'

data/examples/example_client.rb

@@ -1,30 +1,30 @@
-#########################################################################
-# example_client.rb
-#
-# Simple client test.  Be sure to start the server first in a separate
-# terminal. You can run this example via the 'rake example_client' task.
-#
-# Modify this code as you see fit.
-#########################################################################
-require 'win32/pipe'
-include Win32
-
-Thread.new { loop { sleep 0.01 } } # Allow Ctrl-C
-
-puts "VERSION: " + Pipe::VERSION
-
-# Block form
-Pipe::Client.new('foo') do |pipe|
-   puts "Connected..."
-   pipe.write("Ruby rocks!")
-   data = pipe.read
-   puts "Got [#{data}] back from server"
-end
-
-# Non-block form
-#pclient = Pipe::Client.new('foo')
-#puts "Connected..."
-#pclient.write("Ruby rocks!")
-#data = pclient.read
-#puts "Got [#{data}] back from server"
+#########################################################################
+# example_client.rb
+#
+# Simple client test.  Be sure to start the server first in a separate
+# terminal. You can run this example via the 'rake example_client' task.
+#
+# Modify this code as you see fit.
+#########################################################################
+require 'win32/pipe'
+include Win32
+
+Thread.new { loop { sleep 0.01 } } # Allow Ctrl-C
+
+puts "VERSION: " + Pipe::VERSION
+
+# Block form
+Pipe::Client.new('foo') do |pipe|
+   puts "Connected..."
+   pipe.write("Ruby rocks!")
+   data = pipe.read
+   puts "Got [#{data}] back from server"
+end
+
+# Non-block form
+#pclient = Pipe::Client.new('foo')
+#puts "Connected..."
+#pclient.write("Ruby rocks!")
+#data = pclient.read
+#puts "Got [#{data}] back from server"
 #pclient.close

data/examples/example_client_async.rb

@@ -1,82 +1,82 @@
-#########################################################################
-# example_client_async.rb
-#
-# Simple client test. Be sure to start the server first in a separate
-# terminal. You can run this example via the 'rake example_async_client'
-# task.
-#########################################################################
-require 'win32/pipe'
-include Win32
-
-puts "VERSION: " + Pipe::VERSION
-
-Thread.new { loop { sleep 0.01 } } # Allow Ctrl-C
-
-CONNECTING_STATE = 0
-READING_STATE    = 1
-WRITING_STATE    = 2
-
-class MyPipe < Pipe::Client
-   def read_complete
-      puts "read_complete"
-      puts "Got [#{buffer}] back from server"
-      @state = WRITING_STATE
-   end
-    
-   def write_complete
-      puts "write_complete"
-      @state = READING_STATE
-   end
- 
-   def mainloop
-      @state = WRITING_STATE
-      while true
-         if wait(1)          # wait for 1 second
-            if pending?      # IO is pending
-               case @state
-                  when READING_STATE
-                     if transferred == 0
-                        reconnect
-                        break
-                     end
-                     read_complete
-                     break
-                  when WRITING_STATE
-                     if transferred != length
-                        reconnect
-                        break
-                     end
-                     write_complete
-               end
-            end
-
-            case @state
-               when READING_STATE
-                  if read
-                     if not pending?
-                        read_complete
-                        break
-                     end
-                  end
-               when WRITING_STATE
-                  if write("Ruby rocks!")
-                     if not pending?
-                        write_complete
-                     end
-                  end
-            end
-         end
-	    
-         sleep(1)
-         puts "pipe client is running"
-      end    
-   end
-end
-
-flags = Pipe::DEFAULT_OPEN_MODE | Pipe::OVERLAPPED
-
-MyPipe.new('foo', nil, flags) do |client|
-   puts "Connected..."
-   client.mainloop
-end
-    
+#########################################################################
+# example_client_async.rb
+#
+# Simple client test. Be sure to start the server first in a separate
+# terminal. You can run this example via the 'rake example_async_client'
+# task.
+#########################################################################
+require 'win32/pipe'
+include Win32
+
+puts "VERSION: " + Pipe::VERSION
+
+Thread.new { loop { sleep 0.01 } } # Allow Ctrl-C
+
+CONNECTING_STATE = 0
+READING_STATE    = 1
+WRITING_STATE    = 2
+
+class MyPipe < Pipe::Client
+   def read_complete
+      puts "read_complete"
+      puts "Got [#{buffer}] back from server"
+      @state = WRITING_STATE
+   end
+    
+   def write_complete
+      puts "write_complete"
+      @state = READING_STATE
+   end
+ 
+   def mainloop
+      @state = WRITING_STATE
+      while true
+         if wait(1)          # wait for 1 second
+            if pending?      # IO is pending
+               case @state
+                  when READING_STATE
+                     if transferred == 0
+                        reconnect
+                        break
+                     end
+                     read_complete
+                     break
+                  when WRITING_STATE
+                     if transferred != length
+                        reconnect
+                        break
+                     end
+                     write_complete
+               end
+            end
+
+            case @state
+               when READING_STATE
+                  if read
+                     if not pending?
+                        read_complete
+                        break
+                     end
+                  end
+               when WRITING_STATE
+                  if write("Ruby rocks!")
+                     if not pending?
+                        write_complete
+                     end
+                  end
+            end
+         end
+	    
+         sleep(1)
+         puts "pipe client is running"
+      end    
+   end
+end
+
+flags = Pipe::DEFAULT_OPEN_MODE | Pipe::OVERLAPPED
+
+MyPipe.new('foo', nil, flags) do |client|
+   puts "Connected..."
+   client.mainloop
+end
+