| <!DOCTYPE html> |
| <html> |
| <head> |
| <meta charset="utf-8"> |
| <meta name="viewport" content="width=device-width, initial-scale=1.0"> |
| <title> |
| Class: Qpid::Proton::MessagingHandler |
| |
| — 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::MessagingHandler"; |
| 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 (M)</a> » |
| <span class='title'><span class='object_link'><a href="../../Qpid.html" title="Qpid (module)">Qpid</a></span></span> » <span class='title'><span class='object_link'><a href="../Proton.html" title="Qpid::Proton (module)">Proton</a></span></span> |
| » |
| <span class="title">MessagingHandler</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::MessagingHandler |
| |
| |
| |
| </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::MessagingHandler</li> |
| |
| </ul> |
| <a href="#" class="inheritanceTree">show all</a> |
| |
| </dd> |
| </dl> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <dl> |
| <dt>Defined in:</dt> |
| <dd>lib/core/messaging_handler.rb</dd> |
| </dl> |
| |
| </div> |
| |
| <h2>Overview</h2><div class="docstring"> |
| <div class="discussion"> |
| |
| <p>A handler for AMQP messaging events.</p> |
| |
| <p>Subclass the handler and provide the #on_xxx methods with your event-handling code.</p> |
| |
| <p>An AMQP endpoint (connection, session or link) must be opened and closed at each end. Normally proton responds automatically to an incoming open/close. You can prevent the automatic response by raising <span class='object_link'><a href="StopAutoResponse.html" title="Qpid::Proton::StopAutoResponse (class)">StopAutoResponse</a></span> from <code>#on_xxx_open</code> or <code>#on_xxx_close</code>. The application becomes responsible for calling <tt>#open/#close</tt> at a later point.</p> |
| |
| <p><strong>Note</strong>: If a <span class='object_link'><a href="" title="Qpid::Proton::MessagingHandler (class)">MessagingHandler</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 Attribute Summary <small><a href="#" class="summary_toggle">collapse</a></small></h2> |
| <ul class="summary"> |
| |
| <li class="public "> |
| <span class="summary_signature"> |
| |
| <a href="#options-instance_method" title="#options (instance method)">#<strong>options</strong> ⇒ Hash </a> |
| |
| |
| |
| </span> |
| |
| |
| |
| |
| <span class="note title readonly">readonly</span> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <span class="summary_desc"><div class='inline'> |
| <p>Handler options, see #initialize.</p> |
| </div></span> |
| |
| </li> |
| |
| |
| </ul> |
| |
| |
| |
| |
| |
| <div id="instance_attr_details" class="attr_details"> |
| <h2>Instance Attribute Details</h2> |
| |
| |
| <span id=""></span> |
| <div class="method_details first"> |
| <h3 class="signature first" id="options-instance_method"> |
| |
| #<strong>options</strong> ⇒ <tt><span class='object_link'>Hash</span></tt> <span class="extras">(readonly)</span> |
| |
| |
| |
| |
| |
| </h3><div class="docstring"> |
| <div class="discussion"> |
| |
| <p>Returns handler options, see #initialize.</p> |
| |
| |
| </div> |
| </div> |
| <div class="tags"> |
| |
| <p class="tag_title">Returns:</p> |
| <ul class="return"> |
| |
| <li> |
| |
| |
| <span class='type'>(<tt><span class='object_link'>Hash</span></tt>)</span> |
| |
| |
| |
| — |
| <div class='inline'> |
| <p>handler options, see #initialize</p> |
| </div> |
| |
| </li> |
| |
| </ul> |
| |
| </div><table class="source_code"> |
| <tr> |
| <td> |
| <pre class="lines"> |
| |
| |
| 37 |
| 38 |
| 39</pre> |
| </td> |
| <td> |
| <pre class="code"><span class="info file"># File 'lib/core/messaging_handler.rb', line 37</span> |
| |
| <span class='kw'>def</span> <span class='id identifier rubyid_options'>options</span> |
| <span class='ivar'>@options</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> |
