Google Git
Sign in
apache / qpid-site / 04beb6e78eda47fdfc2fcfc1d2eeb9a270f89a87 / . / content / releases / qpid-proton-0.32.0 / proton / ruby / api / Qpid / Proton / Listener / Handler.html
blob: 9a52f499d0b461d207fece157744e28c0a6a6b05 [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::Listener::Handler
&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::Listener::Handler";
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 (H)</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="../Listener.html" title="Qpid::Proton::Listener (class)">Listener</a></span></span>
&raquo;
<span class="title">Handler</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::Listener::Handler
</h1>
<div class="box_info">
<dl>
<dt>Inherits:</dt>
<dd>
<span class="inheritName">Object</span>
<ul class="fullTree">
<li>Object</li>
<li class="next">Qpid::Proton::Listener::Handler</li>
</ul>
<a href="#" class="inheritanceTree">show all</a>
</dd>
</dl>
<dl>
<dt>Defined in:</dt>
<dd>lib/core/listener.rb</dd>
</dl>
</div>
<h2>Overview</h2><div class="docstring">
<div class="discussion">
<p>Class that handles listener events and provides options for accepted connections. This class simply returns a fixed set of options for every connection accepted, but you can subclass and override all of the on_ methods to provide more interesting behaviour.</p>
<p><strong>Note</strong>: If a <span class='object_link'><a href="../Listener.html" title="Qpid::Proton::Listener (class)">Qpid::Proton::Listener</a></span> method raises an exception, it will stop the <span class='object_link'><a href="../Container.html" title="Qpid::Proton::Container (class)">Container</a></span> that the handler is running in. See <span class='object_link'><a href="../Container.html#run-instance_method" title="Qpid::Proton::Container#run (method)">Container#run</a></span></p>
</div>
</div>
<div class="tags">
</div>
<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="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(opts = nil) &#x21d2; Handler </a>
</span>
<span class="note title constructor">constructor</span>
<span class="summary_desc"><div class='inline'>
<p>A new instance of Handler.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#on_accept-instance_method" title="#on_accept (instance method)">#<strong>on_accept</strong>(listener) &#x21d2; Hash </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Called when a listener accepts a new connection.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#on_close-instance_method" title="#on_close (instance method)">#<strong>on_close</strong>(listener) </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Called when the listener closes.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#on_error-instance_method" title="#on_error (instance method)">#<strong>on_error</strong>(listener, what) </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Called if an error occurs.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#on_open-instance_method" title="#on_open (instance method)">#<strong>on_open</strong>(listener) </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Called when the listener is ready to accept connections.</p>
</div></span>
</li>
</ul>
<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>(opts = nil) &#x21d2; <tt><span class='object_link'><a href="" title="Qpid::Proton::Listener::Handler (class)">Handler</a></span></tt>
</h3><div class="docstring">
<div class="discussion">
<p>Returns a new instance of Handler.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>opts</span>
<span class='type'>(<tt><span class='object_link'>Hash</span></tt>)</span>
<em class="default">(defaults to: <tt>nil</tt>)</em>
&mdash;
<div class='inline'>
<p>Options to return from on_accept.</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
37</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/core/listener.rb', line 37</span>
<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='id identifier rubyid_opts'>opts</span><span class='op'>=</span><span class='kw'>nil</span><span class='rparen'>)</span> <span class='ivar'>@opts</span> <span class='op'>=</span> <span class='id identifier rubyid_opts'>opts</span> <span class='op'>||</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='semicolon'>;</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="on_accept-instance_method">
#<strong>on_accept</strong>(listener) &#x21d2; <tt><span class='object_link'>Hash</span></tt>
</h3><div class="docstring">
<div class="discussion">
<p>Called when a listener accepts a new connection.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>listener</span>
<span class='type'>(<tt><span class='object_link'><a href="../Listener.html" title="Qpid::Proton::Listener (class)">Listener</a></span></tt>)</span>
&mdash;
<div class='inline'>
<p>The listener</p>
</div>
</li>
</ul>
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt><span class='object_link'>Hash</span></tt>)</span>
&mdash;
<div class='inline'>
<p>Options to apply to the incoming connection, see #connect</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
53</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/core/listener.rb', line 53</span>
<span class='kw'>def</span> <span class='id identifier rubyid_on_accept'>on_accept</span><span class='lparen'>(</span><span class='id identifier rubyid_listener'>listener</span><span class='rparen'>)</span> <span class='ivar'>@opts</span><span class='semicolon'>;</span> <span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="on_close-instance_method">
#<strong>on_close</strong>(listener)
</h3><div class="docstring">
<div class="discussion">
<p>Called when the listener closes.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>listener</span>
<span class='type'>(<tt><span class='object_link'><a href="../Listener.html" title="Qpid::Proton::Listener (class)">Listener</a></span></tt>)</span>
&mdash;
<div class='inline'>
<p>The listener accepting the connection.</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
57</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/core/listener.rb', line 57</span>
<span class='kw'>def</span> <span class='id identifier rubyid_on_close'>on_close</span><span class='lparen'>(</span><span class='id identifier rubyid_listener'>listener</span><span class='rparen'>)</span> <span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="on_error-instance_method">
#<strong>on_error</strong>(listener, what)
</h3><div class="docstring">
<div class="discussion">
<p>Called if an error occurs. If there is an error while opening the listener, this method is called and <span class='object_link'><a href="#on_open-instance_method" title="Qpid::Proton::Listener::Handler#on_open (method)">#on_open</a></span> is not</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>listener</span>
<span class='type'>(<tt><span class='object_link'><a href="../Listener.html" title="Qpid::Proton::Listener (class)">Listener</a></span></tt>)</span>
</li>
<li>
<span class='name'>what</span>
<span class='type'>(<tt><span class='object_link'><a href="../Condition.html" title="Qpid::Proton::Condition (class)">Condition</a></span></tt>)</span>
&mdash;
<div class='inline'>
<p>Information about the error.</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
48</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/core/listener.rb', line 48</span>
<span class='kw'>def</span> <span class='id identifier rubyid_on_error'>on_error</span><span class='lparen'>(</span><span class='id identifier rubyid_listener'>listener</span><span class='comma'>,</span> <span class='id identifier rubyid_what'>what</span><span class='rparen'>)</span> <span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="on_open-instance_method">
#<strong>on_open</strong>(listener)
</h3><div class="docstring">
<div class="discussion">
<p>Called when the listener is ready to accept connections.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>listener</span>
<span class='type'>(<tt><span class='object_link'><a href="../Listener.html" title="Qpid::Proton::Listener (class)">Listener</a></span></tt>)</span>
&mdash;
<div class='inline'>
<p>The listener</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
41</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/core/listener.rb', line 41</span>
<span class='kw'>def</span> <span class='id identifier rubyid_on_open'>on_open</span><span class='lparen'>(</span><span class='id identifier rubyid_listener'>listener</span><span class='rparen'>)</span> <span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
</div>
<div id="footer">
Generated on Wed Nov 11 12:57:52 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>