blob: ee4de9f472ad66f6e64ec3d8f341c0057e941225 [file] [log] [blame]
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
Class: Qpid::Proton::Container::ConnectionTask
&mdash; Qpid Proton Ruby API
</title>
<link rel="stylesheet" href="../../../css/style.css" type="text/css" />
<link rel="stylesheet" href="../../../css/common.css" type="text/css" />
<script type="text/javascript">
pathId = "Qpid::Proton::Container::ConnectionTask";
relpath = '../../../';
</script>
<script type="text/javascript" charset="utf-8" src="../../../js/jquery.js"></script>
<script type="text/javascript" charset="utf-8" src="../../../js/app.js"></script>
</head>
<body>
<div class="nav_wrap">
<iframe id="nav" src="../../../class_list.html?1"></iframe>
<div id="resizer"></div>
</div>
<div id="main" tabindex="-1">
<div id="header">
<div id="menu">
<a href="../../../_index.html">Index (C)</a> &raquo;
<span class='title'><span class='object_link'><a href="../../../Qpid.html" title="Qpid (module)">Qpid</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../../Proton.html" title="Qpid::Proton (module)">Proton</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Container.html" title="Qpid::Proton::Container (class)">Container</a></span></span>
&raquo;
<span class="title">ConnectionTask</span>
</div>
<div id="search">
<a class="full_list_link" id="class_list_link"
href="../../../class_list.html">
<svg width="24" height="24">
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
</svg>
</a>
</div>
<div class="clear"></div>
</div>
<div id="content"><h1>Class: Qpid::Proton::Container::ConnectionTask
</h1>
<div class="box_info">
<dl>
<dt>Inherits:</dt>
<dd>
<span class="inheritName"><span class='object_link'><a href="../HandlerDriver.html" title="Qpid::Proton::HandlerDriver (class)">HandlerDriver</a></span></span>
<ul class="fullTree">
<li>Object</li>
<li class="next"><span class='object_link'><a href="../ConnectionDriver.html" title="Qpid::Proton::ConnectionDriver (class)">Qpid::Proton::ConnectionDriver</a></span></li>
<li class="next"><span class='object_link'><a href="../HandlerDriver.html" title="Qpid::Proton::HandlerDriver (class)">HandlerDriver</a></span></li>
<li class="next">Qpid::Proton::Container::ConnectionTask</li>
</ul>
<a href="#" class="inheritanceTree">show all</a>
</dd>
</dl>
<dl>
<dt>Defined in:</dt>
<dd>lib/core/container.rb</dd>
</dl>
</div>
<div class="docstring">
<div class="discussion">
</div>
</div>
<div class="tags">
</div>
<h2>Instance Attribute Summary</h2>
<h3 class="inherited">Attributes inherited from <span class='object_link'><a href="../HandlerDriver.html" title="Qpid::Proton::HandlerDriver (class)">HandlerDriver</a></span></h3>
<p class="inherited"><span class='object_link'><a href="../HandlerDriver.html#handler-instance_method" title="Qpid::Proton::HandlerDriver#handler (method)">#handler</a></span></p>
<h2>
Instance Method Summary
<small><a href="#" class="summary_toggle">collapse</a></small>
</h2>
<ul class="summary">
<li class="public ">
<span class="summary_signature">
<a href="#dispatch-instance_method" title="#dispatch (instance method)">#<strong>dispatch</strong> </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Intercept dispatch to close work_queue.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(container, io, opts, server = false) &#x21d2; ConnectionTask </a>
</span>
<span class="note title constructor">constructor</span>
<span class="summary_desc"><div class='inline'>
<p>A new instance of ConnectionTask.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#next_tick-instance_method" title="#next_tick (instance method)">#<strong>next_tick</strong> </a>
</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#process-instance_method" title="#process (instance method)">#<strong>process</strong>(now) </a>
</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
</ul>
<h3 class="inherited">Methods inherited from <span class='object_link'><a href="../ConnectionDriver.html" title="Qpid::Proton::ConnectionDriver (class)">Qpid::Proton::ConnectionDriver</a></span></h3>
<p class="inherited"><span class='object_link'><a href="../ConnectionDriver.html#can_read%3F-instance_method" title="Qpid::Proton::ConnectionDriver#can_read? (method)">#can_read?</a></span>, <span class='object_link'><a href="../ConnectionDriver.html#can_write%3F-instance_method" title="Qpid::Proton::ConnectionDriver#can_write? (method)">#can_write?</a></span>, <span class='object_link'><a href="../ConnectionDriver.html#close-instance_method" title="Qpid::Proton::ConnectionDriver#close (method)">#close</a></span>, <span class='object_link'><a href="../ConnectionDriver.html#close_read-instance_method" title="Qpid::Proton::ConnectionDriver#close_read (method)">#close_read</a></span>, <span class='object_link'><a href="../ConnectionDriver.html#close_write-instance_method" title="Qpid::Proton::ConnectionDriver#close_write (method)">#close_write</a></span>, <span class='object_link'><a href="../ConnectionDriver.html#connection-instance_method" title="Qpid::Proton::ConnectionDriver#connection (method)">#connection</a></span>, <span class='object_link'><a href="../ConnectionDriver.html#each_event-instance_method" title="Qpid::Proton::ConnectionDriver#each_event (method)">#each_event</a></span>, <span class='object_link'><a href="../ConnectionDriver.html#event-instance_method" title="Qpid::Proton::ConnectionDriver#event (method)">#event</a></span>, <span class='object_link'><a href="../ConnectionDriver.html#event%3F-instance_method" title="Qpid::Proton::ConnectionDriver#event? (method)">#event?</a></span>, <span class='object_link'><a href="../ConnectionDriver.html#finished%3F-instance_method" title="Qpid::Proton::ConnectionDriver#finished? (method)">#finished?</a></span>, <span class='object_link'><a href="../ConnectionDriver.html#read-instance_method" title="Qpid::Proton::ConnectionDriver#read (method)">#read</a></span>, <span class='object_link'><a href="../ConnectionDriver.html#read_closed%3F-instance_method" title="Qpid::Proton::ConnectionDriver#read_closed? (method)">#read_closed?</a></span>, <span class='object_link'><a href="../ConnectionDriver.html#tick-instance_method" title="Qpid::Proton::ConnectionDriver#tick (method)">#tick</a></span>, <span class='object_link'><a href="../ConnectionDriver.html#to_io-instance_method" title="Qpid::Proton::ConnectionDriver#to_io (method)">#to_io</a></span>, <span class='object_link'><a href="../ConnectionDriver.html#transport-instance_method" title="Qpid::Proton::ConnectionDriver#transport (method)">#transport</a></span>, <span class='object_link'><a href="../ConnectionDriver.html#write-instance_method" title="Qpid::Proton::ConnectionDriver#write (method)">#write</a></span>, <span class='object_link'><a href="../ConnectionDriver.html#write_closed%3F-instance_method" title="Qpid::Proton::ConnectionDriver#write_closed? (method)">#write_closed?</a></span></p>
<div id="constructor_details" class="method_details_list">
<h2>Constructor Details</h2>
<div class="method_details first">
<h3 class="signature first" id="initialize-instance_method">
#<strong>initialize</strong>(container, io, opts, server = false) &#x21d2; <tt><span class='object_link'><a href="" title="Qpid::Proton::Container::ConnectionTask (class)">ConnectionTask</a></span></tt>
</h3><div class="docstring">
<div class="discussion">
<p>Returns a new instance of ConnectionTask.</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
258
259
260
261
262
263
264
265</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/core/container.rb', line 258</span>
<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span> <span class='id identifier rubyid_container'>container</span><span class='comma'>,</span> <span class='id identifier rubyid_io'>io</span><span class='comma'>,</span> <span class='id identifier rubyid_opts'>opts</span><span class='comma'>,</span> <span class='id identifier rubyid_server'>server</span><span class='op'>=</span><span class='kw'>false</span>
<span class='kw'>super</span> <span class='id identifier rubyid_io'>io</span><span class='comma'>,</span> <span class='id identifier rubyid_opts'>opts</span><span class='lbracket'>[</span><span class='symbol'>:handler</span><span class='rbracket'>]</span>
<span class='id identifier rubyid_transport'>transport</span><span class='period'>.</span><span class='id identifier rubyid_set_server'>set_server</span> <span class='kw'>if</span> <span class='id identifier rubyid_server'>server</span>
<span class='id identifier rubyid_transport'>transport</span><span class='period'>.</span><span class='id identifier rubyid_apply'>apply</span> <span class='id identifier rubyid_opts'>opts</span>
<span class='id identifier rubyid_connection'>connection</span><span class='period'>.</span><span class='id identifier rubyid_apply'>apply</span> <span class='id identifier rubyid_opts'>opts</span>
<span class='ivar'>@work_queue</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="../WorkQueue.html" title="Qpid::Proton::WorkQueue (class)">WorkQueue</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='id identifier rubyid_container'>container</span><span class='rparen'>)</span>
<span class='id identifier rubyid_connection'>connection</span><span class='period'>.</span><span class='id identifier rubyid_instance_variable_set'>instance_variable_set</span><span class='lparen'>(</span><span class='symbol'>:@work_queue</span><span class='comma'>,</span> <span class='ivar'>@work_queue</span><span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
<div id="instance_method_details" class="method_details_list">
<h2>Instance Method Details</h2>
<div class="method_details first">
<h3 class="signature first" id="dispatch-instance_method">
#<strong>dispatch</strong>
</h3><div class="docstring">
<div class="discussion">
<p>Intercept dispatch to close work_queue</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
269
270
271
272</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/core/container.rb', line 269</span>
<span class='kw'>def</span> <span class='id identifier rubyid_dispatch'>dispatch</span> <span class='comment'># Intercept dispatch to close work_queue
</span> <span class='kw'>super</span>
<span class='ivar'>@work_queue</span><span class='period'>.</span><span class='id identifier rubyid_close'>close</span> <span class='kw'>if</span> <span class='id identifier rubyid_read_closed?'>read_closed?</span> <span class='op'>&amp;&amp;</span> <span class='id identifier rubyid_write_closed?'>write_closed?</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="next_tick-instance_method">
#<strong>next_tick</strong>
</h3><div class="docstring">
<div class="discussion">
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
266</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/core/container.rb', line 266</span>
<span class='kw'>def</span> <span class='id identifier rubyid_next_tick'>next_tick</span><span class='lparen'>(</span><span class='rparen'>)</span> <span class='id identifier rubyid_earliest'>earliest</span><span class='lparen'>(</span><span class='kw'>super</span><span class='comma'>,</span> <span class='ivar'>@work_queue</span><span class='period'>.</span><span class='id identifier rubyid_next_tick'>next_tick</span><span class='rparen'>)</span><span class='semicolon'>;</span> <span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="process-instance_method">
#<strong>process</strong>(now)
</h3><div class="docstring">
<div class="discussion">
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
267</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/core/container.rb', line 267</span>
<span class='kw'>def</span> <span class='id identifier rubyid_process'>process</span><span class='lparen'>(</span><span class='id identifier rubyid_now'>now</span><span class='rparen'>)</span> <span class='ivar'>@work_queue</span><span class='period'>.</span><span class='id identifier rubyid_process'>process</span><span class='lparen'>(</span><span class='id identifier rubyid_now'>now</span><span class='rparen'>)</span><span class='semicolon'>;</span> <span class='kw'>super</span><span class='lparen'>(</span><span class='rparen'>)</span><span class='semicolon'>;</span> <span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
</div>
<div id="footer">
Generated on Wed Nov 11 12:57:53 2020 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.24 (ruby-2.7.2).
</div>
</div>
</body>
</html>