| <!DOCTYPE html> |
| <html> |
| <head> |
| <meta charset="utf-8"> |
| <meta name="viewport" content="width=device-width, initial-scale=1.0"> |
| <title> |
| Class: Qpid::Proton::Tracker |
| |
| — 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::Tracker"; |
| 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 (T)</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">Tracker</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::Tracker |
| |
| |
| |
| </h1> |
| <div class="box_info"> |
| |
| <dl> |
| <dt>Inherits:</dt> |
| <dd> |
| <span class="inheritName"><span class='object_link'><a href="Transfer.html" title="Qpid::Proton::Transfer (class)">Transfer</a></span></span> |
| |
| <ul class="fullTree"> |
| <li>Object</li> |
| |
| <li class="next"><span class='object_link'><a href="Transfer.html" title="Qpid::Proton::Transfer (class)">Transfer</a></span></li> |
| |
| <li class="next">Qpid::Proton::Tracker</li> |
| |
| </ul> |
| <a href="#" class="inheritanceTree">show all</a> |
| |
| </dd> |
| </dl> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <dl> |
| <dt>Defined in:</dt> |
| <dd>lib/core/tracker.rb</dd> |
| </dl> |
| |
| </div> |
| |
| <h2>Overview</h2><div class="docstring"> |
| <div class="discussion"> |
| |
| <p>Track the <span class='object_link'><a href="Transfer.html#State-constant" title="Qpid::Proton::Transfer::State (constant)">Qpid::Proton::Transfer::State</a></span> of a sent message.</p> |
| |
| |
| </div> |
| </div> |
| <div class="tags"> |
| |
| |
| </div> |
| |
| |
| <h2>Constant Summary</h2> |
| |
| <h3 class="inherited">Constants inherited |
| from <span class='object_link'><a href="Transfer.html" title="Qpid::Proton::Transfer (class)">Transfer</a></span></h3> |
| <p class="inherited"><span class='object_link'><a href="Transfer.html#PROTON_METHOD_PREFIX-constant" title="Qpid::Proton::Transfer::PROTON_METHOD_PREFIX (constant)">Qpid::Proton::Transfer::PROTON_METHOD_PREFIX</a></span>, <span class='object_link'><a href="Transfer.html#State-constant" title="Qpid::Proton::Transfer::State (constant)">Qpid::Proton::Transfer::State</a></span></p> |
| |
| |
| |
| <h3 class="inherited">Constants included |
| from <span class='object_link'><a href="Disposition/State.html" title="Qpid::Proton::Disposition::State (module)">Disposition::State</a></span></h3> |
| <p class="inherited"><span class='object_link'><a href="Disposition/State.html#ACCEPTED-constant" title="Qpid::Proton::Disposition::State::ACCEPTED (constant)">Disposition::State::ACCEPTED</a></span>, <span class='object_link'><a href="Disposition/State.html#MODIFIED-constant" title="Qpid::Proton::Disposition::State::MODIFIED (constant)">Disposition::State::MODIFIED</a></span>, <span class='object_link'><a href="Disposition/State.html#RECEIVED-constant" title="Qpid::Proton::Disposition::State::RECEIVED (constant)">Disposition::State::RECEIVED</a></span>, <span class='object_link'><a href="Disposition/State.html#REJECTED-constant" title="Qpid::Proton::Disposition::State::REJECTED (constant)">Disposition::State::REJECTED</a></span>, <span class='object_link'><a href="Disposition/State.html#RELEASED-constant" title="Qpid::Proton::Disposition::State::RELEASED (constant)">Disposition::State::RELEASED</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="#abort-instance_method" title="#abort (instance method)">#<strong>abort</strong> </a> |
| |
| |
| |
| </span> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <span class="summary_desc"><div class='inline'> |
| <p>Abort a partially-sent message.</p> |
| </div></span> |
| |
| </li> |
| |
| |
| <li class="public "> |
| <span class="summary_signature"> |
| |
| <a href="#modifications-instance_method" title="#modifications (instance method)">#<strong>modifications</strong> ⇒ Hash<sup>?</sup> </a> |
| |
| |
| |
| </span> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <span class="summary_desc"><div class='inline'> |
| <p>Re-delivery modifications sent by the receiver in <span class='object_link'><a href="Delivery.html#release-instance_method" title="Qpid::Proton::Delivery#release (method)">Delivery#release</a></span>.</p> |
| </div></span> |
| |
| </li> |
| |
| |
| <li class="public "> |
| <span class="summary_signature"> |
| |
| <a href="#sender-instance_method" title="#sender (instance method)">#<strong>sender</strong> ⇒ Sender </a> |
| |
| |
| |
| </span> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <span class="summary_desc"><div class='inline'> |
| <p>The parent <span class='object_link'><a href="Sender.html" title="Qpid::Proton::Sender (class)">Sender</a></span> link.</p> |
| </div></span> |
| |
| </li> |
| |
| |
| </ul> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <h3 class="inherited">Methods inherited from <span class='object_link'><a href="Transfer.html" title="Qpid::Proton::Transfer (class)">Transfer</a></span></h3> |
| <p class="inherited"><span class='object_link'><a href="Transfer.html#connection-instance_method" title="Qpid::Proton::Transfer#connection (method)">#connection</a></span>, <span class='object_link'><a href="Transfer.html#id-instance_method" title="Qpid::Proton::Transfer#id (method)">#id</a></span>, <span class='object_link'><a href="Transfer.html#initialize-instance_method" title="Qpid::Proton::Transfer#initialize (method)">#initialize</a></span>, <span class='object_link'><a href="Transfer.html#inspect-instance_method" title="Qpid::Proton::Transfer#inspect (method)">#inspect</a></span>, <span class='object_link'><a href="Transfer.html#link-instance_method" title="Qpid::Proton::Transfer#link (method)">#link</a></span>, <span class='object_link'><a href="Transfer.html#local_state-instance_method" title="Qpid::Proton::Transfer#local_state (method)">#local_state</a></span>, <span class='object_link'><a href="Transfer.html#session-instance_method" title="Qpid::Proton::Transfer#session (method)">#session</a></span>, <span class='object_link'><a href="Transfer.html#settle-instance_method" title="Qpid::Proton::Transfer#settle (method)">#settle</a></span>, <span class='object_link'><a href="Transfer.html#settled%3F-instance_method" title="Qpid::Proton::Transfer#settled? (method)">#settled?</a></span>, <span class='object_link'><a href="Transfer.html#state-instance_method" title="Qpid::Proton::Transfer#state (method)">#state</a></span>, <span class='object_link'><a href="Transfer.html#to_s-instance_method" title="Qpid::Proton::Transfer#to_s (method)">#to_s</a></span>, <span class='object_link'><a href="Transfer.html#transport-instance_method" title="Qpid::Proton::Transfer#transport (method)">#transport</a></span>, <span class='object_link'><a href="Transfer.html#update-instance_method" title="Qpid::Proton::Transfer#update (method)">#update</a></span>, <span class='object_link'><a href="Transfer.html#work_queue-instance_method" title="Qpid::Proton::Transfer#work_queue (method)">#work_queue</a></span>, <span class='object_link'><a href="Transfer.html#wrap-class_method" title="Qpid::Proton::Transfer.wrap (method)">wrap</a></span></p> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <h3 class="inherited">Methods included from <span class='object_link'><a href="Disposition/State/ClassMethods.html" title="Qpid::Proton::Disposition::State::ClassMethods (module)">Disposition::State::ClassMethods</a></span></h3> |
| <p class="inherited"><span class='object_link'><a href="Disposition/State/ClassMethods.html#name_of-instance_method" title="Qpid::Proton::Disposition::State::ClassMethods#name_of (method)">#name_of</a></span></p> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <div id="constructor_details" class="method_details_list"> |
| <h2>Constructor Details</h2> |
| |
| <p class="notice">This class inherits a constructor from <span class='object_link'><a href="Transfer.html#initialize-instance_method" title="Qpid::Proton::Transfer#initialize (method)">Qpid::Proton::Transfer</a></span></p> |
| |
| </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="abort-instance_method"> |
| |
| #<strong>abort</strong> |
| |
| |
| |
| |
| |
| </h3><div class="docstring"> |
| <div class="discussion"> |
| |
| <p>Abort a partially-sent message. The tracker can no longer be used after calling <span class='object_link'><a href="#abort-instance_method" title="Qpid::Proton::Tracker#abort (method)">#abort</a></span>.</p> |
| |
| |
| </div> |
| </div> |
| <div class="tags"> |
| |
| |
| </div><table class="source_code"> |
| <tr> |
| <td> |
| <pre class="lines"> |
| |
| |
| 41 |
| 42 |
| 43</pre> |
| </td> |
| <td> |
| <pre class="code"><span class="info file"># File 'lib/core/tracker.rb', line 41</span> |
| |
| <span class='kw'>def</span> <span class='id identifier rubyid_abort'>abort</span><span class='lparen'>(</span><span class='rparen'>)</span> |
| <span class='const'>Cproton</span><span class='period'>.</span><span class='id identifier rubyid_pn_delivery_abort'>pn_delivery_abort</span><span class='lparen'>(</span><span class='ivar'>@impl</span><span class='rparen'>)</span> |
| <span class='kw'>end</span></pre> |
| </td> |
| </tr> |
| </table> |
| </div> |
| |
| <div class="method_details "> |
| <h3 class="signature " id="modifications-instance_method"> |
| |
| #<strong>modifications</strong> ⇒ <tt><span class='object_link'>Hash</span></tt><sup>?</sup> |
| |
| |
| |
| |
| |
| </h3><div class="docstring"> |
| <div class="discussion"> |
| |
| <p>Re-delivery modifications sent by the receiver in <span class='object_link'><a href="Delivery.html#release-instance_method" title="Qpid::Proton::Delivery#release (method)">Delivery#release</a></span></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>See the <span class='object_link'><a href="Delivery.html#release-instance_method" title="Qpid::Proton::Delivery#release (method)">Delivery#release</a></span> <code>opts</code> parameter.</p> |
| </div> |
| |
| </li> |
| |
| <li> |
| |
| |
| <span class='type'>(<tt>nil</tt>)</span> |
| |
| |
| |
| — |
| <div class='inline'> |
| <p>If no modifications were requested by the receiver.</p> |
| </div> |
| |
| </li> |
| |
| </ul> |
| |
| </div><table class="source_code"> |
| <tr> |
| <td> |
| <pre class="lines"> |
| |
| |
| 29 |
| 30 |
| 31 |
| 32 |
| 33 |
| 34 |
| 35 |
| 36 |
| 37</pre> |
| </td> |
| <td> |
| <pre class="code"><span class="info file"># File 'lib/core/tracker.rb', line 29</span> |
| |
| <span class='kw'>def</span> <span class='id identifier rubyid_modifications'>modifications</span><span class='lparen'>(</span><span class='rparen'>)</span> |
| <span class='kw'>return</span> <span class='kw'>nil</span> <span class='kw'>if</span> <span class='lparen'>(</span><span class='id identifier rubyid_state'>state</span> <span class='op'>!=</span> <span class='const'><span class='object_link'><a href="Disposition/State.html#MODIFIED-constant" title="Qpid::Proton::Disposition::State::MODIFIED (constant)">MODIFIED</a></span></span><span class='rparen'>)</span> |
| <span class='id identifier rubyid_d'>d</span> <span class='op'>=</span> <span class='const'>Cproton</span><span class='period'>.</span><span class='id identifier rubyid_pn_delivery_remote'>pn_delivery_remote</span><span class='lparen'>(</span><span class='ivar'>@impl</span><span class='rparen'>)</span> |
| <span class='lbrace'>{</span> |
| <span class='symbol'>:failed</span> <span class='op'>=></span> <span class='const'>Cproton</span><span class='period'>.</span><span class='id identifier rubyid_pn_disposition_is_failed'>pn_disposition_is_failed</span><span class='lparen'>(</span><span class='id identifier rubyid_d'>d</span><span class='rparen'>)</span><span class='comma'>,</span> |
| <span class='symbol'>:undeliverable</span> <span class='op'>=></span> <span class='const'>Cproton</span><span class='period'>.</span><span class='id identifier rubyid_pn_disposition_is_undeliverable'>pn_disposition_is_undeliverable</span><span class='lparen'>(</span><span class='id identifier rubyid_d'>d</span><span class='rparen'>)</span><span class='comma'>,</span> |
| <span class='symbol'>:annotations</span> <span class='op'>=></span> <span class='const'>Codec</span><span class='op'>::</span><span class='const'>Data</span><span class='period'>.</span><span class='id identifier rubyid_to_object'>to_object</span><span class='lparen'>(</span><span class='const'>Cproton</span><span class='period'>.</span><span class='id identifier rubyid_pn_disposition_annotations'>pn_disposition_annotations</span><span class='lparen'>(</span><span class='id identifier rubyid_d'>d</span><span class='rparen'>)</span><span class='rparen'>)</span> |
| <span class='rbrace'>}</span> |
| <span class='kw'>end</span></pre> |
| </td> |
| </tr> |
| </table> |
| </div> |
| |
| <div class="method_details "> |
| <h3 class="signature " id="sender-instance_method"> |
| |
| #<strong>sender</strong> ⇒ <tt><span class='object_link'><a href="Sender.html" title="Qpid::Proton::Sender (class)">Sender</a></span></tt> |
| |
| |
| |
| |
| |
| </h3><div class="docstring"> |
| <div class="discussion"> |
| |
| <p>Returns The parent <span class='object_link'><a href="Sender.html" title="Qpid::Proton::Sender (class)">Sender</a></span> link.</p> |
| |
| |
| </div> |
| </div> |
| <div class="tags"> |
| |
| <p class="tag_title">Returns:</p> |
| <ul class="return"> |
| |
| <li> |
| |
| |
| <span class='type'>(<tt><span class='object_link'><a href="Sender.html" title="Qpid::Proton::Sender (class)">Sender</a></span></tt>)</span> |
| |
| |
| |
| — |
| <div class='inline'> |
| <p>The parent <span class='object_link'><a href="Sender.html" title="Qpid::Proton::Sender (class)">Sender</a></span> link.</p> |
| </div> |
| |
| </li> |
| |
| </ul> |
| |
| </div><table class="source_code"> |
| <tr> |
| <td> |
| <pre class="lines"> |
| |
| |
| 24</pre> |
| </td> |
| <td> |
| <pre class="code"><span class="info file"># File 'lib/core/tracker.rb', line 24</span> |
| |
| <span class='kw'>def</span> <span class='id identifier rubyid_sender'>sender</span><span class='lparen'>(</span><span class='rparen'>)</span> <span class='id identifier rubyid_link'>link</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: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> |
