ionian 0.6.4 → 0.6.5

data/lib/ionian/extension/socket.rb

@@ -14,7 +14,7 @@ module Ionian
     module Socket
       
       # Called automaticallly when the object is extended with #extend.
-      def self.extended(obj)
+      def self.extended obj
         obj.extend Ionian::Extension::IO
         obj.initialize_ionian_socket
       end
@@ -24,6 +24,44 @@ module Ionian
       def initialize_ionian_socket
       end
       
+      # Returns true if sending broadcast datagrams is permitted.
+      # ( SO_BROADCAST )
+      def broadcast
+        param = self.getsockopt(::Socket::SOL_SOCKET, ::Socket::SO_BROADCAST)
+          .data.unpack('i').first
+        param > 0 ? true : false
+      end
+      
+      # Permit sending broadcast datagrams if true.
+      # ( SO_BROADCAST )
+      def broadcast= value
+        param = value ? 1 : 0
+        self.setsockopt ::Socket::SOL_SOCKET, ::Socket::SO_BROADCAST, [param].pack('i')
+      end
+      
+      alias_method :broadcast?, :broadcast
+      
+      # For connection-oriented protocols, prevent #close from returning
+      # immediately and try to deliver any data in the send buffer if value
+      # is true.
+      # ( SO_LINGER )
+      def linger
+        param = self.getsockopt(::Socket::SOL_SOCKET, ::Socket::SO_LINGER)
+          .data.unpack('i').first
+        param > 0 ? true : false
+      end
+      
+      # For connection-oriented protocols, prevent #close from returning
+      # immediately and try to deliver any data in the send buffer if value
+      # is true.
+      # ( SO_LINGER )
+      def linger= value
+        param = value ? 1 : 0
+        self.setsockopt ::Socket::SOL_SOCKET, ::Socket::SO_LINGER, [param].pack('i')
+      end
+      
+      alias_method :linger?, :linger
+      
       # Returns true if local address reuse is allowed.
       # ( SO_REUSEADDR )
       def reuse_addr
@@ -36,7 +74,7 @@ module Ionian
       
       # Allows local address reuse if true.
       # ( SO_REUSEADDR )
-      def reuse_addr=(value)
+      def reuse_addr= value
         param = value ? 1 : 0
         self.setsockopt ::Socket::SOL_SOCKET, ::Socket::SO_REUSEADDR, [param].pack('i')
       end
@@ -52,7 +90,7 @@ module Ionian
       
       # Sets the time to live (hop limit).
       # ( IP_TTL )
-      def ttl=(value)
+      def ttl= value
         self.setsockopt ::Socket::IPPROTO_IP, ::Socket::IP_TTL, [value].pack('i')
       end
       
@@ -68,7 +106,7 @@ module Ionian
       
       # Disables the Nagle algorithm if true.
       # ( TCP_NODELAY )
-      def no_delay=(value)
+      def no_delay= value
         param = value ? 1 : 0
         self.setsockopt ::Socket::IPPROTO_TCP, ::Socket::TCP_NODELAY, [param].pack('i')
       end
@@ -93,7 +131,7 @@ module Ionian
       # See #recork.
       # Linux only.
       # ( TCP_CORK )
-      def cork=(value)
+      def cork= value
         param = value ? 1 : 0
         self.setsockopt ::Socket::IPPROTO_TCP, ::Socket::TCP_CORK, [param].pack('i')
       end
@@ -111,7 +149,7 @@ module Ionian
       # Interface is the local network interface to receive the
       # multicast traffic on (all interfaces if not specified).
       # ( IP_ADD_MEMBERSHIP )
-     def ip_add_membership(address = nil, interface = nil)
+     def ip_add_membership address = nil, interface = nil
         address   ||= self.remote_address.ip_address
         interface ||= '0.0.0.0'
         
@@ -127,7 +165,7 @@ module Ionian
       # Interface is the local network interface the multicast
       # traffic is received on (all interfaces if not specified).
       # ( IP_DROP_MEMBERSHIP )
-      def ip_drop_membership(address = nil, interface = nil)
+      def ip_drop_membership address = nil, interface = nil
         address   ||= self.remote_address.ip_address
         interface ||= '0.0.0.0'
         
@@ -146,7 +184,7 @@ module Ionian
       
       # Specify default interface for outgoing multicasts.
       # ( IP_MULTICAST_IF )
-      def ip_multicast_if=(interface = nil)
+      def ip_multicast_if= interface = nil
         interface ||= '0.0.0.0'
         
         self.setsockopt \
@@ -164,7 +202,7 @@ module Ionian
       
       # Set the time to live (hop limit) for outgoing multicasts.
       # ( IP_MULTICAST_TTL )
-      def ip_multicast_ttl=(value)
+      def ip_multicast_ttl= value
         self.setsockopt ::Socket::IPPROTO_IP, ::Socket::IP_MULTICAST_TTL, [value].pack('C')
       end
       
@@ -180,7 +218,7 @@ module Ionian
       
       # Enables loopback of outgoing multicasts if true.
       # ( IP_MULTICAST_LOOP )
-      def ip_multicast_loop=(value)
+      def ip_multicast_loop= value
         param = value ? 1 : 0
         self.setsockopt ::Socket::IPPROTO_IP, ::Socket::IP_MULTICAST_LOOP, [param].pack('C')
       end
@@ -204,7 +242,7 @@ module Ionian
       end
       
       # Not yet implemented.
-      def ipv6_multicast_if=(value)
+      def ipv6_multicast_if= value
         # TODO: Implement
       end
       
@@ -215,7 +253,7 @@ module Ionian
       end
       
       # Not yet implemented.
-      def ipv6_multicast_hops=(value)
+      def ipv6_multicast_hops= value
         # TODO: Implement
       end
       
@@ -228,14 +266,14 @@ module Ionian
       alias_method :ipv6_multicast_loop?, :ipv6_multicast_loop
       
       # Not yet implemented.
-      def ipv6_multicast_loop=(value)
+      def ipv6_multicast_loop= value
         # TODO: Implement
       end
       
       
       class << self
         # Returns true if the given address is within the multicast range.
-        def multicast(address)
+        def multicast address
           address >= '224.0.0.0' and address <= '239.255.255.255' ? true : false
         end
         

data/lib/ionian/socket.rb

@@ -5,6 +5,15 @@ module Ionian
   # A convenient wrapper for TCP, UDP, and Unix client sockets.
   class Socket
     
+    # IP address or URL of server.
+    attr_reader :host
+    
+    # Remote port number.
+    attr_reader :port
+    
+    # Local port number.
+    attr_reader :bind_port
+    
     # Creates a new socket or wraps an existing socket.
     # 
     # Args:
@@ -22,7 +31,7 @@ module Ionian
     #   cork:       Set true to enable the TCP_CORK flag. Buffers multiple writes
     #               into one segment.
     #   expression: Overrides the #read_match regular expression for received data.
-    def initialize(existing_socket = nil, **kwargs)
+    def initialize existing_socket = nil, **kwargs
       @socket = existing_socket
       
       @ionian_listeners = []
@@ -55,16 +64,17 @@ module Ionian
         @socket.expression = @expression if @expression
         
         initialize_socket_methods
+        
       else
         # Initialize new socket.
         
-        # TODO: Should be able to parse the port out of host.
-        #       :port should override this parsed value.
+        # Parse host out of "host:port" if specified.
+        host_port_ary   = kwargs.fetch(:host).to_s.split ':'
         
-        @host           = kwargs.fetch :host
-        @port           = kwargs.fetch :port,       23
+        @host           = host_port_ary[0]
+        @port           = kwargs.fetch :port, host_port_ary[1].to_i || 23
         @bind_port      = kwargs.fetch :bind_port,  @port
-      
+        
         # Automatically select UDP for the multicast range. Otherwise default to TCP.
         default_protocol = :tcp
         default_protocol = :udp  if Ionian::Extension::Socket.multicast? @host
@@ -94,7 +104,7 @@ module Ionian
     end
     
     # Set the regular expression used to match incoming data.
-    def expression=(exp)
+    def expression= exp
       @expression = exp
       @socket.expression = exp if @socket
     end
@@ -108,7 +118,7 @@ module Ionian
     # Returns an array of received matches.
     # Block yields received match.
     # See Ionian::Extension::IO#read_match.
-    def cmd(string, **kwargs, &block)
+    def cmd string, **kwargs, &block
       create_socket unless @persistent
       
       if @protocol == :udp
@@ -119,7 +129,7 @@ module Ionian
       
       @socket.flush
       
-      matches = @socket.read_match(kwargs) {|match| yield match if block_given?}
+      matches = @socket.read_match(kwargs) { |match| yield match if block_given? }
       @socket.close unless @persistent
       
       matches
@@ -138,8 +148,8 @@ module Ionian
     alias_method :on_match, :register_observer
     
     # Unregister a block from being called when matched data is received.
-    def unregister_observer(&block)
-      @ionian_listeners.delete_if {|o| o == block}
+    def unregister_observer &block
+      @ionian_listeners.delete_if { |o| o == block }
       @socket.unregister_observer &block if @socket
       block
     end
@@ -150,7 +160,7 @@ module Ionian
     # Args:
     #   Timeout: Number of seconds to wait for data until
     #     giving up. Set to nil for blocking.
-    def has_data?(**kwargs)
+    def has_data? **kwargs
       return false unless @socket
       @socket.has_data? kwargs
     end
@@ -169,13 +179,13 @@ module Ionian
     
     # Writes the given string(s) to the socket and appends a
     # newline character to any string not already ending with one.
-    def puts(*string)
-      self.write string.map{|s| s.chomp}.join("\n") + "\n"
+    def puts *string
+      self.write string.map{ |s| s.chomp }.join("\n") + "\n"
     end
     
     # Writes the given string to the socket. Returns the number of
     # bytes written.
-    def write(string)
+    def write string
       create_socket unless @persistent
       
       num_bytes = 0
@@ -255,8 +265,8 @@ module Ionian
       # This was chosen over method_missing to avoid traversing the object
       # hierarchy on every method call, like transmitting data.
       @socket.methods
-        .select {|m| @socket.respond_to? m}
-        .select {|m| not self.respond_to? m}
+        .select { |m| @socket.respond_to? m }
+        .select { |m| not self.respond_to? m }
         .each do |m|
           self.singleton_class.send :define_method, m do |*args, &block|
             @socket.__send__ m, *args, &block

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ionian
 version: !ruby/object:Gem::Version
-  version: 0.6.4
+  version: 0.6.5
 platform: ruby
 authors:
 - Alex McLain
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-15 00:00:00.000000000 Z
+date: 2014-04-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake