<?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: PacketIO</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">PacketIO</td>
</tr>
<tr class="top-aligned-row">
<td><strong>In:</strong></td>
<td>
<a href="../files/lib/network/packetio_rb.html">
lib/network/packetio.rb
</a>
<br />
</td>
</tr>
<tr class="top-aligned-row">
<td><strong>Parent:</strong></td>
<td>
<a href="SockIO.html">
SockIO
</a>
</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,101,80,149" href="PacketIO.html" alt="PacketIO
" />
<area shape="rect" coords="7,5,79,53" href="SockIO.html" alt="SockIO
" />
</map>
<img src="../dot/f_28.png" usemap="#map" border="0" alt="dot/f_28.png">
</div>
<div id="description">
<p>
The <a href="PacketIO.html">PacketIO</a> class implements a mechanism to
send and recv packets delimited by a length prefix which is assumed to be a
4 bytes integer in network byte order.
</p>
</div>
</div>
<div id="method-list">
<h3 class="section-bar">Methods</h3>
<div class="name-list">
<a href="#M000173">new</a>
<a href="#M000174">read</a>
<a href="#M000175">write</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-M000173" class="method-detail">
<a name="M000173"></a>
<div class="method-heading">
<a href="#M000173" class="method-signature">
<span class="method-name">new</span><span class="method-args">(sock, bufsize=16380)</span>
</a>
</div>
<div class="method-description">
<p>
Creates a <a href="PacketIO.html#M000173">new</a> PackIO 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 16K)
</dd>
</dl>
<p><a class="source-toggle" href="#"
onclick="toggleCode('M000173-source');return false;">[Source]</a></p>
<div class="method-source-code" id="M000173-source">
<pre>
<span class="ruby-comment cmt"># File lib/network/packetio.rb, line 29</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">16380</span>)
<span class="ruby-ivar">@sock</span> = <span class="ruby-identifier">sock</span>
<span class="ruby-ivar">@bufsize</span> = <span class="ruby-identifier">bufsize</span> <span class="ruby-operator">+</span> <span class="ruby-value">4</span> <span class="ruby-comment cmt"># round out with prefix bytes</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-ivar">@packet_size</span> = <span class="ruby-value">0</span>
<span class="ruby-ivar">@prefix_found</span> = <span class="ruby-keyword kw">false</span>
<span class="ruby-keyword kw">end</span>
</pre>
</div>
</div>
</div>
<h3 class="section-bar">Public Instance methods</h3>
<div id="method-M000174" class="method-detail">
<a name="M000174"></a>
<div class="method-heading">
<a href="#M000174" class="method-signature">
<span class="method-name">read</span><span class="method-args">()</span>
</a>
</div>
<div class="method-description">
<p>
<a href="PacketIO.html#M000174">read</a> will receive a data from the
socket.
</p>
<dl>
<dt><tt>return</tt></dt><dd>The data <a href="PacketIO.html#M000174">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('M000174-source');return false;">[Source]</a></p>
<div class="method-source-code" id="M000174-source">
<pre>
<span class="ruby-comment cmt"># File lib/network/packetio.rb, line 43</span>
<span class="ruby-keyword kw">def</span> <span class="ruby-identifier">read</span>
<span class="ruby-ivar">@inbuffer</span> <span class="ruby-operator"><<</span> <span class="ruby-ivar">@sock</span>.<span class="ruby-identifier">recv</span>(<span class="ruby-ivar">@bufsize</span>)
<span class="ruby-keyword kw">if</span> <span class="ruby-operator">!</span><span class="ruby-ivar">@prefix_found</span>
<span class="ruby-comment cmt"># start of packet</span>
<span class="ruby-keyword kw">if</span> <span class="ruby-ivar">@inbuffer</span>.<span class="ruby-identifier">size</span> <span class="ruby-operator">>=</span> <span class="ruby-value">4</span>
<span class="ruby-identifier">sizest</span> = <span class="ruby-ivar">@inbuffer</span>.<span class="ruby-identifier">slice!</span>(<span class="ruby-value">0</span><span class="ruby-operator">..</span><span class="ruby-value">3</span>)
<span class="ruby-ivar">@packet_size</span> = <span class="ruby-identifier">sizest</span>.<span class="ruby-identifier">unpack</span>(<span class="ruby-value str">"N"</span>)[<span class="ruby-value">0</span>]
<span class="ruby-ivar">@prefix_found</span> = <span class="ruby-keyword kw">true</span>
<span class="ruby-keyword kw">if</span> <span class="ruby-ivar">@packet_size</span> <span class="ruby-operator">></span> <span class="ruby-ivar">@bufsize</span>
<span class="ruby-ivar">@inbuffer</span> = <span class="ruby-value str">""</span>
<span class="ruby-ivar">@packet_size</span> = <span class="ruby-value">0</span>
<span class="ruby-ivar">@prefix_found</span> = <span class="ruby-keyword kw">false</span>
<span class="ruby-identifier">log</span>.<span class="ruby-identifier">warn</span> <span class="ruby-node">"Discarding packet: Buffer size exceeded (PACKETSIZE=#{@packet_size} STRING='#{sizest}')"</span>
<span class="ruby-keyword kw">return</span> <span class="ruby-keyword kw">nil</span>
<span class="ruby-keyword kw">end</span>
<span class="ruby-keyword kw">else</span>
<span class="ruby-keyword kw">return</span> <span class="ruby-keyword kw">nil</span> <span class="ruby-comment cmt"># not enough data yet</span>
<span class="ruby-keyword kw">end</span>
<span class="ruby-keyword kw">end</span>
<span class="ruby-keyword kw">if</span> <span class="ruby-ivar">@prefix_found</span>
<span class="ruby-keyword kw">if</span> <span class="ruby-ivar">@inbuffer</span>.<span class="ruby-identifier">size</span> <span class="ruby-operator">>=</span> <span class="ruby-ivar">@packet_size</span>
<span class="ruby-comment cmt"># We have it</span>
<span class="ruby-ivar">@prefix_found</span> = <span class="ruby-keyword kw">false</span>
<span class="ruby-identifier">ps</span> = <span class="ruby-ivar">@packet_size</span>
<span class="ruby-ivar">@packet_size</span> = <span class="ruby-value">0</span>
<span class="ruby-keyword kw">return</span> <span class="ruby-ivar">@inbuffer</span>.<span class="ruby-identifier">slice!</span>(<span class="ruby-value">0</span><span class="ruby-operator">...</span><span class="ruby-identifier">ps</span>).<span class="ruby-identifier">chop</span> <span class="ruby-comment cmt"># chop off NUL</span>
<span class="ruby-keyword kw">else</span>
<span class="ruby-comment cmt"># Dont have it all yet.</span>
<span class="ruby-keyword kw">return</span> <span class="ruby-keyword kw">nil</span>
<span class="ruby-keyword kw">end</span>
<span class="ruby-keyword kw">end</span>
<span class="ruby-keyword kw">end</span>
</pre>
</div>
</div>
</div>
<div id="method-M000175" class="method-detail">
<a name="M000175"></a>
<div class="method-heading">
<a href="#M000175" class="method-signature">
<span class="method-name">write</span><span class="method-args">(msg)</span>
</a>
</div>
<div class="method-description">
<p>
<a href="PacketIO.html#M000175">write</a> will transmit a packet to the
socket, we calculated the size here
</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('M000175-source');return false;">[Source]</a></p>
<div class="method-source-code" id="M000175-source">
<pre>
<span class="ruby-comment cmt"># File lib/network/packetio.rb, line 83</span>
<span class="ruby-keyword kw">def</span> <span class="ruby-identifier">write</span>(<span class="ruby-identifier">msg</span>)
<span class="ruby-keyword kw">if</span> <span class="ruby-operator">!</span><span class="ruby-identifier">msg</span>.<span class="ruby-identifier">nil?</span> <span class="ruby-operator">&&</span> <span class="ruby-operator">!</span><span class="ruby-identifier">msg</span>.<span class="ruby-identifier">empty?</span>
<span class="ruby-ivar">@outbuffer</span> <span class="ruby-operator"><<</span> [<span class="ruby-identifier">msg</span>.<span class="ruby-identifier">length</span>].<span class="ruby-identifier">pack</span>(<span class="ruby-value str">"N"</span>) <span class="ruby-operator"><<</span> <span class="ruby-identifier">msg</span>
<span class="ruby-keyword kw">end</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>
</div>
<div id="validator-badges">
<p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
</div>
</body>
</html>
