| Current File : //proc/self/root/kunden/usr/share/gems/doc/memcache-client-1.8.5/rdoc/EM/SocketConnection.html |
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<title>module EM::SocketConnection - memcache-client-1.8.5 Documentation</title>
<script type="text/javascript">
var rdoc_rel_prefix = "../";
var index_rel_prefix = "../";
</script>
<script src="../js/navigation.js" defer></script>
<script src="../js/search.js" defer></script>
<script src="../js/search_index.js" defer></script>
<script src="../js/searcher.js" defer></script>
<script src="../js/darkfish.js" defer></script>
<link href="../css/fonts.css" rel="stylesheet">
<link href="../css/rdoc.css" rel="stylesheet">
<body id="top" role="document" class="module">
<nav role="navigation">
<div id="project-navigation">
<div id="home-section" role="region" title="Quick navigation" class="nav-section">
<h2>
<a href="../index.html" rel="home">Home</a>
</h2>
<div id="table-of-contents-navigation">
<a href="../table_of_contents.html#pages">Pages</a>
<a href="../table_of_contents.html#classes">Classes</a>
<a href="../table_of_contents.html#methods">Methods</a>
</div>
</div>
<div id="search-section" role="search" class="project-section initially-hidden">
<form action="#" method="get" accept-charset="utf-8">
<div id="search-field-wrapper">
<input id="search-field" role="combobox" aria-label="Search"
aria-autocomplete="list" aria-controls="search-results"
type="text" name="search" placeholder="Search" spellcheck="false"
title="Type to search, Up and Down to navigate, Enter to load">
</div>
<ul id="search-results" aria-label="Search Results"
aria-busy="false" aria-expanded="false"
aria-atomic="false" class="initially-hidden"></ul>
</form>
</div>
</div>
<div id="class-metadata">
<div id="includes-section" class="nav-section">
<h3>Included Modules</h3>
<ul class="link-list">
<li><span class="include">EM::Deferrable</span>
</ul>
</div>
<!-- Method Quickref -->
<div id="method-list-section" class="nav-section">
<h3>Methods</h3>
<ul class="link-list" role="directory">
<li ><a href="#method-c-connect">::connect</a>
<li ><a href="#method-c-new">::new</a>
<li ><a href="#method-i-can_read-3F">#can_read?</a>
<li ><a href="#method-i-close">#close</a>
<li ><a href="#method-i-closed-3F">#closed?</a>
<li ><a href="#method-i-gets">#gets</a>
<li ><a href="#method-i-post_init">#post_init</a>
<li ><a href="#method-i-read">#read</a>
<li ><a href="#method-i-receive_data">#receive_data</a>
<li ><a href="#method-i-unbind">#unbind</a>
<li ><a href="#method-i-write">#write</a>
<li ><a href="#method-i-yank">#yank</a>
</ul>
</div>
</div>
</nav>
<main role="main" aria-labelledby="module-EM::SocketConnection">
<h1 id="module-EM::SocketConnection" class="module">
module EM::SocketConnection
</h1>
<section class="description">
</section>
<section id="5Buntitled-5D" class="documentation-section">
<section class="constants-list">
<header>
<h3>Constants</h3>
</header>
<dl>
<dt id="BUFFER_SIZE">BUFFER_SIZE
<dd>
<dt id="SEP">SEP
<dd>
</dl>
</section>
<section id="public-class-5Buntitled-5D-method-details" class="method-section">
<header>
<h3>Public Class Methods</h3>
</header>
<div id="method-c-connect" class="method-detail ">
<div class="method-heading">
<span class="method-name">connect</span><span
class="method-args">(host, port, timeout)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="connect-source">
<pre><span class="ruby-comment"># File lib/memcache/event_machine.rb, line 67</span>
<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier ruby-title">connect</span>(<span class="ruby-identifier">host</span>, <span class="ruby-identifier">port</span>, <span class="ruby-identifier">timeout</span>)
<span class="ruby-constant">EM</span>.<span class="ruby-identifier">connect</span>(<span class="ruby-identifier">host</span>, <span class="ruby-identifier">port</span>, <span class="ruby-keyword">self</span>) <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">conn</span><span class="ruby-operator">|</span>
<span class="ruby-identifier">conn</span>.<span class="ruby-identifier">pending_connect_timeout</span> = <span class="ruby-identifier">timeout</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-c-new" class="method-detail ">
<div class="method-heading">
<span class="method-name">new</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="new-source">
<pre><span class="ruby-comment"># File lib/memcache/event_machine.rb, line 73</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">initialize</span>
<span class="ruby-ivar">@connected</span> = <span class="ruby-keyword">false</span>
<span class="ruby-ivar">@index</span> = <span class="ruby-value">0</span>
<span class="ruby-ivar">@buf</span> = <span class="ruby-string">''</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
</section>
<section id="public-instance-5Buntitled-5D-method-details" class="method-section">
<header>
<h3>Public Instance Methods</h3>
</header>
<div id="method-i-can_read-3F" class="method-detail ">
<div class="method-heading">
<span class="method-name">can_read?</span><span
class="method-args">(size)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="can_read-3F-source">
<pre><span class="ruby-comment"># File lib/memcache/event_machine.rb, line 127</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">can_read?</span>(<span class="ruby-identifier">size</span>)
<span class="ruby-ivar">@buf</span>.<span class="ruby-identifier">size</span> <span class="ruby-operator">>=</span> <span class="ruby-ivar">@index</span> <span class="ruby-operator">+</span> <span class="ruby-identifier">size</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-close" class="method-detail ">
<div class="method-heading">
<span class="method-name">close</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="close-source">
<pre><span class="ruby-comment"># File lib/memcache/event_machine.rb, line 83</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">close</span>
<span class="ruby-ivar">@connected</span> = <span class="ruby-keyword">false</span>
<span class="ruby-identifier">close_connection</span>(<span class="ruby-keyword">true</span>)
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-closed-3F" class="method-detail ">
<div class="method-heading">
<span class="method-name">closed?</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="closed-3F-source">
<pre><span class="ruby-comment"># File lib/memcache/event_machine.rb, line 79</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">closed?</span>
<span class="ruby-operator">!</span><span class="ruby-ivar">@connected</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-gets" class="method-detail ">
<div class="method-heading">
<span class="method-name">gets</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="gets-source">
<pre><span class="ruby-comment"># File lib/memcache/event_machine.rb, line 109</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">gets</span>
<span class="ruby-keyword">while</span> <span class="ruby-keyword">true</span>
<span class="ruby-comment"># Read to ensure we have some data in the buffer</span>
<span class="ruby-identifier">line</span> = <span class="ruby-identifier">read</span>(<span class="ruby-value">2</span>)
<span class="ruby-comment"># Reset the buffer index to zero</span>
<span class="ruby-ivar">@buf</span> = <span class="ruby-ivar">@buf</span>.<span class="ruby-identifier">slice</span>(<span class="ruby-ivar">@index</span><span class="ruby-operator">..</span><span class="ruby-value">-1</span>)
<span class="ruby-ivar">@index</span> = <span class="ruby-value">0</span>
<span class="ruby-keyword">if</span> <span class="ruby-identifier">eol</span> = <span class="ruby-ivar">@buf</span>.<span class="ruby-identifier">index</span>(<span class="ruby-constant">SEP</span>)
<span class="ruby-identifier">line</span> <span class="ruby-operator"><<</span> <span class="ruby-identifier">yank</span>(<span class="ruby-identifier">eol</span> <span class="ruby-operator">+</span> <span class="ruby-constant">SEP</span>.<span class="ruby-identifier">size</span>)
<span class="ruby-keyword">break</span>
<span class="ruby-keyword">else</span>
<span class="ruby-comment"># EOL not in the current buffer</span>
<span class="ruby-identifier">line</span> <span class="ruby-operator"><<</span> <span class="ruby-identifier">yank</span>(<span class="ruby-ivar">@buf</span>.<span class="ruby-identifier">size</span>)
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">line</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-post_init" class="method-detail ">
<div class="method-heading">
<span class="method-name">post_init</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="post_init-source">
<pre><span class="ruby-comment"># File lib/memcache/event_machine.rb, line 144</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">post_init</span>
<span class="ruby-ivar">@connected</span> = <span class="ruby-keyword">true</span>
<span class="ruby-identifier">succeed</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-read" class="method-detail ">
<div class="method-heading">
<span class="method-name">read</span><span
class="method-args">(size)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="read-source">
<pre><span class="ruby-comment"># File lib/memcache/event_machine.rb, line 92</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">read</span>(<span class="ruby-identifier">size</span>)
<span class="ruby-keyword">if</span> <span class="ruby-identifier">can_read?</span>(<span class="ruby-identifier">size</span>)
<span class="ruby-identifier">yank</span>(<span class="ruby-identifier">size</span>)
<span class="ruby-keyword">else</span>
<span class="ruby-identifier">fiber</span> = <span class="ruby-constant">Fiber</span>.<span class="ruby-identifier">current</span>
<span class="ruby-ivar">@size</span> = <span class="ruby-identifier">size</span>
<span class="ruby-ivar">@callback</span> = <span class="ruby-identifier">proc</span> { <span class="ruby-operator">|</span><span class="ruby-identifier">data</span><span class="ruby-operator">|</span>
<span class="ruby-identifier">fiber</span>.<span class="ruby-identifier">resume</span>(<span class="ruby-identifier">data</span>)
}
<span class="ruby-comment"># TODO Can leak fiber if the connection dies while</span>
<span class="ruby-comment"># this fiber is yielded, waiting for data</span>
<span class="ruby-constant">Fiber</span>.<span class="ruby-identifier">yield</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-receive_data" class="method-detail ">
<div class="method-heading">
<span class="method-name">receive_data</span><span
class="method-args">(data)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p><a href="../EM.html"><code>EM</code></a> callbacks</p>
<div class="method-source-code" id="receive_data-source">
<pre><span class="ruby-comment"># File lib/memcache/event_machine.rb, line 133</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">receive_data</span>(<span class="ruby-identifier">data</span>)
<span class="ruby-ivar">@buf</span> <span class="ruby-operator"><<</span> <span class="ruby-identifier">data</span>
<span class="ruby-keyword">if</span> <span class="ruby-ivar">@callback</span> <span class="ruby-keyword">and</span> <span class="ruby-identifier">can_read?</span>(<span class="ruby-ivar">@size</span>)
<span class="ruby-identifier">callback</span> = <span class="ruby-ivar">@callback</span>
<span class="ruby-identifier">data</span> = <span class="ruby-identifier">yank</span>(<span class="ruby-ivar">@size</span>)
<span class="ruby-ivar">@callback</span> = <span class="ruby-ivar">@size</span> = <span class="ruby-keyword">nil</span>
<span class="ruby-identifier">callback</span>.<span class="ruby-identifier">call</span>(<span class="ruby-identifier">data</span>)
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-unbind" class="method-detail ">
<div class="method-heading">
<span class="method-name">unbind</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="unbind-source">
<pre><span class="ruby-comment"># File lib/memcache/event_machine.rb, line 149</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">unbind</span>
<span class="ruby-keyword">if</span> <span class="ruby-ivar">@connected</span>
<span class="ruby-ivar">@connected</span> = <span class="ruby-keyword">false</span>
<span class="ruby-keyword">else</span>
<span class="ruby-identifier">fail</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-write" class="method-detail ">
<div class="method-heading">
<span class="method-name">write</span><span
class="method-args">(buf)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="write-source">
<pre><span class="ruby-comment"># File lib/memcache/event_machine.rb, line 88</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">write</span>(<span class="ruby-identifier">buf</span>)
<span class="ruby-identifier">send_data</span>(<span class="ruby-identifier">buf</span>)
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
</section>
<section id="private-instance-5Buntitled-5D-method-details" class="method-section">
<header>
<h3>Private Instance Methods</h3>
</header>
<div id="method-i-yank" class="method-detail ">
<div class="method-heading">
<span class="method-name">yank</span><span
class="method-args">(len)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="yank-source">
<pre><span class="ruby-comment"># File lib/memcache/event_machine.rb, line 161</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">yank</span>(<span class="ruby-identifier">len</span>)
<span class="ruby-identifier">data</span> = <span class="ruby-ivar">@buf</span>.<span class="ruby-identifier">slice</span>(<span class="ruby-ivar">@index</span>, <span class="ruby-identifier">len</span>)
<span class="ruby-ivar">@index</span> <span class="ruby-operator">+=</span> <span class="ruby-identifier">len</span>
<span class="ruby-ivar">@index</span> = <span class="ruby-ivar">@buf</span>.<span class="ruby-identifier">size</span> <span class="ruby-keyword">if</span> <span class="ruby-ivar">@index</span> <span class="ruby-operator">></span> <span class="ruby-ivar">@buf</span>.<span class="ruby-identifier">size</span>
<span class="ruby-keyword">if</span> <span class="ruby-ivar">@index</span> <span class="ruby-operator">>=</span> <span class="ruby-constant">BUFFER_SIZE</span>
<span class="ruby-ivar">@buf</span> = <span class="ruby-ivar">@buf</span>.<span class="ruby-identifier">slice</span>(<span class="ruby-ivar">@index</span><span class="ruby-operator">..</span><span class="ruby-value">-1</span>)
<span class="ruby-ivar">@index</span> = <span class="ruby-value">0</span>
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">data</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
</section>
</section>
</main>
<footer id="validator-badges" role="contentinfo">
<p><a href="https://validator.w3.org/check/referer">Validate</a>
<p>Generated by <a href="https://ruby.github.io/rdoc/">RDoc</a> 6.3.3.
<p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
</footer>