<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html
PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<title>Class: SockIO</title>
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
<meta http-equiv="Content-Script-Type" content="text/javascript" />
<link rel="stylesheet" href=".././rdoc-style.css" type="text/css" media="screen" />
<script type="text/javascript">
// <![CDATA[
function popupCode( url ) {
window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
}
function toggleCode( id ) {
if ( document.getElementById )
elem = document.getElementById( id );
else if ( document.all )
elem = eval( "document.all." + id );
else
return false;
elemStyle = elem.style;
if ( elemStyle.display != "block" ) {
elemStyle.display = "block"
} else {
elemStyle.display = "none"
}
return true;
}
// Make codeblocks hidden by default
document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
// ]]>
</script>
</head>
<body>
<div id="classHeader">
<table class="header-table">
<tr class="top-aligned-row">
<td><strong>Class</strong></td>
<td class="class-name-in-header">SockIO</td>
</tr>
<tr class="top-aligned-row">
<td><strong>In:</strong></td>
<td>
<a href="../files/lib/network/sockio_rb.html">
lib/network/sockio.rb
</a>
<br />
</td>
</tr>
<tr class="top-aligned-row">
<td><strong>Parent:</strong></td>
<td>
Object
</td>
</tr>
</table>
</div>
<!-- banner header -->
<div id="bodyContent">
<div id="contextContent">
<div id="diagram">
<map id="map" name="map">
<area shape="rect" coords="5,5,77,53" href="SockIO.html" alt="SockIO
" />
</map>
<img src="../dot/f_41.png" usemap="#map" border="0" alt="dot/f_41.png">
</div>
<div id="description">
<p>
The <a href="SockIO.html">SockIO</a> class implements the low level
interface for TCP sockets.
</p>
</div>
</div>
<div id="method-list">
<h3 class="section-bar">Methods</h3>
<div class="name-list">
<a href="#M000091">new</a>
<a href="#M000092">read</a>
<a href="#M000095">read_flush</a>
<a href="#M000096">read_urgent</a>
<a href="#M000093">write</a>
<a href="#M000094">write_flush</a>
<a href="#M000097">write_urgent</a>
</div>
</div>
</div>
<!-- if includes -->
<div id="section">
<!-- if method_list -->
<div id="methods">
<h3 class="section-bar">Public Class methods</h3>
<div id="method-M000091" class="method-detail">
<a name="M000091"></a>
<div class="method-heading">
<a href="#M000091" class="method-signature">
<span class="method-name">new</span><span class="method-args">(sock, bufsize=8192)</span>
</a>
</div>
<div class="method-description">
<p>
Creates a <a href="SockIO.html#M000091">new</a> <a
href="SockIO.html">SockIO</a> object
</p>
<dl>
<dt><tt>sock</tt></dt><dd>The socket which will be used
</dd>
<dt><tt>bufsize</tt></dt><dd>The size of the buffer to use (default is 8192)
</dd>
</dl>
<p><a class="source-toggle" href="#"
onclick="toggleCode('M000091-source');return false;">[Source]</a></p>
<div class="method-source-code" id="M000091-source">
<pre>
<span class="ruby-comment cmt"># File lib/network/sockio.rb, line 25</span>
<span class="ruby-keyword kw">def</span> <span class="ruby-identifier">initialize</span>(<span class="ruby-identifier">sock</span>, <span class="ruby-identifier">bufsize</span>=<span class="ruby-value">8192</span>)
<span class="ruby-ivar">@sock</span>,<span class="ruby-ivar">@bufsize</span>=<span class="ruby-identifier">sock</span>,<span class="ruby-identifier">bufsize</span>
<span class="ruby-ivar">@inbuffer</span> = <span class="ruby-value str">""</span>
<span class="ruby-ivar">@outbuffer</span> = <span class="ruby-value str">""</span>
<span class="ruby-keyword kw">end</span>
</pre>
</div>
</div>
</div>
<h3 class="section-bar">Public Instance methods</h3>
<div id="method-M000092" class="method-detail">
<a name="M000092"></a>
<div class="method-heading">
<a href="#M000092" class="method-signature">
<span class="method-name">read</span><span class="method-args">()</span>
</a>
</div>
<div class="method-description">
<p>
<a href="SockIO.html#M000092">read</a> will receive a data from the socket.
</p>
<dl>
<dt><tt>return</tt></dt><dd>The data <a href="SockIO.html#M000092">read</a>
</dd>
<dt><tt>IOError</tt></dt><dd>A sockets error occurred.
</dd>
<dt><tt>EOFError</tt></dt><dd>The connection has closed normally.
</dd>
</dl>
<p><a class="source-toggle" href="#"
onclick="toggleCode('M000092-source');return false;">[Source]</a></p>
<div class="method-source-code" id="M000092-source">
<pre>
<span class="ruby-comment cmt"># File lib/network/sockio.rb, line 36</span>
<span class="ruby-keyword kw">def</span> <span class="ruby-identifier">read</span>
<span class="ruby-ivar">@sock</span>.<span class="ruby-identifier">recv</span>(<span class="ruby-ivar">@bufsize</span>)
<span class="ruby-keyword kw">end</span>
</pre>
</div>
</div>
</div>
<div id="method-M000095" class="method-detail">
<a name="M000095"></a>
<div class="method-heading">
<a href="#M000095" class="method-signature">
<span class="method-name">read_flush</span><span class="method-args">()</span>
</a>
</div>
<div class="method-description">
<p>
<a href="SockIO.html#M000095">read_flush</a> will kill the input buffer
</p>
<p><a class="source-toggle" href="#"
onclick="toggleCode('M000095-source');return false;">[Source]</a></p>
<div class="method-source-code" id="M000095-source">
<pre>
<span class="ruby-comment cmt"># File lib/network/sockio.rb, line 63</span>
<span class="ruby-keyword kw">def</span> <span class="ruby-identifier">read_flush</span>
<span class="ruby-ivar">@inbuffer</span> = <span class="ruby-value str">""</span>
<span class="ruby-keyword kw">end</span>
</pre>
</div>
</div>
</div>
<div id="method-M000096" class="method-detail">
<a name="M000096"></a>
<div class="method-heading">
<a href="#M000096" class="method-signature">
<span class="method-name">read_urgent</span><span class="method-args">()</span>
</a>
</div>
<div class="method-description">
<p>
<a href="SockIO.html#M000096">read_urgent</a> will receive urgent data from
the socket.
</p>
<dl>
<dt><tt>return</tt></dt><dd>The data <a href="SockIO.html#M000092">read</a>
</dd>
<dt><tt>IOError</tt></dt><dd>A sockets error occurred.
</dd>
<dt><tt>EOFError</tt></dt><dd>The connection has closed normally.
</dd>
</dl>
<p><a class="source-toggle" href="#"
onclick="toggleCode('M000096-source');return false;">[Source]</a></p>
<div class="method-source-code" id="M000096-source">
<pre>
<span class="ruby-comment cmt"># File lib/network/sockio.rb, line 72</span>
<span class="ruby-keyword kw">def</span> <span class="ruby-identifier">read_urgent</span>
<span class="ruby-ivar">@sock</span>.<span class="ruby-identifier">recv</span>(<span class="ruby-ivar">@bufsize</span>, <span class="ruby-constant">Socket</span><span class="ruby-operator">::</span><span class="ruby-constant">MSG_OOB</span>)
<span class="ruby-keyword kw">end</span>
</pre>
</div>
</div>
</div>
<div id="method-M000093" class="method-detail">
<a name="M000093"></a>
<div class="method-heading">
<a href="#M000093" class="method-signature">
<span class="method-name">write</span><span class="method-args">(msg)</span>
</a>
</div>
<div class="method-description">
<p>
<a href="SockIO.html#M000093">write</a> will transmit a message to the
socket
</p>
<dl>
<dt><tt>msg</tt></dt><dd>The message string to be sent.
</dd>
<dt><tt>return</tt></dt><dd>false if more data to be written, true if all data written
</dd>
<dt><tt>IOError</tt></dt><dd>A sockets error occurred.
</dd>
<dt><tt>EOFError</tt></dt><dd>The connection has closed normally.
</dd>
</dl>
<p><a class="source-toggle" href="#"
onclick="toggleCode('M000093-source');return false;">[Source]</a></p>
<div class="method-source-code" id="M000093-source">
<pre>
<span class="ruby-comment cmt"># File lib/network/sockio.rb, line 46</span>
<span class="ruby-keyword kw">def</span> <span class="ruby-identifier">write</span>(<span class="ruby-identifier">msg</span>)
<span class="ruby-ivar">@outbuffer</span> <span class="ruby-operator"><<</span> <span class="ruby-identifier">msg</span>
<span class="ruby-identifier">n</span> = <span class="ruby-ivar">@sock</span>.<span class="ruby-identifier">send</span>(<span class="ruby-ivar">@outbuffer</span>, <span class="ruby-value">0</span>)
<span class="ruby-comment cmt"># save unsent data for next call</span>
<span class="ruby-ivar">@outbuffer</span>.<span class="ruby-identifier">slice!</span>(<span class="ruby-value">0</span><span class="ruby-operator">...</span><span class="ruby-identifier">n</span>)
<span class="ruby-ivar">@outbuffer</span>.<span class="ruby-identifier">size</span> <span class="ruby-operator">==</span> <span class="ruby-value">0</span>
<span class="ruby-keyword kw">rescue</span> <span class="ruby-constant">Exception</span>
<span class="ruby-ivar">@outbuffer</span> = <span class="ruby-value str">""</span> <span class="ruby-comment cmt"># Does it really matter?</span>
<span class="ruby-identifier">raise</span>
<span class="ruby-keyword kw">end</span>
</pre>
</div>
</div>
</div>
<div id="method-M000094" class="method-detail">
<a name="M000094"></a>
<div class="method-heading">
<a href="#M000094" class="method-signature">
<span class="method-name">write_flush</span><span class="method-args">()</span>
</a>
</div>
<div class="method-description">
<p>
<a href="SockIO.html#M000094">write_flush</a> will kill the output buffer
</p>
<p><a class="source-toggle" href="#"
onclick="toggleCode('M000094-source');return false;">[Source]</a></p>
<div class="method-source-code" id="M000094-source">
<pre>
<span class="ruby-comment cmt"># File lib/network/sockio.rb, line 58</span>
<span class="ruby-keyword kw">def</span> <span class="ruby-identifier">write_flush</span>
<span class="ruby-ivar">@outbuffer</span> = <span class="ruby-value str">""</span>
<span class="ruby-keyword kw">end</span>
</pre>
</div>
</div>
</div>
<div id="method-M000097" class="method-detail">
<a name="M000097"></a>
<div class="method-heading">
<a href="#M000097" class="method-signature">
<span class="method-name">write_urgent</span><span class="method-args">(msg)</span>
</a>
</div>
<div class="method-description">
<p>
<a href="SockIO.html#M000097">write_urgent</a> will <a
href="SockIO.html#M000093">write</a> urgent data to the socket.
</p>
<dl>
<dt><tt>msg</tt></dt><dd>The message string to be sent.
</dd>
<dt><tt>IOError</tt></dt><dd>A sockets error occurred.
</dd>
<dt><tt>EOFError</tt></dt><dd>The connection has closed normally.
</dd>
</dl>
<p><a class="source-toggle" href="#"
onclick="toggleCode('M000097-source');return false;">[Source]</a></p>
<div class="method-source-code" id="M000097-source">
<pre>
<span class="ruby-comment cmt"># File lib/network/sockio.rb, line 81</span>
<span class="ruby-keyword kw">def</span> <span class="ruby-identifier">write_urgent</span>(<span class="ruby-identifier">msg</span>)
<span class="ruby-ivar">@sock</span>.<span class="ruby-identifier">send</span>(<span class="ruby-identifier">msg</span>, <span class="ruby-constant">Socket</span><span class="ruby-operator">::</span><span class="ruby-constant">MSG_OOB</span>)
<span class="ruby-keyword kw">end</span>
</pre>
</div>
</div>
</div>
</div>
</div>
<div id="validator-badges">
<p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
</div>
</body>
</html>
