cosmos 3.0.1 → 3.1.0

data/lib/cosmos/io/udp_sockets.rb

@@ -1,152 +1,152 @@
-# encoding: ascii-8bit
-
-# Copyright 2014 Ball Aerospace & Technologies Corp.
-# All Rights Reserved.
-#
-# This program is free software; you can modify and/or redistribute it
-# under the terms of the GNU General Public License
-# as published by the Free Software Foundation; version 3 with
-# attribution addendums as found in the LICENSE.txt
-
-require 'socket'
-require 'ipaddr'
-require 'timeout' # for Timeout::Error
-
-# Define needed constants for Windows
-Socket::IP_MULTICAST_IF = 9 unless Socket.const_defined?('IP_MULTICAST_IF')
-Socket::IP_MULTICAST_TTL = 10 unless Socket.const_defined?('IP_MULTICAST_TTL')
-
-module Cosmos
-
-  # Creates a UDPSocket and implements a non-blocking write.
-  class UdpWriteSocket
-
-    # @param dest_address [String] Host to send data to
-    # @param dest_port [Integer] Port to send data to
-    # @param src_port [Integer[ Port to send data out from
-    # @param interface_address [String] Local outgoing interface to send from
-    # @param ttl [Integer] Time To Live for outgoing packets
-    def initialize(dest_address,
-                   dest_port,
-                   src_port = nil,
-                   interface_address = nil,
-                   ttl = 1,
-                   bind_address = "0.0.0.0")
-      @socket = UDPSocket.new
-
-      # Basic setup to reuse address
-      @socket.setsockopt(Socket::SOL_SOCKET, Socket::SO_REUSEADDR, 1)
-
-      # Set source port if given
-      @socket.bind(bind_address, src_port) if src_port
-
-      # Default send to the specified address and port
-      @socket.connect(dest_address, dest_port)
-
-      # Handle multicast
-      if UdpWriteSocket.multicast?(dest_address)
-        # Basic setup set time to live
-        @socket.setsockopt(Socket::IPPROTO_IP, Socket::IP_MULTICAST_TTL, ttl.to_i)
-
-        # Set outgoing interface
-        @socket.setsockopt(Socket::IPPROTO_IP, Socket::IP_MULTICAST_IF, IPAddr.new(interface_address).hton) if interface_address
-      end
-    end
-
-    # @param data [String] Binary data to send
-    # @param write_timeout [Float] Time in seconds to wait for the data to send
-    def write(data, write_timeout = 10.0)
-      num_bytes_to_send = data.length
-      total_bytes_sent  = 0
-      bytes_sent = 0
-      data_to_send = data
-
-      loop do
-        begin
-          bytes_sent = @socket.write_nonblock(data_to_send)
-        rescue Errno::EAGAIN, Errno::EWOULDBLOCK
-          result = IO.fast_select(nil, [@socket], nil, write_timeout)
-          if result
-            retry
-          else
-            raise Timeout::Error, "Write Timeout"
-          end
-        end
-        total_bytes_sent += bytes_sent
-        break if total_bytes_sent >= num_bytes_to_send
-        data_to_send = data[total_bytes_sent..-1]
-      end
-    end
-
-    # Defer all methods to the UDPSocket
-    def method_missing(method, *args, &block)
-      @socket.__send__(method, *args, &block)
-    end
-
-    # @param host [String] Machine name or IP address
-    # @return [Boolean] Whether the hostname is multicast
-    def self.multicast?(host)
-      return false if host.nil?
-      # Look up address
-      _, _, _, *address_list = Socket.gethostbyname(host)
-      first_addr_byte = 0
-      address_list.each do |address|
-        if address.length == 4
-          first_addr_byte = address.getbyte(0)
-          break
-        end
-      end
-
-      if (first_addr_byte >= 224) && (first_addr_byte <= 239)
-        true
-      else
-        false
-      end
-    end
-  end
-
-  # Creates a UDPSocket and implements a non-blocking read.
-  class UdpReadSocket
-
-    # @param recv_port [Integer] Port to receive data on
-    # @param multicast_address [String] Address to add multicast
-    def initialize(recv_port = 0, multicast_address = nil, interface_address = nil, bind_address = "0.0.0.0")
-      @socket = UDPSocket.new
-
-      # Basic setup to reuse address
-      @socket.setsockopt(Socket::SOL_SOCKET, Socket::SO_REUSEADDR, 1)
-
-      # bind to port
-      @socket.bind(bind_address, recv_port)
-
-      if UdpWriteSocket.multicast?(multicast_address)
-        interface_address = "0.0.0.0" unless interface_address
-        membership = IPAddr.new(multicast_address).hton + IPAddr.new(interface_address).hton
-        @socket.setsockopt(Socket::IPPROTO_IP, Socket::IP_ADD_MEMBERSHIP, membership)
-      end
-    end
-
-    # @param read_timeout [Float] Time in seconds to wait for the read to
-    #   complete
-    def read(read_timeout = nil)
-      data = nil
-      begin
-        data, _ = @socket.recvfrom_nonblock(65536)
-      rescue Errno::EAGAIN, Errno::EWOULDBLOCK
-        result = IO.fast_select([@socket], nil, nil, read_timeout)
-        if result
-          retry
-        else
-          raise Timeout::Error, "Read Timeout"
-        end
-      end
-      data
-    end
-
-    # Defer all methods to the UDPSocket
-    def method_missing(method, *args, &block)
-      @socket.__send__(method, *args, &block)
-    end
-  end
-
-end # module Cosmos
+# encoding: ascii-8bit
+
+# Copyright 2014 Ball Aerospace & Technologies Corp.
+# All Rights Reserved.
+#
+# This program is free software; you can modify and/or redistribute it
+# under the terms of the GNU General Public License
+# as published by the Free Software Foundation; version 3 with
+# attribution addendums as found in the LICENSE.txt
+
+require 'socket'
+require 'ipaddr'
+require 'timeout' # for Timeout::Error
+
+# Define needed constants for Windows
+Socket::IP_MULTICAST_IF = 9 unless Socket.const_defined?('IP_MULTICAST_IF')
+Socket::IP_MULTICAST_TTL = 10 unless Socket.const_defined?('IP_MULTICAST_TTL')
+
+module Cosmos
+
+  # Creates a UDPSocket and implements a non-blocking write.
+  class UdpWriteSocket
+
+    # @param dest_address [String] Host to send data to
+    # @param dest_port [Integer] Port to send data to
+    # @param src_port [Integer[ Port to send data out from
+    # @param interface_address [String] Local outgoing interface to send from
+    # @param ttl [Integer] Time To Live for outgoing packets
+    def initialize(dest_address,
+                   dest_port,
+                   src_port = nil,
+                   interface_address = nil,
+                   ttl = 1,
+                   bind_address = "0.0.0.0")
+      @socket = UDPSocket.new
+
+      # Basic setup to reuse address
+      @socket.setsockopt(Socket::SOL_SOCKET, Socket::SO_REUSEADDR, 1)
+
+      # Set source port if given
+      @socket.bind(bind_address, src_port) if src_port
+
+      # Default send to the specified address and port
+      @socket.connect(dest_address, dest_port)
+
+      # Handle multicast
+      if UdpWriteSocket.multicast?(dest_address)
+        # Basic setup set time to live
+        @socket.setsockopt(Socket::IPPROTO_IP, Socket::IP_MULTICAST_TTL, ttl.to_i)
+
+        # Set outgoing interface
+        @socket.setsockopt(Socket::IPPROTO_IP, Socket::IP_MULTICAST_IF, IPAddr.new(interface_address).hton) if interface_address
+      end
+    end
+
+    # @param data [String] Binary data to send
+    # @param write_timeout [Float] Time in seconds to wait for the data to send
+    def write(data, write_timeout = 10.0)
+      num_bytes_to_send = data.length
+      total_bytes_sent  = 0
+      bytes_sent = 0
+      data_to_send = data
+
+      loop do
+        begin
+          bytes_sent = @socket.write_nonblock(data_to_send)
+        rescue Errno::EAGAIN, Errno::EWOULDBLOCK
+          result = IO.fast_select(nil, [@socket], nil, write_timeout)
+          if result
+            retry
+          else
+            raise Timeout::Error, "Write Timeout"
+          end
+        end
+        total_bytes_sent += bytes_sent
+        break if total_bytes_sent >= num_bytes_to_send
+        data_to_send = data[total_bytes_sent..-1]
+      end
+    end
+
+    # Defer all methods to the UDPSocket
+    def method_missing(method, *args, &block)
+      @socket.__send__(method, *args, &block)
+    end
+
+    # @param host [String] Machine name or IP address
+    # @return [Boolean] Whether the hostname is multicast
+    def self.multicast?(host)
+      return false if host.nil?
+      # Look up address
+      _, _, _, *address_list = Socket.gethostbyname(host)
+      first_addr_byte = 0
+      address_list.each do |address|
+        if address.length == 4
+          first_addr_byte = address.getbyte(0)
+          break
+        end
+      end
+
+      if (first_addr_byte >= 224) && (first_addr_byte <= 239)
+        true
+      else
+        false
+      end
+    end
+  end
+
+  # Creates a UDPSocket and implements a non-blocking read.
+  class UdpReadSocket
+
+    # @param recv_port [Integer] Port to receive data on
+    # @param multicast_address [String] Address to add multicast
+    def initialize(recv_port = 0, multicast_address = nil, interface_address = nil, bind_address = "0.0.0.0")
+      @socket = UDPSocket.new
+
+      # Basic setup to reuse address
+      @socket.setsockopt(Socket::SOL_SOCKET, Socket::SO_REUSEADDR, 1)
+
+      # bind to port
+      @socket.bind(bind_address, recv_port)
+
+      if UdpWriteSocket.multicast?(multicast_address)
+        interface_address = "0.0.0.0" unless interface_address
+        membership = IPAddr.new(multicast_address).hton + IPAddr.new(interface_address).hton
+        @socket.setsockopt(Socket::IPPROTO_IP, Socket::IP_ADD_MEMBERSHIP, membership)
+      end
+    end
+
+    # @param read_timeout [Float] Time in seconds to wait for the read to
+    #   complete
+    def read(read_timeout = nil)
+      data = nil
+      begin
+        data, _ = @socket.recvfrom_nonblock(65536)
+      rescue Errno::EAGAIN, Errno::EWOULDBLOCK
+        result = IO.fast_select([@socket], nil, nil, read_timeout)
+        if result
+          retry
+        else
+          raise Timeout::Error, "Read Timeout"
+        end
+      end
+      data
+    end
+
+    # Defer all methods to the UDPSocket
+    def method_missing(method, *args, &block)
+      @socket.__send__(method, *args, &block)
+    end
+  end
+
+end # module Cosmos

data/lib/cosmos/io/win32_serial_driver.rb

@@ -1,147 +1,147 @@
-# encoding: ascii-8bit
-
-# Copyright 2014 Ball Aerospace & Technologies Corp.
-# All Rights Reserved.
-#
-# This program is free software; you can modify and/or redistribute it
-# under the terms of the GNU General Public License
-# as published by the Free Software Foundation; version 3 with
-# attribution addendums as found in the LICENSE.txt
-
-require 'cosmos/win32/win32'
-require 'timeout' # For Timeout::Error
-
-module Cosmos
-
-  # Serial driver for use on Windows serial ports
-  class Win32SerialDriver
-
-    # (see SerialDriver#initialize)
-    def initialize(port_name = 'COM1',
-                   baud_rate = 9600,
-                   parity = :NONE,
-                   stop_bits = 1,
-                   write_timeout = 10.0,
-                   read_timeout = nil,
-                   read_polling_period = 0.01,
-                   read_max_length = 1000)
-
-      # Verify Parameters
-      port_name = '\\\\.\\' + port_name if port_name =~ /^COM[0-9]{2,3}$/
-
-      raise(ArgumentError, "Invalid baud rate: #{baud_rate}") unless Win32::BAUD_RATES.include?(baud_rate)
-
-      raise(ArgumentError, "Invalid parity: #{parity}") if parity and !SerialDriver::VALID_PARITY.include?(parity)
-      case parity
-      when SerialDriver::ODD
-        parity = Win32::ODDPARITY
-      when SerialDriver::EVEN
-        parity = Win32::EVENPARITY
-      when SerialDriver::NONE
-        parity = Win32::NOPARITY
-      end
-
-      raise(ArgumentError, "Invalid stop bits: #{stop_bits}") unless [1,2].include?(stop_bits)
-      if stop_bits == 1
-        stop_bits = Win32::ONESTOPBIT
-      else
-        stop_bits = Win32::TWOSTOPBITS
-      end
-
-      @write_timeout = write_timeout
-      @read_timeout = read_timeout
-      @read_polling_period = read_polling_period
-      @read_max_length = read_max_length
-
-      # Open the Comm Port
-      @handle = Win32.create_file(port_name,
-                                  Win32::GENERIC_READ | Win32::GENERIC_WRITE,
-                                  0,
-                                  Win32::NULL,
-                                  Win32::OPEN_EXISTING,
-                                  Win32::FILE_ATTRIBUTE_NORMAL)
-
-      # Configure the Comm Port
-      dcb = Win32.get_comm_state(@handle)
-      dcb.write('BaudRate', baud_rate)
-      dcb.write('ByteSize', 8)
-      dcb.write('Parity',   parity)
-      dcb.write('StopBits', stop_bits)
-      Win32.set_comm_state(@handle, dcb)
-
-      # Configure Timeouts
-      Win32.set_comm_timeouts(@handle, 4294967295, 0, 0, 0, 0)
-    end
-
-    # (see SerialDriver#close)
-    def close
-      if @handle
-        # Close the Comm Port
-        Win32.close_handle(@handle)
-        @handle = nil
-      end
-    end
-
-    # (see SerialDriver#closed?)
-    def closed?
-      if @handle
-        false
-      else
-        true
-      end
-    end
-
-    # (see SerialDriver#write)
-    def write(data)
-      # Write the data
-      time = Time.now
-      bytes_to_write = data.length
-      while (bytes_to_write > 0)
-        bytes_written = Win32.write_file(@handle, data, data.length)
-        raise "Error writing to comm port" if bytes_written <= 0
-        bytes_to_write -= bytes_written
-        data = data[bytes_written..-1]
-        raise Timeout::Error, "Write Timeout" if @write_timeout and (Time.now - time > @write_timeout) and bytes_to_write > 0
-      end
-    end
-
-    # (see SerialDriver#read)
-    def read
-      data = ''
-      sleep_time = 0.0
-
-      loop do
-        loop do
-          # Read 1 byte
-          buffer = Win32.read_file(@handle, 1)
-          data << buffer
-          break if buffer.length <= 0 or data.length >= @read_max_length
-        end
-        break if data.length > 0
-        if @read_timeout and sleep_time >= @read_timeout
-          raise Timeout::Error, "Read Timeout"
-        end
-        sleep(@read_polling_period)
-        sleep_time += @read_polling_period
-      end
-
-      data
-    end
-
-    # (see SerialDriver#read_nonblock)
-    def read_nonblock
-      data = ''
-
-      loop do
-        # Read 1 byte
-        buffer = Win32.read_file(@handle, 1)
-        data << buffer
-        break if buffer.length <= 0 or data.length >= @read_max_length
-      end
-
-      data
-    end
-
-  end # class Win32SerialDriver
-
-end # module Cosmos
+# encoding: ascii-8bit
+
+# Copyright 2014 Ball Aerospace & Technologies Corp.
+# All Rights Reserved.
+#
+# This program is free software; you can modify and/or redistribute it
+# under the terms of the GNU General Public License
+# as published by the Free Software Foundation; version 3 with
+# attribution addendums as found in the LICENSE.txt
+
+require 'cosmos/win32/win32'
+require 'timeout' # For Timeout::Error
+
+module Cosmos
+
+  # Serial driver for use on Windows serial ports
+  class Win32SerialDriver
+
+    # (see SerialDriver#initialize)
+    def initialize(port_name = 'COM1',
+                   baud_rate = 9600,
+                   parity = :NONE,
+                   stop_bits = 1,
+                   write_timeout = 10.0,
+                   read_timeout = nil,
+                   read_polling_period = 0.01,
+                   read_max_length = 1000)
+
+      # Verify Parameters
+      port_name = '\\\\.\\' + port_name if port_name =~ /^COM[0-9]{2,3}$/
+
+      raise(ArgumentError, "Invalid baud rate: #{baud_rate}") unless Win32::BAUD_RATES.include?(baud_rate)
+
+      raise(ArgumentError, "Invalid parity: #{parity}") if parity and !SerialDriver::VALID_PARITY.include?(parity)
+      case parity
+      when SerialDriver::ODD
+        parity = Win32::ODDPARITY
+      when SerialDriver::EVEN
+        parity = Win32::EVENPARITY
+      when SerialDriver::NONE
+        parity = Win32::NOPARITY
+      end
+
+      raise(ArgumentError, "Invalid stop bits: #{stop_bits}") unless [1,2].include?(stop_bits)
+      if stop_bits == 1
+        stop_bits = Win32::ONESTOPBIT
+      else
+        stop_bits = Win32::TWOSTOPBITS
+      end
+
+      @write_timeout = write_timeout
+      @read_timeout = read_timeout
+      @read_polling_period = read_polling_period
+      @read_max_length = read_max_length
+
+      # Open the Comm Port
+      @handle = Win32.create_file(port_name,
+                                  Win32::GENERIC_READ | Win32::GENERIC_WRITE,
+                                  0,
+                                  Win32::NULL,
+                                  Win32::OPEN_EXISTING,
+                                  Win32::FILE_ATTRIBUTE_NORMAL)
+
+      # Configure the Comm Port
+      dcb = Win32.get_comm_state(@handle)
+      dcb.write('BaudRate', baud_rate)
+      dcb.write('ByteSize', 8)
+      dcb.write('Parity',   parity)
+      dcb.write('StopBits', stop_bits)
+      Win32.set_comm_state(@handle, dcb)
+
+      # Configure Timeouts
+      Win32.set_comm_timeouts(@handle, 4294967295, 0, 0, 0, 0)
+    end
+
+    # (see SerialDriver#close)
+    def close
+      if @handle
+        # Close the Comm Port
+        Win32.close_handle(@handle)
+        @handle = nil
+      end
+    end
+
+    # (see SerialDriver#closed?)
+    def closed?
+      if @handle
+        false
+      else
+        true
+      end
+    end
+
+    # (see SerialDriver#write)
+    def write(data)
+      # Write the data
+      time = Time.now
+      bytes_to_write = data.length
+      while (bytes_to_write > 0)
+        bytes_written = Win32.write_file(@handle, data, data.length)
+        raise "Error writing to comm port" if bytes_written <= 0
+        bytes_to_write -= bytes_written
+        data = data[bytes_written..-1]
+        raise Timeout::Error, "Write Timeout" if @write_timeout and (Time.now - time > @write_timeout) and bytes_to_write > 0
+      end
+    end
+
+    # (see SerialDriver#read)
+    def read
+      data = ''
+      sleep_time = 0.0
+
+      loop do
+        loop do
+          # Read 1 byte
+          buffer = Win32.read_file(@handle, 1)
+          data << buffer
+          break if buffer.length <= 0 or data.length >= @read_max_length
+        end
+        break if data.length > 0
+        if @read_timeout and sleep_time >= @read_timeout
+          raise Timeout::Error, "Read Timeout"
+        end
+        sleep(@read_polling_period)
+        sleep_time += @read_polling_period
+      end
+
+      data
+    end
+
+    # (see SerialDriver#read_nonblock)
+    def read_nonblock
+      data = ''
+
+      loop do
+        # Read 1 byte
+        buffer = Win32.read_file(@handle, 1)
+        data << buffer
+        break if buffer.length <= 0 or data.length >= @read_max_length
+      end
+
+      data
+    end
+
+  end # class Win32SerialDriver
+
+end # module Cosmos