RubyGems - ionian - Versions diffs - 0.4.1 → 0.5.0 - Mend

ionian 0.4.1 → 0.5.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (11) hide show

checksums.yaml +4 -4
data/doc/Ionian/Extension/IO.html +1 -1
data/doc/Ionian/Extension/Socket.html +1143 -20
data/doc/Ionian/Socket.html +43 -14
data/doc/created.rid +4 -4
data/doc/js/search_index.js +1 -1
data/doc/table_of_contents.html +155 -0
data/lib/ionian/extension/io.rb +1 -1
data/lib/ionian/extension/socket.rb +212 -8
data/lib/ionian/socket.rb +43 -7
metadata +2 -2

data/doc/Ionian/Socket.html CHANGED Viewed

@@ -76,6 +76,14 @@
     <li><a class="extend" href="Extension/Socket.html">Ionian::Extension::Socket</a>
+    <li><a class="extend" href="Extension/Socket.html">Ionian::Extension::Socket</a>
+    <li><a class="extend" href="Extension/Socket.html">Ionian::Extension::Socket</a>
   </ul>
 </div>
@@ -156,28 +164,49 @@
           <p>Args:</p>
-<pre>host: IP or hostname to connect to.
-port: Connection&#39;s port number. Default is 23. Unused by :unix protocol.
-protocol: Type of socket to create. :tcp, :udp, :unix. Default is :tcp.
+<pre>host:       IP or hostname to connect to.
+port:       Connection&#39;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.
 persistent: The socket remains open after data is sent if this is true.
             The socket closes after data is sent and a packet is received
             if this is false. Default is true.
+bind_port:  Local UDP port to bind to for receiving data, if different than
+            the remote port being connected to.
+reuse_addr: Set true to enable the SO_REUSEADDR flag. Allows local address reuse.
+no_delay:   Set true to enable the TCP_NODELAY flag. Disables Nagle algorithm.
+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.</pre>
           <div class="method-source-code" id="new-source">
-            <pre><span class="ruby-comment"># File lib/ionian/socket.rb, line 16</span>
+            <pre><span class="ruby-comment"># File lib/ionian/socket.rb, line 23</span>
 <span class="ruby-keyword">def</span> <span class="ruby-identifier">initialize</span>(<span class="ruby-operator">**</span><span class="ruby-identifier">kwargs</span>)
   <span class="ruby-ivar">@socket</span>         = <span class="ruby-keyword">nil</span>
+  <span class="ruby-comment"># TODO: Should be able to parse the port out of host.</span>
+  <span class="ruby-comment">#       :port should override this parsed value.</span>
   <span class="ruby-ivar">@host</span>           = <span class="ruby-identifier">kwargs</span>.<span class="ruby-identifier">fetch</span> <span class="ruby-value">:host</span>
-  <span class="ruby-ivar">@port</span>           = <span class="ruby-identifier">kwargs</span>.<span class="ruby-identifier">fetch</span> <span class="ruby-value">:port</span>, <span class="ruby-value">23</span>
-  <span class="ruby-ivar">@protocol</span>       = <span class="ruby-identifier">kwargs</span>.<span class="ruby-identifier">fetch</span> <span class="ruby-value">:protocol</span>, <span class="ruby-value">:tcp</span>
+  <span class="ruby-ivar">@port</span>           = <span class="ruby-identifier">kwargs</span>.<span class="ruby-identifier">fetch</span> <span class="ruby-value">:port</span>,       <span class="ruby-value">23</span>
+  <span class="ruby-ivar">@bind_port</span>      = <span class="ruby-identifier">kwargs</span>.<span class="ruby-identifier">fetch</span> <span class="ruby-value">:bind_port</span>,  <span class="ruby-ivar">@port</span>
+  <span class="ruby-comment"># Automatically select UDP for the multicast range. Otherwise default to TCP.</span>
+  <span class="ruby-identifier">default_protocol</span> = <span class="ruby-value">:tcp</span>
+  <span class="ruby-identifier">default_protocol</span> = <span class="ruby-value">:udp</span>  <span class="ruby-keyword">if</span> <span class="ruby-constant">Ionian</span><span class="ruby-operator">::</span><span class="ruby-constant">Extension</span><span class="ruby-operator">::</span><span class="ruby-constant">Socket</span>.<span class="ruby-identifier">multicast?</span> <span class="ruby-ivar">@host</span>
+  <span class="ruby-identifier">default_protocol</span> = <span class="ruby-value">:unix</span> <span class="ruby-keyword">if</span> <span class="ruby-ivar">@host</span>.<span class="ruby-identifier">start_with?</span> <span class="ruby-string">&#39;/&#39;</span>
+  <span class="ruby-ivar">@protocol</span>       = <span class="ruby-identifier">kwargs</span>.<span class="ruby-identifier">fetch</span> <span class="ruby-value">:protocol</span>,   <span class="ruby-identifier">default_protocol</span>
   <span class="ruby-ivar">@persistent</span>     = <span class="ruby-identifier">kwargs</span>.<span class="ruby-identifier">fetch</span> <span class="ruby-value">:persistent</span>, <span class="ruby-keyword">true</span>
   <span class="ruby-ivar">@expression</span>     = <span class="ruby-identifier">kwargs</span>.<span class="ruby-identifier">fetch</span> <span class="ruby-value">:expression</span>, <span class="ruby-keyword">nil</span>
+  <span class="ruby-ivar">@reuse_addr</span>     = <span class="ruby-identifier">kwargs</span>.<span class="ruby-identifier">fetch</span> <span class="ruby-value">:reuse_addr</span>, <span class="ruby-keyword">false</span>
+  <span class="ruby-ivar">@no_delay</span>       = <span class="ruby-identifier">kwargs</span>.<span class="ruby-identifier">fetch</span> <span class="ruby-value">:no_delay</span>,   <span class="ruby-keyword">false</span>
+  <span class="ruby-ivar">@cork</span>           = <span class="ruby-identifier">kwargs</span>.<span class="ruby-identifier">fetch</span> <span class="ruby-value">:cork</span>,       <span class="ruby-keyword">false</span>
   <span class="ruby-identifier">create_socket</span> <span class="ruby-keyword">if</span> <span class="ruby-ivar">@persistent</span>
 <span class="ruby-keyword">end</span></pre>
           </div>
@@ -245,7 +274,7 @@ expression: Overrides the #read_match regular expression for received data.</pre
           <div class="method-source-code" id="closed-3F-source">
-            <pre><span class="ruby-comment"># File lib/ionian/socket.rb, line 73</span>
+            <pre><span class="ruby-comment"># File lib/ionian/socket.rb, line 94</span>
 <span class="ruby-keyword">def</span> <span class="ruby-identifier">closed?</span>
   <span class="ruby-keyword">return</span> <span class="ruby-keyword">true</span> <span class="ruby-keyword">unless</span> <span class="ruby-ivar">@socket</span>
   <span class="ruby-ivar">@socket</span>.<span class="ruby-identifier">closed?</span>
@@ -281,7 +310,7 @@ href="Extension/IO.html#method-i-read_match">Ionian::Extension::IO#read_match</a
           <div class="method-source-code" id="cmd-source">
-            <pre><span class="ruby-comment"># File lib/ionian/socket.rb, line 43</span>
+            <pre><span class="ruby-comment"># File lib/ionian/socket.rb, line 64</span>
 <span class="ruby-keyword">def</span> <span class="ruby-identifier">cmd</span>(<span class="ruby-identifier">string</span>, <span class="ruby-operator">**</span><span class="ruby-identifier">kwargs</span>, <span class="ruby-operator">&amp;</span><span class="ruby-identifier">block</span>)
   <span class="ruby-identifier">create_socket</span> <span class="ruby-keyword">unless</span> <span class="ruby-ivar">@persistent</span>
@@ -328,7 +357,7 @@ non-persistent sockets.</p>
           <div class="method-source-code" id="flush-source">
-            <pre><span class="ruby-comment"># File lib/ionian/socket.rb, line 80</span>
+            <pre><span class="ruby-comment"># File lib/ionian/socket.rb, line 101</span>
 <span class="ruby-keyword">def</span> <span class="ruby-identifier">flush</span>
   <span class="ruby-ivar">@socket</span>.<span class="ruby-identifier">flush</span> <span class="ruby-keyword">if</span> <span class="ruby-ivar">@persistent</span>
 <span class="ruby-keyword">end</span></pre>
@@ -364,7 +393,7 @@ non-persistent sockets.</p>
           <div class="method-source-code" id="has_data-3F-source">
-            <pre><span class="ruby-comment"># File lib/ionian/socket.rb, line 67</span>
+            <pre><span class="ruby-comment"># File lib/ionian/socket.rb, line 88</span>
 <span class="ruby-keyword">def</span> <span class="ruby-identifier">has_data?</span>(<span class="ruby-operator">**</span><span class="ruby-identifier">kwargs</span>)
   <span class="ruby-keyword">return</span> <span class="ruby-keyword">false</span> <span class="ruby-keyword">unless</span> <span class="ruby-ivar">@socket</span>
   <span class="ruby-ivar">@socket</span>.<span class="ruby-identifier">has_data?</span> <span class="ruby-identifier">kwargs</span>
@@ -398,7 +427,7 @@ non-persistent sockets.</p>
           <div class="method-source-code" id="persistent-3F-source">
-            <pre><span class="ruby-comment"># File lib/ionian/socket.rb, line 35</span>
+            <pre><span class="ruby-comment"># File lib/ionian/socket.rb, line 56</span>
 <span class="ruby-keyword">def</span> <span class="ruby-identifier">persistent?</span>
   <span class="ruby-ivar">@persistent</span> <span class="ruby-operator">==</span> <span class="ruby-keyword">false</span> <span class="ruby-operator">||</span> <span class="ruby-ivar">@persistent</span> <span class="ruby-operator">==</span> <span class="ruby-keyword">nil</span> <span class="ruby-operator">?</span> <span class="ruby-keyword">false</span> <span class="ruby-operator">:</span> <span class="ruby-keyword">true</span>
 <span class="ruby-keyword">end</span></pre>
@@ -432,7 +461,7 @@ non-persistent sockets.</p>
           <div class="method-source-code" id="protocol-3F-source">
-            <pre><span class="ruby-comment"># File lib/ionian/socket.rb, line 30</span>
+            <pre><span class="ruby-comment"># File lib/ionian/socket.rb, line 51</span>
 <span class="ruby-keyword">def</span> <span class="ruby-identifier">protocol?</span>
   <span class="ruby-ivar">@protocol</span>
 <span class="ruby-keyword">end</span></pre>
@@ -466,7 +495,7 @@ any string not already ending with one.</p>
           <div class="method-source-code" id="puts-source">
-            <pre><span class="ruby-comment"># File lib/ionian/socket.rb, line 86</span>
+            <pre><span class="ruby-comment"># File lib/ionian/socket.rb, line 107</span>
 <span class="ruby-keyword">def</span> <span class="ruby-identifier">puts</span>(<span class="ruby-operator">*</span><span class="ruby-identifier">string</span>)
   <span class="ruby-keyword">self</span>.<span class="ruby-identifier">write</span> <span class="ruby-identifier">string</span>.<span class="ruby-identifier">map</span>{<span class="ruby-operator">|</span><span class="ruby-identifier">s</span><span class="ruby-operator">|</span> <span class="ruby-identifier">s</span>.<span class="ruby-identifier">chomp</span>}.<span class="ruby-identifier">join</span>(<span class="ruby-string">&quot;\n&quot;</span>) <span class="ruby-operator">+</span> <span class="ruby-string">&quot;\n&quot;</span>
 <span class="ruby-keyword">end</span></pre>
@@ -499,7 +528,7 @@ any string not already ending with one.</p>
           <div class="method-source-code" id="write-source">
-            <pre><span class="ruby-comment"># File lib/ionian/socket.rb, line 92</span>
+            <pre><span class="ruby-comment"># File lib/ionian/socket.rb, line 113</span>
 <span class="ruby-keyword">def</span> <span class="ruby-identifier">write</span>(<span class="ruby-identifier">string</span>)
   <span class="ruby-identifier">create_socket</span> <span class="ruby-keyword">unless</span> <span class="ruby-ivar">@persistent</span>

data/doc/created.rid CHANGED Viewed

@@ -1,5 +1,5 @@
-Tue, 03 Dec 2013 19:30:58 -0800
+Mon, 09 Dec 2013 18:32:49 -0800
 lib/ionian.rb	Tue, 03 Dec 2013 19:30:50 -0800
-lib/ionian/extension/io.rb	Tue, 03 Dec 2013 19:28:00 -0800
-lib/ionian/extension/socket.rb	Tue, 03 Dec 2013 19:28:50 -0800
-lib/ionian/socket.rb	Tue, 03 Dec 2013 19:29:44 -0800
+lib/ionian/extension/io.rb	Wed, 04 Dec 2013 19:25:58 -0800
+lib/ionian/extension/socket.rb	Sat, 07 Dec 2013 14:02:46 -0800
+lib/ionian/socket.rb	Sat, 07 Dec 2013 15:13:22 -0800

data/doc/js/search_index.js CHANGED Viewed

	@@ -1 +1 @@
1	- var search_data = {"index":{"searchIndex":["ionian","extension","io","socket","socket","<<()","closed?()","cmd()","expression()","expression=()","extended()","extended()","flush()","has_data?()","has_data?()","initialize_ionian()","initialize_ionian_socket()","new()","no_delay()","no_delay=()","on_match()","persistent?()","protocol?()","purge()","puts()","read_match()","register_observer()","run_match()","unregister_observer()","write()"],"longSearchIndex":["ionian","ionian::extension","ionian::extension::io","ionian::extension::socket","ionian::socket","ionian::socket#<<()","ionian::socket#closed?()","ionian::socket#cmd()","ionian::extension::io#expression()","ionian::extension::io#expression=()","ionian::extension::io::extended()","ionian::extension::socket::extended()","ionian::socket#flush()","ionian::extension::io#has_data?()","ionian::socket#has_data?()","ionian::extension::io#initialize_ionian()","ionian::extension::socket#initialize_ionian_socket()","ionian::socket::new()","ionian::extension::socket#no_delay()","ionian::extension::socket#no_delay=()","ionian::extension::io#on_match()","ionian::socket#persistent?()","ionian::socket#protocol?()","ionian::extension::io#purge()","ionian::socket#puts()","ionian::extension::io#read_match()","ionian::extension::io#register_observer()","ionian::extension::io#run_match()","ionian::extension::io#unregister_observer()","ionian::socket#write()"],"info":[["Ionian","","Ionian.html","","<p>A library to simplify interaction with IO streams. This includes network\nsockets, file sockets, and serial …\n"],["Ionian::Extension","","Ionian/Extension.html","","<p>A collection of mixins.\n"],["Ionian::Extension::IO","","Ionian/Extension/IO.html","","<p>A mixin for IO objects that allows regular expression matching and\nconvenient notification of received …\n"],["Ionian::Extension::Socket","","Ionian/Extension/Socket.html","","<p>A mixin for Socket objects.\n<p>This module was designed to be extended by instantiated objects that\nimplement …\n"],["Ionian::Socket","","Ionian/Socket.html","","<p>A convenient wrapper for TCP, UDP, and Unix sockets.\n"],["<<","Ionian::Socket","Ionian/Socket.html#method-i-3C-3C","(string)",""],["closed?","Ionian::Socket","Ionian/Socket.html#method-i-closed-3F","()","<p>Returns true if the socket is closed.\n"],["cmd","Ionian::Socket","Ionian/Socket.html#method-i-cmd","(string, kwargs, &block)","<p>Send a command (data) to the socket. Returns an array of received matches.\nBlock yields received match. …\n"],["expression","Ionian::Extension::IO","Ionian/Extension/IO.html#method-i-expression","()","<p>Returns the regular expression used for #read_match.\n"],["expression=","Ionian::Extension::IO","Ionian/Extension/IO.html#method-i-expression-3D","(exp)","<p>Set the expression to match against the read buffer. Can be a regular\nexpression specifying capture groups, …\n"],["extended","Ionian::Extension::IO","Ionian/Extension/IO.html#method-c-extended","(obj)","<p>Called automaticallly when the object is extended with #extend.\n"],["extended","Ionian::Extension::Socket","Ionian/Extension/Socket.html#method-c-extended","(obj)","<p>Called automaticallly when the object is extended with #extend.\n"],["flush","Ionian::Socket","Ionian/Socket.html#method-i-flush","()","<p>Flushes buffered data to the operating system. This method has no effect on\nnon-persistent sockets.\n"],["has_data?","Ionian::Extension::IO","Ionian/Extension/IO.html#method-i-has_data-3F","(timeout: 0)","<p>Returns true if there is data in the receive buffer. Args:\n\n<pre>Timeout: Number of seconds to wait for data ...</pre>\n"],["has_data?","Ionian::Socket","Ionian/Socket.html#method-i-has_data-3F","(kwargs)","<p>Returns true if there is data in the receive buffer. Args:\n\n<pre>Timeout: Number of seconds to wait for data ...</pre>\n"],["initialize_ionian","Ionian::Extension::IO","Ionian/Extension/IO.html#method-i-initialize_ionian","()","<p>Initialize the Ionian instance variables. This is called automatically if\n#extend is called on an object. …\n"],["initialize_ionian_socket","Ionian::Extension::Socket","Ionian/Extension/Socket.html#method-i-initialize_ionian_socket","()","<p>Initialize the Ionian Socket variables. This is called automatically if\n#extend is called on an object. …\n"],["new","Ionian::Socket","Ionian/Socket.html#method-c-new","(*kwargs)","<p>Args:\n\n<pre>host: IP or hostname to connect to.\nport: Connection's port number. Default is 23. Unused by :unix ...</pre>\n"],["no_delay","Ionian::Extension::Socket","Ionian/Extension/Socket.html#method-i-no_delay","()","<p>Returns true if the TCP_NODELAY flag is enabled (Nagle disabled). Otherwise\nfalse.\n"],["no_delay=","Ionian::Extension::Socket","Ionian/Extension/Socket.html#method-i-no_delay-3D","(value)","<p>Setting to true enables the TCP_NODELAY flag (disables Nagle). Setting to\nfalse disables the flag (enables …\n"],["on_match","Ionian::Extension::IO","Ionian/Extension/IO.html#method-i-on_match","(&block)",""],["persistent?","Ionian::Socket","Ionian/Socket.html#method-i-persistent-3F","()","<p>Returns true if the socket remains open after writing data.\n"],["protocol?","Ionian::Socket","Ionian/Socket.html#method-i-protocol-3F","()","<p>Returns a symbol of the type of protocol this socket uses: :tcp, :udp,\n:unix\n"],["purge","Ionian::Extension::IO","Ionian/Extension/IO.html#method-i-purge","()","<p>Erase the data in the IO and Ionian buffers. This is typically handled\nautomatically.\n"],["puts","Ionian::Socket","Ionian/Socket.html#method-i-puts","(string)","<p>Writes the given string(s) to the socket and appends a newline character to\nany string not already ending …\n"],["read_match","Ionian::Extension::IO","Ionian/Extension/IO.html#method-i-read_match","(kwargs, &block)","<p>Read matched data from the buffer. This method SHOULD NOT be used if\n#run_match is used.\n<p>Passes matches …\n"],["register_observer","Ionian::Extension::IO","Ionian/Extension/IO.html#method-i-register_observer","(&block)","<p>Register a block to be called when #run_match receives matched data. Method\ncallbacks can be registered …\n"],["run_match","Ionian::Extension::IO","Ionian/Extension/IO.html#method-i-run_match","(kwargs)","<p>Start a thread that checks for data and notifies listeners (do \|match,\nsocket\|). Passes kwargs to #read_match …\n"],["unregister_observer","Ionian::Extension::IO","Ionian/Extension/IO.html#method-i-unregister_observer","(&block)","<p>Unregister a block from being called when matched data is received.\n"],["write","Ionian::Socket","Ionian/Socket.html#method-i-write","(string)","<p>Writes the given string to the socket. Returns the number of bytes written.\n"]]}}
1	+ var search_data = {"index":{"searchIndex":["ionian","extension","io","socket","socket","<<()","closed?()","cmd()","cork()","cork=()","cork?()","expression()","expression=()","extended()","extended()","flush()","has_data?()","has_data?()","initialize_ionian()","initialize_ionian_socket()","ip_add_membership()","ip_drop_membership()","ip_multicast_if()","ip_multicast_if=()","ip_multicast_loop()","ip_multicast_loop=()","ip_multicast_loop?()","ip_multicast_ttl()","ip_multicast_ttl=()","ipv6_add_membership()","ipv6_drop_membership()","ipv6_multicast_hops()","ipv6_multicast_hops=()","ipv6_multicast_if()","ipv6_multicast_if=()","ipv6_multicast_loop()","ipv6_multicast_loop=()","ipv6_multicast_loop?()","multicast()","multicast?()","new()","no_delay()","no_delay=()","no_delay?()","on_match()","persistent?()","protocol?()","purge()","puts()","read_match()","recork()","register_observer()","reuse_addr()","reuse_addr=()","reuse_addr?()","run_match()","ttl()","ttl=()","ttl?()","unregister_observer()","write()"],"longSearchIndex":["ionian","ionian::extension","ionian::extension::io","ionian::extension::socket","ionian::socket","ionian::socket#<<()","ionian::socket#closed?()","ionian::socket#cmd()","ionian::extension::socket#cork()","ionian::extension::socket#cork=()","ionian::extension::socket#cork?()","ionian::extension::io#expression()","ionian::extension::io#expression=()","ionian::extension::io::extended()","ionian::extension::socket::extended()","ionian::socket#flush()","ionian::extension::io#has_data?()","ionian::socket#has_data?()","ionian::extension::io#initialize_ionian()","ionian::extension::socket#initialize_ionian_socket()","ionian::extension::socket#ip_add_membership()","ionian::extension::socket#ip_drop_membership()","ionian::extension::socket#ip_multicast_if()","ionian::extension::socket#ip_multicast_if=()","ionian::extension::socket#ip_multicast_loop()","ionian::extension::socket#ip_multicast_loop=()","ionian::extension::socket#ip_multicast_loop?()","ionian::extension::socket#ip_multicast_ttl()","ionian::extension::socket#ip_multicast_ttl=()","ionian::extension::socket#ipv6_add_membership()","ionian::extension::socket#ipv6_drop_membership()","ionian::extension::socket#ipv6_multicast_hops()","ionian::extension::socket#ipv6_multicast_hops=()","ionian::extension::socket#ipv6_multicast_if()","ionian::extension::socket#ipv6_multicast_if=()","ionian::extension::socket#ipv6_multicast_loop()","ionian::extension::socket#ipv6_multicast_loop=()","ionian::extension::socket#ipv6_multicast_loop?()","ionian::extension::socket#multicast()","ionian::extension::socket#multicast?()","ionian::socket::new()","ionian::extension::socket#no_delay()","ionian::extension::socket#no_delay=()","ionian::extension::socket#no_delay?()","ionian::extension::io#on_match()","ionian::socket#persistent?()","ionian::socket#protocol?()","ionian::extension::io#purge()","ionian::socket#puts()","ionian::extension::io#read_match()","ionian::extension::socket#recork()","ionian::extension::io#register_observer()","ionian::extension::socket#reuse_addr()","ionian::extension::socket#reuse_addr=()","ionian::extension::socket#reuse_addr?()","ionian::extension::io#run_match()","ionian::extension::socket#ttl()","ionian::extension::socket#ttl=()","ionian::extension::socket#ttl?()","ionian::extension::io#unregister_observer()","ionian::socket#write()"],"info":[["Ionian","","Ionian.html","","<p>A library to simplify interaction with IO streams. This includes network\nsockets, file sockets, and serial …\n"],["Ionian::Extension","","Ionian/Extension.html","","<p>A collection of mixins.\n"],["Ionian::Extension::IO","","Ionian/Extension/IO.html","","<p>A mixin for IO objects that allows regular expression matching and\nconvenient notification of received …\n"],["Ionian::Extension::Socket","","Ionian/Extension/Socket.html","","<p>A mixin for Socket objects.\n<p>This module was designed to be extended by instantiated objects that\nimplement …\n"],["Ionian::Socket","","Ionian/Socket.html","","<p>A convenient wrapper for TCP, UDP, and Unix sockets.\n"],["<<","Ionian::Socket","Ionian/Socket.html#method-i-3C-3C","(string)",""],["closed?","Ionian::Socket","Ionian/Socket.html#method-i-closed-3F","()","<p>Returns true if the socket is closed.\n"],["cmd","Ionian::Socket","Ionian/Socket.html#method-i-cmd","(string, kwargs, &block)","<p>Send a command (data) to the socket. Returns an array of received matches.\nBlock yields received match. …\n"],["cork","Ionian::Extension::Socket","Ionian/Extension/Socket.html#method-i-cork","()","<p>Returns true if multiple writes are buffered into a single segment. See\n#recork. Linux only. ( TCP_CORK …\n"],["cork=","Ionian::Extension::Socket","Ionian/Extension/Socket.html#method-i-cork-3D","(value)","<p>Buffers multiple writes into a single segment if true. The segment is sent\nonce the cork flag is disabled, …\n"],["cork?","Ionian::Extension::Socket","Ionian/Extension/Socket.html#method-i-cork-3F","()",""],["expression","Ionian::Extension::IO","Ionian/Extension/IO.html#method-i-expression","()","<p>Returns the regular expression used for #read_match.\n"],["expression=","Ionian::Extension::IO","Ionian/Extension/IO.html#method-i-expression-3D","(exp)","<p>Set the expression to match against the read buffer. Can be a regular\nexpression specifying capture groups, …\n"],["extended","Ionian::Extension::IO","Ionian/Extension/IO.html#method-c-extended","(obj)","<p>Called automaticallly when the object is extended with #extend.\n"],["extended","Ionian::Extension::Socket","Ionian/Extension/Socket.html#method-c-extended","(obj)","<p>Called automaticallly when the object is extended with #extend.\n"],["flush","Ionian::Socket","Ionian/Socket.html#method-i-flush","()","<p>Flushes buffered data to the operating system. This method has no effect on\nnon-persistent sockets.\n"],["has_data?","Ionian::Extension::IO","Ionian/Extension/IO.html#method-i-has_data-3F","(timeout: 0)","<p>Returns true if there is data in the receive buffer. Args:\n\n<pre>Timeout: Number of seconds to wait for data ...</pre>\n"],["has_data?","Ionian::Socket","Ionian/Socket.html#method-i-has_data-3F","(kwargs)","<p>Returns true if there is data in the receive buffer. Args:\n\n<pre>Timeout: Number of seconds to wait for data ...</pre>\n"],["initialize_ionian","Ionian::Extension::IO","Ionian/Extension/IO.html#method-i-initialize_ionian","()","<p>Initialize the Ionian instance variables. This is called automatically if\n#extend is called on an object. …\n"],["initialize_ionian_socket","Ionian::Extension::Socket","Ionian/Extension/Socket.html#method-i-initialize_ionian_socket","()","<p>Initialize the Ionian Socket variables. This is called automatically if\n#extend is called on an object. …\n"],["ip_add_membership","Ionian::Extension::Socket","Ionian/Extension/Socket.html#method-i-ip_add_membership","(address = nil, interface = nil)","<p>Join a multicast group. Address is the class D multicast address (uses\nremote address if not specified). …\n"],["ip_drop_membership","Ionian::Extension::Socket","Ionian/Extension/Socket.html#method-i-ip_drop_membership","(address = nil, interface = nil)","<p>Leave a multicast group. Address is the class D multicast address (uses\nremote address if not specified). …\n"],["ip_multicast_if","Ionian::Extension::Socket","Ionian/Extension/Socket.html#method-i-ip_multicast_if","()","<p>Returns the default interface for outgoing multicasts. ( IP_MULTICAST_IF )\n"],["ip_multicast_if=","Ionian::Extension::Socket","Ionian/Extension/Socket.html#method-i-ip_multicast_if-3D","(interface = nil)","<p>Specify default interface for outgoing multicasts. ( IP_MULTICAST_IF )\n"],["ip_multicast_loop","Ionian::Extension::Socket","Ionian/Extension/Socket.html#method-i-ip_multicast_loop","()","<p>Returns true if loopback of outgoing multicasts is enabled. (\nIP_MULTICAST_LOOP )\n"],["ip_multicast_loop=","Ionian::Extension::Socket","Ionian/Extension/Socket.html#method-i-ip_multicast_loop-3D","(value)","<p>Enables loopback of outgoing multicasts if true. ( IP_MULTICAST_LOOP )\n"],["ip_multicast_loop?","Ionian::Extension::Socket","Ionian/Extension/Socket.html#method-i-ip_multicast_loop-3F","()",""],["ip_multicast_ttl","Ionian::Extension::Socket","Ionian/Extension/Socket.html#method-i-ip_multicast_ttl","()","<p>Returns the time to live (hop limit) for outgoing multicasts. (\nIP_MULTICAST_TTL )\n"],["ip_multicast_ttl=","Ionian::Extension::Socket","Ionian/Extension/Socket.html#method-i-ip_multicast_ttl-3D","(value)","<p>Set the time to live (hop limit) for outgoing multicasts. (\nIP_MULTICAST_TTL )\n"],["ipv6_add_membership","Ionian::Extension::Socket","Ionian/Extension/Socket.html#method-i-ipv6_add_membership","()",""],["ipv6_drop_membership","Ionian::Extension::Socket","Ionian/Extension/Socket.html#method-i-ipv6_drop_membership","()",""],["ipv6_multicast_hops","Ionian::Extension::Socket","Ionian/Extension/Socket.html#method-i-ipv6_multicast_hops","()",""],["ipv6_multicast_hops=","Ionian::Extension::Socket","Ionian/Extension/Socket.html#method-i-ipv6_multicast_hops-3D","(value)",""],["ipv6_multicast_if","Ionian::Extension::Socket","Ionian/Extension/Socket.html#method-i-ipv6_multicast_if","()",""],["ipv6_multicast_if=","Ionian::Extension::Socket","Ionian/Extension/Socket.html#method-i-ipv6_multicast_if-3D","(value)",""],["ipv6_multicast_loop","Ionian::Extension::Socket","Ionian/Extension/Socket.html#method-i-ipv6_multicast_loop","()",""],["ipv6_multicast_loop=","Ionian::Extension::Socket","Ionian/Extension/Socket.html#method-i-ipv6_multicast_loop-3D","(value)",""],["ipv6_multicast_loop?","Ionian::Extension::Socket","Ionian/Extension/Socket.html#method-i-ipv6_multicast_loop-3F","()",""],["multicast","Ionian::Extension::Socket","Ionian/Extension/Socket.html#method-i-multicast","(address)","<p>Returns true if the given address is within the multicast range.\n"],["multicast?","Ionian::Extension::Socket","Ionian/Extension/Socket.html#method-i-multicast-3F","(address)",""],["new","Ionian::Socket","Ionian/Socket.html#method-c-new","(*kwargs)","<p>Args:\n\n<pre>host: IP or hostname to connect to.\nport: Connection's port number. Default is 23. Unused ...</pre>\n"],["no_delay","Ionian::Extension::Socket","Ionian/Extension/Socket.html#method-i-no_delay","()","<p>Returns true if the Nagle algorithm is disabled. ( TCP_NODELAY )\n"],["no_delay=","Ionian::Extension::Socket","Ionian/Extension/Socket.html#method-i-no_delay-3D","(value)","<p>Disables the Nagle algorithm if true. ( TCP_NODELAY )\n"],["no_delay?","Ionian::Extension::Socket","Ionian/Extension/Socket.html#method-i-no_delay-3F","()",""],["on_match","Ionian::Extension::IO","Ionian/Extension/IO.html#method-i-on_match","(&block)",""],["persistent?","Ionian::Socket","Ionian/Socket.html#method-i-persistent-3F","()","<p>Returns true if the socket remains open after writing data.\n"],["protocol?","Ionian::Socket","Ionian/Socket.html#method-i-protocol-3F","()","<p>Returns a symbol of the type of protocol this socket uses: :tcp, :udp,\n:unix\n"],["purge","Ionian::Extension::IO","Ionian/Extension/IO.html#method-i-purge","()","<p>Erase the data in the IO and Ionian buffers. This is typically handled\nautomatically.\n"],["puts","Ionian::Socket","Ionian/Socket.html#method-i-puts","(string)","<p>Writes the given string(s) to the socket and appends a newline character to\nany string not already ending …\n"],["read_match","Ionian::Extension::IO","Ionian/Extension/IO.html#method-i-read_match","(kwargs, &block)","<p>Read matched data from the buffer. This method SHOULD NOT be used if\n#run_match is used.\n<p>Passes matches …\n"],["recork","Ionian::Extension::Socket","Ionian/Extension/Socket.html#method-i-recork","()","<p>Unsets cork to transmit data, then reapplies cork. ( TCP_CORK )\n"],["register_observer","Ionian::Extension::IO","Ionian/Extension/IO.html#method-i-register_observer","(&block)","<p>Register a block to be called when #run_match receives matched data. Method\ncallbacks can be registered …\n"],["reuse_addr","Ionian::Extension::Socket","Ionian/Extension/Socket.html#method-i-reuse_addr","()","<p>Returns true if local address reuse is allowed. ( SO_REUSEADDR )\n"],["reuse_addr=","Ionian::Extension::Socket","Ionian/Extension/Socket.html#method-i-reuse_addr-3D","(value)","<p>Allows local address reuse if true. ( SO_REUSEADDR )\n"],["reuse_addr?","Ionian::Extension::Socket","Ionian/Extension/Socket.html#method-i-reuse_addr-3F","()",""],["run_match","Ionian::Extension::IO","Ionian/Extension/IO.html#method-i-run_match","(kwargs)","<p>Start a thread that checks for data and notifies listeners (do \|match,\nsocket\|). Passes kwargs to #read_match …\n"],["ttl","Ionian::Extension::Socket","Ionian/Extension/Socket.html#method-i-ttl","()","<p>Returns the time to live (hop limit). ( IP_TTL )\n"],["ttl=","Ionian::Extension::Socket","Ionian/Extension/Socket.html#method-i-ttl-3D","(value)","<p>Sets the time to live (hop limit). ( IP_TTL )\n"],["ttl?","Ionian::Extension::Socket","Ionian/Extension/Socket.html#method-i-ttl-3F","()",""],["unregister_observer","Ionian::Extension::IO","Ionian/Extension/IO.html#method-i-unregister_observer","(&block)","<p>Unregister a block from being called when matched data is received.\n"],["write","Ionian::Socket","Ionian/Socket.html#method-i-write","(string)","<p>Writes the given string to the socket. Returns the number of bytes written.\n"]]}}

data/doc/table_of_contents.html CHANGED Viewed

@@ -78,6 +78,21 @@
     &mdash;
     <span class="container">Ionian::Socket</span>
+  <li class="method">
+    <a href="Ionian/Extension/Socket.html#method-i-cork">#cork</a>
+    &mdash;
+    <span class="container">Ionian::Extension::Socket</span>
+  <li class="method">
+    <a href="Ionian/Extension/Socket.html#method-i-cork-3D">#cork=</a>
+    &mdash;
+    <span class="container">Ionian::Extension::Socket</span>
+  <li class="method">
+    <a href="Ionian/Extension/Socket.html#method-i-cork-3F">#cork?</a>
+    &mdash;
+    <span class="container">Ionian::Extension::Socket</span>
   <li class="method">
     <a href="Ionian/Extension/IO.html#method-i-expression">#expression</a>
     &mdash;
@@ -113,6 +128,106 @@
     &mdash;
     <span class="container">Ionian::Extension::Socket</span>
+  <li class="method">
+    <a href="Ionian/Extension/Socket.html#method-i-ip_add_membership">#ip_add_membership</a>
+    &mdash;
+    <span class="container">Ionian::Extension::Socket</span>
+  <li class="method">
+    <a href="Ionian/Extension/Socket.html#method-i-ip_drop_membership">#ip_drop_membership</a>
+    &mdash;
+    <span class="container">Ionian::Extension::Socket</span>
+  <li class="method">
+    <a href="Ionian/Extension/Socket.html#method-i-ip_multicast_if">#ip_multicast_if</a>
+    &mdash;
+    <span class="container">Ionian::Extension::Socket</span>
+  <li class="method">
+    <a href="Ionian/Extension/Socket.html#method-i-ip_multicast_if-3D">#ip_multicast_if=</a>
+    &mdash;
+    <span class="container">Ionian::Extension::Socket</span>
+  <li class="method">
+    <a href="Ionian/Extension/Socket.html#method-i-ip_multicast_loop">#ip_multicast_loop</a>
+    &mdash;
+    <span class="container">Ionian::Extension::Socket</span>
+  <li class="method">
+    <a href="Ionian/Extension/Socket.html#method-i-ip_multicast_loop-3D">#ip_multicast_loop=</a>
+    &mdash;
+    <span class="container">Ionian::Extension::Socket</span>
+  <li class="method">
+    <a href="Ionian/Extension/Socket.html#method-i-ip_multicast_loop-3F">#ip_multicast_loop?</a>
+    &mdash;
+    <span class="container">Ionian::Extension::Socket</span>
+  <li class="method">
+    <a href="Ionian/Extension/Socket.html#method-i-ip_multicast_ttl">#ip_multicast_ttl</a>
+    &mdash;
+    <span class="container">Ionian::Extension::Socket</span>
+  <li class="method">
+    <a href="Ionian/Extension/Socket.html#method-i-ip_multicast_ttl-3D">#ip_multicast_ttl=</a>
+    &mdash;
+    <span class="container">Ionian::Extension::Socket</span>
+  <li class="method">
+    <a href="Ionian/Extension/Socket.html#method-i-ipv6_add_membership">#ipv6_add_membership</a>
+    &mdash;
+    <span class="container">Ionian::Extension::Socket</span>
+  <li class="method">
+    <a href="Ionian/Extension/Socket.html#method-i-ipv6_drop_membership">#ipv6_drop_membership</a>
+    &mdash;
+    <span class="container">Ionian::Extension::Socket</span>
+  <li class="method">
+    <a href="Ionian/Extension/Socket.html#method-i-ipv6_multicast_hops">#ipv6_multicast_hops</a>
+    &mdash;
+    <span class="container">Ionian::Extension::Socket</span>
+  <li class="method">
+    <a href="Ionian/Extension/Socket.html#method-i-ipv6_multicast_hops-3D">#ipv6_multicast_hops=</a>
+    &mdash;
+    <span class="container">Ionian::Extension::Socket</span>
+  <li class="method">
+    <a href="Ionian/Extension/Socket.html#method-i-ipv6_multicast_if">#ipv6_multicast_if</a>
+    &mdash;
+    <span class="container">Ionian::Extension::Socket</span>
+  <li class="method">
+    <a href="Ionian/Extension/Socket.html#method-i-ipv6_multicast_if-3D">#ipv6_multicast_if=</a>
+    &mdash;
+    <span class="container">Ionian::Extension::Socket</span>
+  <li class="method">
+    <a href="Ionian/Extension/Socket.html#method-i-ipv6_multicast_loop">#ipv6_multicast_loop</a>
+    &mdash;
+    <span class="container">Ionian::Extension::Socket</span>
+  <li class="method">
+    <a href="Ionian/Extension/Socket.html#method-i-ipv6_multicast_loop-3D">#ipv6_multicast_loop=</a>
+    &mdash;
+    <span class="container">Ionian::Extension::Socket</span>
+  <li class="method">
+    <a href="Ionian/Extension/Socket.html#method-i-ipv6_multicast_loop-3F">#ipv6_multicast_loop?</a>
+    &mdash;
+    <span class="container">Ionian::Extension::Socket</span>
+  <li class="method">
+    <a href="Ionian/Extension/Socket.html#method-i-multicast">#multicast</a>
+    &mdash;
+    <span class="container">Ionian::Extension::Socket</span>
+  <li class="method">
+    <a href="Ionian/Extension/Socket.html#method-i-multicast-3F">#multicast?</a>
+    &mdash;
+    <span class="container">Ionian::Extension::Socket</span>
   <li class="method">
     <a href="Ionian/Extension/Socket.html#method-i-no_delay">#no_delay</a>
     &mdash;
@@ -123,6 +238,11 @@
     &mdash;
     <span class="container">Ionian::Extension::Socket</span>
+  <li class="method">
+    <a href="Ionian/Extension/Socket.html#method-i-no_delay-3F">#no_delay?</a>
+    &mdash;
+    <span class="container">Ionian::Extension::Socket</span>
   <li class="method">
     <a href="Ionian/Extension/IO.html#method-i-on_match">#on_match</a>
     &mdash;
@@ -153,16 +273,51 @@
     &mdash;
     <span class="container">Ionian::Extension::IO</span>
+  <li class="method">
+    <a href="Ionian/Extension/Socket.html#method-i-recork">#recork</a>
+    &mdash;
+    <span class="container">Ionian::Extension::Socket</span>
   <li class="method">
     <a href="Ionian/Extension/IO.html#method-i-register_observer">#register_observer</a>
     &mdash;
     <span class="container">Ionian::Extension::IO</span>
+  <li class="method">
+    <a href="Ionian/Extension/Socket.html#method-i-reuse_addr">#reuse_addr</a>
+    &mdash;
+    <span class="container">Ionian::Extension::Socket</span>
+  <li class="method">
+    <a href="Ionian/Extension/Socket.html#method-i-reuse_addr-3D">#reuse_addr=</a>
+    &mdash;
+    <span class="container">Ionian::Extension::Socket</span>
+  <li class="method">
+    <a href="Ionian/Extension/Socket.html#method-i-reuse_addr-3F">#reuse_addr?</a>
+    &mdash;
+    <span class="container">Ionian::Extension::Socket</span>
   <li class="method">
     <a href="Ionian/Extension/IO.html#method-i-run_match">#run_match</a>
     &mdash;
     <span class="container">Ionian::Extension::IO</span>
+  <li class="method">
+    <a href="Ionian/Extension/Socket.html#method-i-ttl">#ttl</a>
+    &mdash;
+    <span class="container">Ionian::Extension::Socket</span>
+  <li class="method">
+    <a href="Ionian/Extension/Socket.html#method-i-ttl-3D">#ttl=</a>
+    &mdash;
+    <span class="container">Ionian::Extension::Socket</span>
+  <li class="method">
+    <a href="Ionian/Extension/Socket.html#method-i-ttl-3F">#ttl?</a>
+    &mdash;
+    <span class="container">Ionian::Extension::Socket</span>
   <li class="method">
     <a href="Ionian/Extension/IO.html#method-i-unregister_observer">#unregister_observer</a>
     &mdash;

data/lib/ionian/extension/io.rb CHANGED Viewed

@@ -21,7 +21,7 @@ module Ionian
       def initialize_ionian
         @ionian_listeners     = []
         @ionian_buf           = ''
-        @ionian_expression    = /(.*?)\n/
+        @ionian_expression    = /(.*?)\r?\n?/
         @ionian_timeout       = nil
         @ionian_skip_select   = false
         @ionian_build_methods = true