ionian 0.6.5 → 0.6.6

data/doc/method_list.html

@@ -72,14 +72,14 @@
   
 
   <li class="r1 ">
-    <span class='object_link'><a href="Ionian/Socket.html#closed%3F-instance_method" title="Ionian::Socket#closed? (method)">#closed?</a></span>
-    <small>Ionian::Socket</small>
+    <span class='object_link'><a href="Ionian/Server.html#closed%3F-instance_method" title="Ionian::Server#closed? (method)">#closed?</a></span>
+    <small>Ionian::Server</small>
   </li>
   
 
   <li class="r2 ">
-    <span class='object_link'><a href="Ionian/Server.html#closed%3F-instance_method" title="Ionian::Server#closed? (method)">#closed?</a></span>
-    <small>Ionian::Server</small>
+    <span class='object_link'><a href="Ionian/Socket.html#closed%3F-instance_method" title="Ionian::Socket#closed? (method)">#closed?</a></span>
+    <small>Ionian::Socket</small>
   </li>
   
 
@@ -144,14 +144,14 @@
   
 
   <li class="r1 ">
-    <span class='object_link'><a href="Ionian/Extension/IO.html#has_data%3F-instance_method" title="Ionian::Extension::IO#has_data? (method)">#has_data?</a></span>
-    <small>Ionian::Extension::IO</small>
+    <span class='object_link'><a href="Ionian/Socket.html#has_data%3F-instance_method" title="Ionian::Socket#has_data? (method)">#has_data?</a></span>
+    <small>Ionian::Socket</small>
   </li>
   
 
   <li class="r2 ">
-    <span class='object_link'><a href="Ionian/Socket.html#has_data%3F-instance_method" title="Ionian::Socket#has_data? (method)">#has_data?</a></span>
-    <small>Ionian::Socket</small>
+    <span class='object_link'><a href="Ionian/Extension/IO.html#has_data%3F-instance_method" title="Ionian::Extension::IO#has_data? (method)">#has_data?</a></span>
+    <small>Ionian::Extension::IO</small>
   </li>
   
 
@@ -162,14 +162,14 @@
   
 
   <li class="r2 ">
-    <span class='object_link'><a href="Ionian/Server.html#initialize-instance_method" title="Ionian::Server#initialize (method)">#initialize</a></span>
-    <small>Ionian::Server</small>
+    <span class='object_link'><a href="Ionian/Socket.html#initialize-instance_method" title="Ionian::Socket#initialize (method)">#initialize</a></span>
+    <small>Ionian::Socket</small>
   </li>
   
 
   <li class="r1 ">
-    <span class='object_link'><a href="Ionian/Socket.html#initialize-instance_method" title="Ionian::Socket#initialize (method)">#initialize</a></span>
-    <small>Ionian::Socket</small>
+    <span class='object_link'><a href="Ionian/Server.html#initialize-instance_method" title="Ionian::Server#initialize (method)">#initialize</a></span>
+    <small>Ionian::Server</small>
   </li>
   
 
@@ -186,125 +186,137 @@
   
 
   <li class="r2 ">
+    <span class='object_link'><a href="Ionian/Server.html#interface-instance_method" title="Ionian::Server#interface (method)">#interface</a></span>
+    <small>Ionian::Server</small>
+  </li>
+  
+
+  <li class="r1 ">
     <span class='object_link'><a href="Ionian/Extension/IO.html#ionian_timeout-instance_method" title="Ionian::Extension::IO#ionian_timeout (method)">#ionian_timeout</a></span>
     <small>Ionian::Extension::IO</small>
   </li>
   
 
-  <li class="r1 ">
+  <li class="r2 ">
     <span class='object_link'><a href="Ionian/Extension/Socket.html#ip_add_membership-instance_method" title="Ionian::Extension::Socket#ip_add_membership (method)">#ip_add_membership</a></span>
     <small>Ionian::Extension::Socket</small>
   </li>
   
 
-  <li class="r2 ">
+  <li class="r1 ">
     <span class='object_link'><a href="Ionian/Extension/Socket.html#ip_drop_membership-instance_method" title="Ionian::Extension::Socket#ip_drop_membership (method)">#ip_drop_membership</a></span>
     <small>Ionian::Extension::Socket</small>
   </li>
   
 
-  <li class="r1 ">
+  <li class="r2 ">
     <span class='object_link'><a href="Ionian/Extension/Socket.html#ip_multicast_if-instance_method" title="Ionian::Extension::Socket#ip_multicast_if (method)">#ip_multicast_if</a></span>
     <small>Ionian::Extension::Socket</small>
   </li>
   
 
-  <li class="r2 ">
+  <li class="r1 ">
     <span class='object_link'><a href="Ionian/Extension/Socket.html#ip_multicast_if%3D-instance_method" title="Ionian::Extension::Socket#ip_multicast_if= (method)">#ip_multicast_if=</a></span>
     <small>Ionian::Extension::Socket</small>
   </li>
   
 
-  <li class="r1 ">
+  <li class="r2 ">
     <span class='object_link'><a href="Ionian/Extension/Socket.html#ip_multicast_loop-instance_method" title="Ionian::Extension::Socket#ip_multicast_loop (method)">#ip_multicast_loop</a></span>
     <small>Ionian::Extension::Socket</small>
   </li>
   
 
-  <li class="r2 ">
+  <li class="r1 ">
     <span class='object_link'><a href="Ionian/Extension/Socket.html#ip_multicast_loop%3D-instance_method" title="Ionian::Extension::Socket#ip_multicast_loop= (method)">#ip_multicast_loop=</a></span>
     <small>Ionian::Extension::Socket</small>
   </li>
   
 
-  <li class="r1 ">
+  <li class="r2 ">
     <span class='object_link'><a href="Ionian/Extension/Socket.html#ip_multicast_ttl-instance_method" title="Ionian::Extension::Socket#ip_multicast_ttl (method)">#ip_multicast_ttl</a></span>
     <small>Ionian::Extension::Socket</small>
   </li>
   
 
-  <li class="r2 ">
+  <li class="r1 ">
     <span class='object_link'><a href="Ionian/Extension/Socket.html#ip_multicast_ttl%3D-instance_method" title="Ionian::Extension::Socket#ip_multicast_ttl= (method)">#ip_multicast_ttl=</a></span>
     <small>Ionian::Extension::Socket</small>
   </li>
   
 
-  <li class="r1 ">
+  <li class="r2 ">
     <span class='object_link'><a href="Ionian/Extension/Socket.html#ipv6_add_membership-instance_method" title="Ionian::Extension::Socket#ipv6_add_membership (method)">#ipv6_add_membership</a></span>
     <small>Ionian::Extension::Socket</small>
   </li>
   
 
-  <li class="r2 ">
+  <li class="r1 ">
     <span class='object_link'><a href="Ionian/Extension/Socket.html#ipv6_drop_membership-instance_method" title="Ionian::Extension::Socket#ipv6_drop_membership (method)">#ipv6_drop_membership</a></span>
     <small>Ionian::Extension::Socket</small>
   </li>
   
 
-  <li class="r1 ">
+  <li class="r2 ">
     <span class='object_link'><a href="Ionian/Extension/Socket.html#ipv6_multicast_hops-instance_method" title="Ionian::Extension::Socket#ipv6_multicast_hops (method)">#ipv6_multicast_hops</a></span>
     <small>Ionian::Extension::Socket</small>
   </li>
   
 
-  <li class="r2 ">
+  <li class="r1 ">
     <span class='object_link'><a href="Ionian/Extension/Socket.html#ipv6_multicast_hops%3D-instance_method" title="Ionian::Extension::Socket#ipv6_multicast_hops= (method)">#ipv6_multicast_hops=</a></span>
     <small>Ionian::Extension::Socket</small>
   </li>
   
 
-  <li class="r1 ">
+  <li class="r2 ">
     <span class='object_link'><a href="Ionian/Extension/Socket.html#ipv6_multicast_if-instance_method" title="Ionian::Extension::Socket#ipv6_multicast_if (method)">#ipv6_multicast_if</a></span>
     <small>Ionian::Extension::Socket</small>
   </li>
   
 
-  <li class="r2 ">
+  <li class="r1 ">
     <span class='object_link'><a href="Ionian/Extension/Socket.html#ipv6_multicast_if%3D-instance_method" title="Ionian::Extension::Socket#ipv6_multicast_if= (method)">#ipv6_multicast_if=</a></span>
     <small>Ionian::Extension::Socket</small>
   </li>
   
 
-  <li class="r1 ">
+  <li class="r2 ">
     <span class='object_link'><a href="Ionian/Extension/Socket.html#ipv6_multicast_loop-instance_method" title="Ionian::Extension::Socket#ipv6_multicast_loop (method)">#ipv6_multicast_loop</a></span>
     <small>Ionian::Extension::Socket</small>
   </li>
   
 
-  <li class="r2 ">
+  <li class="r1 ">
     <span class='object_link'><a href="Ionian/Extension/Socket.html#ipv6_multicast_loop%3D-instance_method" title="Ionian::Extension::Socket#ipv6_multicast_loop= (method)">#ipv6_multicast_loop=</a></span>
     <small>Ionian::Extension::Socket</small>
   </li>
   
 
-  <li class="r1 ">
+  <li class="r2 ">
     <span class='object_link'><a href="Ionian/Extension/Socket.html#linger-instance_method" title="Ionian::Extension::Socket#linger (method)">#linger</a></span>
     <small>Ionian::Extension::Socket</small>
   </li>
   
 
-  <li class="r2 ">
+  <li class="r1 ">
     <span class='object_link'><a href="Ionian/Extension/Socket.html#linger%3D-instance_method" title="Ionian::Extension::Socket#linger= (method)">#linger=</a></span>
     <small>Ionian::Extension::Socket</small>
   </li>
   
 
-  <li class="r1 ">
+  <li class="r2 ">
     <span class='object_link'><a href="Ionian/Server.html#listen-instance_method" title="Ionian::Server#listen (method)">#listen</a></span>
     <small>Ionian::Server</small>
   </li>
   
 
+  <li class="r1 ">
+    <span class='object_link'><a href="Ionian/Extension/Socket.html#multicast-instance_method" title="Ionian::Extension::Socket#multicast (method)">#multicast</a></span>
+    <small>Ionian::Extension::Socket</small>
+  </li>
+  
+
   <li class="r2 ">
     <span class='object_link'><a href="Ionian/Extension/Socket.html#multicast-class_method" title="Ionian::Extension::Socket.multicast (method)">multicast</a></span>
     <small>Ionian::Extension::Socket</small>
@@ -312,38 +324,38 @@
   
 
   <li class="r1 ">
-    <span class='object_link'><a href="Ionian/Extension/Socket.html#multicast-instance_method" title="Ionian::Extension::Socket#multicast (method)">#multicast</a></span>
+    <span class='object_link'><a href="Ionian/Extension/Socket.html#multicast%3F-class_method" title="Ionian::Extension::Socket.multicast? (method)">multicast?</a></span>
     <small>Ionian::Extension::Socket</small>
   </li>
   
 
   <li class="r2 ">
-    <span class='object_link'><a href="Ionian/Extension/Socket.html#multicast%3F-class_method" title="Ionian::Extension::Socket.multicast? (method)">multicast?</a></span>
+    <span class='object_link'><a href="Ionian/Extension/Socket.html#no_delay-instance_method" title="Ionian::Extension::Socket#no_delay (method)">#no_delay</a></span>
     <small>Ionian::Extension::Socket</small>
   </li>
   
 
   <li class="r1 ">
-    <span class='object_link'><a href="Ionian/Extension/Socket.html#no_delay-instance_method" title="Ionian::Extension::Socket#no_delay (method)">#no_delay</a></span>
+    <span class='object_link'><a href="Ionian/Extension/Socket.html#no_delay%3D-instance_method" title="Ionian::Extension::Socket#no_delay= (method)">#no_delay=</a></span>
     <small>Ionian::Extension::Socket</small>
   </li>
   
 
   <li class="r2 ">
-    <span class='object_link'><a href="Ionian/Extension/Socket.html#no_delay%3D-instance_method" title="Ionian::Extension::Socket#no_delay= (method)">#no_delay=</a></span>
-    <small>Ionian::Extension::Socket</small>
+    <span class='object_link'><a href="Ionian/Socket.html#persistent%3F-instance_method" title="Ionian::Socket#persistent? (method)">#persistent?</a></span>
+    <small>Ionian::Socket</small>
   </li>
   
 
   <li class="r1 ">
-    <span class='object_link'><a href="Ionian/Socket.html#persistent%3F-instance_method" title="Ionian::Socket#persistent? (method)">#persistent?</a></span>
+    <span class='object_link'><a href="Ionian/Socket.html#port-instance_method" title="Ionian::Socket#port (method)">#port</a></span>
     <small>Ionian::Socket</small>
   </li>
   
 
   <li class="r2 ">
-    <span class='object_link'><a href="Ionian/Socket.html#port-instance_method" title="Ionian::Socket#port (method)">#port</a></span>
-    <small>Ionian::Socket</small>
+    <span class='object_link'><a href="Ionian/Server.html#port-instance_method" title="Ionian::Server#port (method)">#port</a></span>
+    <small>Ionian::Server</small>
   </li>
   
 
@@ -354,102 +366,108 @@
   
 
   <li class="r2 ">
+    <span class='object_link'><a href="Ionian/Server.html#protocol-instance_method" title="Ionian::Server#protocol (method)">#protocol</a></span>
+    <small>Ionian::Server</small>
+  </li>
+  
+
+  <li class="r1 ">
     <span class='object_link'><a href="Ionian/Extension/IO.html#purge-instance_method" title="Ionian::Extension::IO#purge (method)">#purge</a></span>
     <small>Ionian::Extension::IO</small>
   </li>
   
 
-  <li class="r1 ">
+  <li class="r2 ">
     <span class='object_link'><a href="Ionian/Socket.html#puts-instance_method" title="Ionian::Socket#puts (method)">#puts</a></span>
     <small>Ionian::Socket</small>
   </li>
   
 
-  <li class="r2 ">
+  <li class="r1 ">
     <span class='object_link'><a href="Ionian/Extension/IO.html#read_all-instance_method" title="Ionian::Extension::IO#read_all (method)">#read_all</a></span>
     <small>Ionian::Extension::IO</small>
   </li>
   
 
-  <li class="r1 ">
+  <li class="r2 ">
     <span class='object_link'><a href="Ionian/Extension/IO.html#read_match-instance_method" title="Ionian::Extension::IO#read_match (method)">#read_match</a></span>
     <small>Ionian::Extension::IO</small>
   </li>
   
 
-  <li class="r2 ">
+  <li class="r1 ">
     <span class='object_link'><a href="Ionian/Extension/Socket.html#recork-instance_method" title="Ionian::Extension::Socket#recork (method)">#recork</a></span>
     <small>Ionian::Extension::Socket</small>
   </li>
   
 
-  <li class="r1 ">
+  <li class="r2 ">
     <span class='object_link'><a href="Ionian/Server.html#register_accept_listener-instance_method" title="Ionian::Server#register_accept_listener (method)">#register_accept_listener</a></span>
     <small>Ionian::Server</small>
   </li>
   
 
-  <li class="r2 ">
+  <li class="r1 ">
     <span class='object_link'><a href="Ionian/Extension/IO.html#register_observer-instance_method" title="Ionian::Extension::IO#register_observer (method)">#register_observer</a></span>
     <small>Ionian::Extension::IO</small>
   </li>
   
 
-  <li class="r1 ">
+  <li class="r2 ">
     <span class='object_link'><a href="Ionian/Socket.html#register_observer-instance_method" title="Ionian::Socket#register_observer (method)">#register_observer</a></span>
     <small>Ionian::Socket</small>
   </li>
   
 
-  <li class="r2 ">
+  <li class="r1 ">
     <span class='object_link'><a href="Ionian/Extension/Socket.html#reuse_addr-instance_method" title="Ionian::Extension::Socket#reuse_addr (method)">#reuse_addr</a></span>
     <small>Ionian::Extension::Socket</small>
   </li>
   
 
-  <li class="r1 ">
+  <li class="r2 ">
     <span class='object_link'><a href="Ionian/Extension/Socket.html#reuse_addr%3D-instance_method" title="Ionian::Extension::Socket#reuse_addr= (method)">#reuse_addr=</a></span>
     <small>Ionian::Extension::Socket</small>
   </li>
   
 
-  <li class="r2 ">
+  <li class="r1 ">
     <span class='object_link'><a href="Ionian/Extension/IO.html#run_match-instance_method" title="Ionian::Extension::IO#run_match (method)">#run_match</a></span>
     <small>Ionian::Extension::IO</small>
   </li>
   
 
-  <li class="r1 ">
+  <li class="r2 ">
     <span class='object_link'><a href="Ionian/Extension/Socket.html#ttl-instance_method" title="Ionian::Extension::Socket#ttl (method)">#ttl</a></span>
     <small>Ionian::Extension::Socket</small>
   </li>
   
 
-  <li class="r2 ">
+  <li class="r1 ">
     <span class='object_link'><a href="Ionian/Extension/Socket.html#ttl%3D-instance_method" title="Ionian::Extension::Socket#ttl= (method)">#ttl=</a></span>
     <small>Ionian::Extension::Socket</small>
   </li>
   
 
-  <li class="r1 ">
+  <li class="r2 ">
     <span class='object_link'><a href="Ionian/Server.html#unregister_accept_listener-instance_method" title="Ionian::Server#unregister_accept_listener (method)">#unregister_accept_listener</a></span>
     <small>Ionian::Server</small>
   </li>
   
 
-  <li class="r2 ">
+  <li class="r1 ">
     <span class='object_link'><a href="Ionian/Socket.html#unregister_observer-instance_method" title="Ionian::Socket#unregister_observer (method)">#unregister_observer</a></span>
     <small>Ionian::Socket</small>
   </li>
   
 
-  <li class="r1 ">
+  <li class="r2 ">
     <span class='object_link'><a href="Ionian/Extension/IO.html#unregister_observer-instance_method" title="Ionian::Extension::IO#unregister_observer (method)">#unregister_observer</a></span>
     <small>Ionian::Extension::IO</small>
   </li>
   
 
-  <li class="r2 ">
+  <li class="r1 ">
     <span class='object_link'><a href="Ionian/Socket.html#write-instance_method" title="Ionian::Socket#write (method)">#write</a></span>
     <small>Ionian::Socket</small>
   </li>

data/doc/top-level-namespace.html

@@ -103,7 +103,7 @@
 </div>
 
     <div id="footer">
-  Generated on Fri Apr 11 21:18:17 2014 by
+  Generated on Sat Apr 12 13:24:31 2014 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.8.7.4 (ruby-2.1.1).
 </div>

data/lib/ionian/extension/io.rb

@@ -53,8 +53,11 @@ module Ionian
       
       # Read all data in the buffer.
       # An alternative to using #readpartial with a large length.
+      # Blocks until data is available.
       def read_all
-        data = ''
+        # Block until data has arrived.
+        data =  readpartial 0xFFFF
+        # If there is more data in the buffer, retrieve it nonblocking.
         data += readpartial 0xFFFF while has_data?
         data
       end

data/lib/ionian/server.rb

@@ -6,6 +6,18 @@ module Ionian
   # A convenient wrapper for TCP, UDP, and Unix server sockets.
   class Server
     
+    # Interface to listen for clients.
+    attr_reader :interface
+    
+    # Port number to listen for clients.
+    attr_reader :port
+    
+    # Returns a symbol of the type of protocol this socket uses:
+    # :tcp, :udp, :unix
+    attr_reader :protocol
+    alias_method :protocol?, :protocol
+    
+    
     # A convenient wrapper for TCP and Unix server sockets (UDP doesn't use
     # a server).
     #
@@ -13,6 +25,7 @@ module Ionian
     # Server opens listening socket on instantiation if this block is provided.
     # 
     # Args:
+    #   port:           Port number to listen for clients.
     #   interface:      The address of the network interface to bind to.
     #                   Defaults to all.
     #   protocol:       :tcp, :unix. Default is :tcp.
@@ -20,26 +33,45 @@ module Ionian
       @accept_listeners = []
       register_accept_listener &block if block_given?
       
-      @interface = kwargs.fetch :interface, ''
+      # @interface = kwargs.fetch :interface, nil
+      @interface = kwargs.fetch :interface, nil
       @port      = kwargs.fetch :port, nil
       
-      
       # Automatically select UDP for the multicast range. Otherwise default to TCP.
       default_protocol = :tcp
-      # TODO: This ivar may be incorrect for UDP -- bound interface is not destination.
-      default_protocol = :udp  if Ionian::Extension::Socket.multicast? @interface
-      default_protocol = :unix if @interface.start_with? '/'
+      
+      if @interface
+        # TODO: This ivar may be incorrect for UDP -- bound interface is not destination.
+        default_protocol = :udp  if Ionian::Extension::Socket.multicast? @interface
+        default_protocol = :unix if @interface.start_with? '/'
+      end
       
       @protocol  = kwargs.fetch :protocol, default_protocol
       
+      
       # TODO: Move this to #listen.
       case @protocol
       when :tcp
+        @interface ||= '0.0.0.0' # All interfaces.
+        
+        # Parse host out of "host:port" if specified.
+        host_port_ary = @interface.to_s.split ':'
+        @interface = host_port_ary[0]
+        @port ||= host_port_ary[1]
+        
+        # TODO: Parse port from interface if TCP.
+        raise ArgumentError, "Port not specified." unless @port
+        @port = @port.to_i
+        
         @server = TCPServer.new @interface, @port
         @server.setsockopt ::Socket::SOL_SOCKET, ::Socket::SO_REUSEADDR, [1].pack('i')
+        
       when :udp
         raise ArgumentError, "UDP should be implemented with Ionian::Socket."
+        
       when :unix
+        raise ArgumentError, "Path not specified." unless @interface
+        
         @server = UNIXServer.new @interface
       end
       
@@ -93,7 +125,7 @@ module Ionian
     
     # Unregisters a socket accept notifier block.
     def unregister_accept_listener proc
-      @accept_listeners.delete_if {|o| o == proc} 
+      @accept_listeners.delete_if { |o| o == proc }
       proc
     end
     

data/lib/ionian/socket.rb

@@ -14,10 +14,16 @@ module Ionian
     # Local port number.
     attr_reader :bind_port
     
+    # Returns a symbol of the type of protocol this socket uses:
+    # :tcp, :udp, :unix
+    attr_reader :protocol
+    alias_method :protocol?, :protocol
+    
+    
     # Creates a new socket or wraps an existing socket.
     # 
     # Args:
-    #   host:       IP or hostname to connect to.
+    #   host:       IP or hostname to connect to. Can contain the port in the format "host:port".
     #   port:       Connection's port number. Default is 23. Unused by :unix protocol.
     #   protocol:   Type of socket to create. :tcp, :udp, :unix. Default is :tcp.
     #               :udp will be automatically selected for addresses in the multicast range.
@@ -93,11 +99,6 @@ module Ionian
       end
     end
         
-    # Returns a symbol of the type of protocol this socket uses:
-    # :tcp, :udp, :unix
-    attr_reader :protocol
-    alias_method :protocol?, :protocol
-    
     # Returns the regular expression used to match incoming data.
     def expression
       @expression || @socket.expression

metadata

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