win32-pipe 0.3.6 → 0.3.7

data/lib/win32/pipe/client.rb

@@ -1,65 +1,65 @@
-# The Win32 module serves as a namespace only
-module Win32
-
-  # The Pipe::Client class encapsulates the client side of a named pipe
-  # connection.
-  #
-  class Pipe::Client < Pipe
-
-    # Create and return a new Pipe::Client instance. The +name+, +pipe_mode+,
-    # and +open_mode+ are passed to the Win32::Pipe superclass.
-    #
-    # The default +pipe_mode+ is NOWAIT.
-    #
-    # The default +open_mode+ is FILE_ATTRIBUTE_NORMAL | FILE_FLAG_WRITE_THROUGH.
-    #
-    # In block form the client object is yield, and is automatically
-    # disconnected and closed at the end of the block.
-    #
-    # Example:
-    #
-    #   require 'win32/pipe'
-    #
-    #   Pipe::Client.new('foo') do |pipe|
-    #     puts "Connected..."
-    #     pipe.write("Ruby rocks!")
-    #     data = pipe.read
-    #     puts "Got [#{data}] back from pipe server"
-    #  end
-    #
-    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,
-        GENERIC_READ | GENERIC_WRITE,
-        FILE_SHARE_READ | FILE_SHARE_WRITE,
-        nil,
-        OPEN_EXISTING,
-        @open_mode,
-        0
-      )
-
-      error = FFI.errno
-
-      if error == ERROR_PIPE_BUSY
-        unless WaitNamedPipe(@name, NMPWAIT_WAIT_FOREVER)
-          raise SystemCallError.new("WaitNamedPipe", error)
-        end
-      end
-
-      if @pipe == INVALID_HANDLE_VALUE
-        raise SystemCallError.new("CreateFile", error)
-      end
-
-      if block_given?
-        begin
-          yield self
-        ensure
-          disconnect
-          close
-        end
-      end
-    end
-  end
-end
+# The Win32 module serves as a namespace only
+module Win32
+
+  # The Pipe::Client class encapsulates the client side of a named pipe
+  # connection.
+  #
+  class Pipe::Client < Pipe
+
+    # Create and return a new Pipe::Client instance. The +name+, +pipe_mode+,
+    # and +open_mode+ are passed to the Win32::Pipe superclass.
+    #
+    # The default +pipe_mode+ is NOWAIT.
+    #
+    # The default +open_mode+ is FILE_ATTRIBUTE_NORMAL | FILE_FLAG_WRITE_THROUGH.
+    #
+    # In block form the client object is yield, and is automatically
+    # disconnected and closed at the end of the block.
+    #
+    # Example:
+    #
+    #   require 'win32/pipe'
+    #
+    #   Pipe::Client.new('foo') do |pipe|
+    #     puts "Connected..."
+    #     pipe.write("Ruby rocks!")
+    #     data = pipe.read
+    #     puts "Got [#{data}] back from pipe server"
+    #  end
+    #
+    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,
+        GENERIC_READ | GENERIC_WRITE,
+        FILE_SHARE_READ | FILE_SHARE_WRITE,
+        nil,
+        OPEN_EXISTING,
+        @open_mode,
+        0
+      )
+
+      error = FFI.errno
+
+      if error == ERROR_PIPE_BUSY
+        unless WaitNamedPipe(@name, NMPWAIT_WAIT_FOREVER)
+          raise SystemCallError.new("WaitNamedPipe", error)
+        end
+      end
+
+      if @pipe == INVALID_HANDLE_VALUE
+        raise SystemCallError.new("CreateFile", error)
+      end
+
+      if block_given?
+        begin
+          yield self
+        ensure
+          disconnect
+          close
+        end
+      end
+    end
+  end
+end

data/lib/win32/pipe/server.rb

@@ -1,96 +1,96 @@
-# The Win32 module serves as a namespace only.
-module Win32
-  # The Pipe::Server class encapsulates the server side of a named pipe
-  # connection.
-  class Pipe::Server < Pipe
-
-    # Creates and returns a new Pipe::Server instance, using +name+ as the
-    # name for the pipe. Note that this does not actually connect the pipe.
-    # Use Pipe::Server#connect for that.
-    #
-    # The default pipe_mode is PIPE_TYPE_BYTE | PIPE_READMODE_BYTE | PIPE_WAIT.
-    #
-    # The default open_mode is Pipe::ACCESS_DUPLEX.
-    #--
-    # The default pipe_mode also happens to be 0.
-    #
-    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_TIMEOUT,
-        nil
-      )
-
-      if @pipe == INVALID_HANDLE_VALUE
-        raise SystemCallError.new("CreateNamedPipe", FFI.errno)
-      end
-
-      if block_given?
-        begin
-          yield self
-        ensure
-          close
-        end
-      end
-    end
-
-    # Enables the named pipe server process to wait for a client process
-    # to connect to an instance of a named pipe. In other words, it puts
-    # the server in 'connection wait' status.
-    #
-    # In synchronous mode always returns true on success. In asynchronous
-    # mode returns true if there is pending IO, or false otherwise.
-    #
-    def connect
-      if @asynchronous
-        # An overlapped ConnectNamedPipe should return 0
-        if ConnectNamedPipe(@pipe, @overlapped)
-          raise SystemCallError.new("ConnectNamedPipe", FFI.errno)
-        end
-
-        error = GetLastError()
-
-        case error
-          when ERROR_IO_PENDING
-            @pending_io = true
-          when ERROR_PIPE_CONNECTED
-            unless SetEvent(@event)
-              raise Error, get_last_error(error)
-            end
-          when ERROR_PIPE_LISTENING, ERROR_SUCCESS
-            # Do nothing
-          else
-            raise Error, get_last_error(error)
-        end
-
-        if @pending_io
-          return false
-        else
-          return true
-        end
-      else
-        unless ConnectNamedPipe(@pipe, nil)
-          raise SystemCallError.new("ConnectNamedPipe", FFI.errno)
-        end
-      end
-
-      return true
-    end
-
-    # Close the server. This will flush file buffers, disconnect the
-    # pipe, and close the pipe handle.
-    #
-    def close
-      FlushFileBuffers(@pipe)
-      DisconnectNamedPipe(@pipe)
-      super
-    end
-  end
-end
+# The Win32 module serves as a namespace only.
+module Win32
+  # The Pipe::Server class encapsulates the server side of a named pipe
+  # connection.
+  class Pipe::Server < Pipe
+
+    # Creates and returns a new Pipe::Server instance, using +name+ as the
+    # name for the pipe. Note that this does not actually connect the pipe.
+    # Use Pipe::Server#connect for that.
+    #
+    # The default pipe_mode is PIPE_TYPE_BYTE | PIPE_READMODE_BYTE | PIPE_WAIT.
+    #
+    # The default open_mode is Pipe::ACCESS_DUPLEX.
+    #--
+    # The default pipe_mode also happens to be 0.
+    #
+    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_TIMEOUT,
+        nil
+      )
+
+      if @pipe == INVALID_HANDLE_VALUE
+        raise SystemCallError.new("CreateNamedPipe", FFI.errno)
+      end
+
+      if block_given?
+        begin
+          yield self
+        ensure
+          close
+        end
+      end
+    end
+
+    # Enables the named pipe server process to wait for a client process
+    # to connect to an instance of a named pipe. In other words, it puts
+    # the server in 'connection wait' status.
+    #
+    # In synchronous mode always returns true on success. In asynchronous
+    # mode returns true if there is pending IO, or false otherwise.
+    #
+    def connect
+      if @asynchronous
+        # An overlapped ConnectNamedPipe should return 0
+        if ConnectNamedPipe(@pipe, @overlapped)
+          raise SystemCallError.new("ConnectNamedPipe", FFI.errno)
+        end
+
+        error = GetLastError()
+
+        case error
+          when ERROR_IO_PENDING
+            @pending_io = true
+          when ERROR_PIPE_CONNECTED
+            unless SetEvent(@event)
+              raise Error, get_last_error(error)
+            end
+          when ERROR_PIPE_LISTENING, ERROR_SUCCESS
+            # Do nothing
+          else
+            raise Error, get_last_error(error)
+        end
+
+        if @pending_io
+          return false
+        else
+          return true
+        end
+      else
+        unless ConnectNamedPipe(@pipe, nil)
+          raise SystemCallError.new("ConnectNamedPipe", FFI.errno)
+        end
+      end
+
+      return true
+    end
+
+    # Close the server. This will flush file buffers, disconnect the
+    # pipe, and close the pipe handle.
+    #
+    def close
+      FlushFileBuffers(@pipe)
+      DisconnectNamedPipe(@pipe)
+      super
+    end
+  end
+end

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

@@ -1,46 +1,46 @@
-require 'ffi'
-
-module Windows
-  module Constants
-    include FFI::Library
-
-    PIPE_WAIT             = 0x00000000
-    PIPE_NOWAIT           = 0x00000001
-    PIPE_ACCESS_INBOUND   = 0x00000001
-    PIPE_ACCESS_OUTBOUND  = 0x00000002
-    PIPE_ACCESS_DUPLEX    = 0x00000003
-    PIPE_TYPE_BYTE        = 0x00000000
-    PIPE_TYPE_MESSAGE     = 0x00000004
-    PIPE_READMODE_BYTE    = 0x00000000
-    PIPE_READMODE_MESSAGE = 0x00000002
-    PIPE_CLIENT_END       = 0x00000000
-    PIPE_SERVER_END       = 0x00000001
-
-    PIPE_UNLIMITED_INSTANCES = 255
-
-    FILE_FLAG_OVERLAPPED = 0x40000000
-    FILE_FLAG_FIRST_PIPE_INSTANCE = 0x00080000
-    FILE_FLAG_WRITE_THROUGH       = 0x80000000
-    FILE_ATTRIBUTE_NORMAL        = 0x00000080
-
-    INFINITE = 0xFFFFFFFF
-    NMPWAIT_WAIT_FOREVER = 0xFFFFFFFF
-
-    ERROR_PIPE_BUSY = 231
-    ERROR_IO_PENDING = 997
-    ERROR_PIPE_CONNECTED = 535
-    ERROR_PIPE_LISTENING = 536
-    ERROR_SUCCESS = 0
-
-    WAIT_TIMEOUT = 0x102
-    WAIT_OBJECT_0 = 0
-
-    GENERIC_READ  = 0x80000000
-    GENERIC_WRITE = 0x40000000
-    FILE_SHARE_READ  = 1
-    FILE_SHARE_WRITE = 2
-    OPEN_EXISTING    = 3
-
-    INVALID_HANDLE_VALUE = FFI::Pointer.new(-1).address
-  end
-end
+require 'ffi'
+
+module Windows
+  module Constants
+    include FFI::Library
+
+    PIPE_WAIT             = 0x00000000
+    PIPE_NOWAIT           = 0x00000001
+    PIPE_ACCESS_INBOUND   = 0x00000001
+    PIPE_ACCESS_OUTBOUND  = 0x00000002
+    PIPE_ACCESS_DUPLEX    = 0x00000003
+    PIPE_TYPE_BYTE        = 0x00000000
+    PIPE_TYPE_MESSAGE     = 0x00000004
+    PIPE_READMODE_BYTE    = 0x00000000
+    PIPE_READMODE_MESSAGE = 0x00000002
+    PIPE_CLIENT_END       = 0x00000000
+    PIPE_SERVER_END       = 0x00000001
+
+    PIPE_UNLIMITED_INSTANCES = 255
+
+    FILE_FLAG_OVERLAPPED = 0x40000000
+    FILE_FLAG_FIRST_PIPE_INSTANCE = 0x00080000
+    FILE_FLAG_WRITE_THROUGH       = 0x80000000
+    FILE_ATTRIBUTE_NORMAL        = 0x00000080
+
+    INFINITE = 0xFFFFFFFF
+    NMPWAIT_WAIT_FOREVER = 0xFFFFFFFF
+
+    ERROR_PIPE_BUSY = 231
+    ERROR_IO_PENDING = 997
+    ERROR_PIPE_CONNECTED = 535
+    ERROR_PIPE_LISTENING = 536
+    ERROR_SUCCESS = 0
+
+    WAIT_TIMEOUT = 0x102
+    WAIT_OBJECT_0 = 0
+
+    GENERIC_READ  = 0x80000000
+    GENERIC_WRITE = 0x40000000
+    FILE_SHARE_READ  = 1
+    FILE_SHARE_WRITE = 2
+    OPEN_EXISTING    = 3
+
+    INVALID_HANDLE_VALUE = FFI::Pointer.new(-1).address
+  end
+end

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

@@ -1,37 +1,37 @@
-require 'ffi'
-
-module Windows
-  module Functions
-    extend FFI::Library
-
-    typedef :ulong, :dword
-    typedef :uintptr_t, :handle
-    typedef :pointer, :ptr
-    typedef :string, :str
-
-    ffi_lib :kernel32
-
-    module FFI::Library
-      # Wrapper method for attach_function + private
-      def attach_pfunc(*args)
-        attach_function(*args)
-        private args[0]
-      end
-    end
-
-    attach_pfunc :CloseHandle, [:handle], :bool
-    attach_pfunc :ConnectNamedPipe, [:handle, :ptr], :bool
-    attach_pfunc :CreateEvent, :CreateEventA, [:ptr, :bool, :bool, :str], :handle
-    attach_pfunc :CreateFile, :CreateFileA, [:str, :dword, :dword, :ptr, :dword, :dword, :handle], :handle
-    attach_pfunc :CreateNamedPipe, :CreateNamedPipeA, [:str, :dword, :dword, :dword, :dword, :dword, :dword, :ptr], :handle
-    attach_pfunc :CreatePipe, [:ptr, :ptr, :ptr, :dword], :bool
-    attach_pfunc :DisconnectNamedPipe, [:handle], :bool
-    attach_pfunc :FlushFileBuffers, [:handle], :bool
-    attach_pfunc :GetLastError, [], :dword
-    attach_pfunc :GetOverlappedResult, [:handle, :ptr, :ptr, :bool], :bool
-    attach_pfunc :ReadFile, [:handle, :buffer_out, :dword, :ptr, :ptr], :bool
-    attach_pfunc :WaitForSingleObject, [:handle, :dword], :dword
-    attach_pfunc :WaitNamedPipe, :WaitNamedPipeA, [:str, :dword], :bool
-    attach_pfunc :WriteFile, [:handle, :buffer_in, :dword, :ptr, :ptr], :bool
-  end
-end
+require 'ffi'
+
+module Windows
+  module Functions
+    extend FFI::Library
+
+    typedef :ulong, :dword
+    typedef :uintptr_t, :handle
+    typedef :pointer, :ptr
+    typedef :string, :str
+
+    ffi_lib :kernel32
+
+    module FFI::Library
+      # Wrapper method for attach_function + private
+      def attach_pfunc(*args)
+        attach_function(*args)
+        private args[0]
+      end
+    end
+
+    attach_pfunc :CloseHandle, [:handle], :bool
+    attach_pfunc :ConnectNamedPipe, [:handle, :ptr], :bool
+    attach_pfunc :CreateEvent, :CreateEventA, [:ptr, :int, :int, :str], :handle
+    attach_pfunc :CreateFile, :CreateFileA, [:str, :dword, :dword, :ptr, :dword, :dword, :handle], :handle
+    attach_pfunc :CreateNamedPipe, :CreateNamedPipeA, [:str, :dword, :dword, :dword, :dword, :dword, :dword, :ptr], :handle
+    attach_pfunc :CreatePipe, [:ptr, :ptr, :ptr, :dword], :bool
+    attach_pfunc :DisconnectNamedPipe, [:handle], :bool
+    attach_pfunc :FlushFileBuffers, [:handle], :bool
+    attach_pfunc :GetLastError, [], :dword
+    attach_pfunc :GetOverlappedResult, [:handle, :ptr, :ptr, :int], :bool
+    attach_pfunc :ReadFile, [:handle, :buffer_out, :dword, :ptr, :ptr], :bool
+    attach_pfunc :WaitForSingleObject, [:handle, :dword], :dword
+    attach_pfunc :WaitNamedPipe, :WaitNamedPipeA, [:str, :dword], :bool
+    attach_pfunc :WriteFile, [:handle, :buffer_in, :dword, :ptr, :ptr], :bool
+  end
+end