input/releases/qpid-proton-0.32.0/proton/ruby/api/Qpid/Proton/Transfer.html - qpid-site - Git at Google

 <!DOCTYPE html>
 <html>
   <head>
     <meta charset="utf-8">
 <meta name="viewport" content="width=device-width, initial-scale=1.0">
 <title>
   Class: Qpid::Proton::Transfer

     &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::Transfer";
   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> &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">Transfer</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::Transfer


 </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::Transfer</li>

         </ul>
         <a href="#" class="inheritanceTree">show all</a>

     </dd>
   </dl>


   <dl>
       <dt>Includes:</dt>
       <dd><span class='object_link'><a href="Disposition/State.html" title="Qpid::Proton::Disposition::State (module)">Disposition::State</a></span></dd>
   </dl>


   <dl>
     <dt>Defined in:</dt>
     <dd>lib/core/transfer.rb</dd>
   </dl>

 </div>

 <h2>Overview</h2><div class="docstring">
   <div class="discussion">

 <p>Status of a message transfer on a <span class='object_link'><a href="Link.html" title="Qpid::Proton::Link (class)">Link</a></span> Common base class for <span class='object_link'><a href="Tracker.html" title="Qpid::Proton::Tracker (class)">Tracker</a></span> and <span class='object_link'><a href="Delivery.html" title="Qpid::Proton::Delivery (class)">Delivery</a></span>.</p>


   </div>
 </div>
 <div class="tags">


 </div><div id="subclasses">
   <h2>Direct Known Subclasses</h2>
   <p class="children"><span class='object_link'><a href="Delivery.html" title="Qpid::Proton::Delivery (class)">Delivery</a></span>, <span class='object_link'><a href="Tracker.html" title="Qpid::Proton::Tracker (class)">Tracker</a></span></p>
 </div>


     <h2>
       Constant Summary
       <small><a href="#" class="constants_summary_toggle">collapse</a></small>
     </h2>

     <dl class="constants">

         <dt id="PROTON_METHOD_PREFIX-constant" class="">PROTON_METHOD_PREFIX =
           <div class="docstring">
   <div class="discussion">


   </div>
 </div>
 <div class="tags">


 </div>
         </dt>
         <dd><pre class="code"><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>pn_delivery</span><span class='tstring_end'>&quot;</span></span></pre></dd>

         <dt id="State-constant" class="">State =
           <div class="docstring">
   <div class="discussion">


   </div>
 </div>
 <div class="tags">


 </div>
         </dt>
         <dd><pre class="code"><span class='const'><span class='object_link'><a href="Disposition.html" title="Qpid::Proton::Disposition (class)">Disposition</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Disposition/State.html" title="Qpid::Proton::Disposition::State (module)">State</a></span></span></pre></dd>

     </dl>


   <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>
       Class Method Summary
       <small><a href="#" class="summary_toggle">collapse</a></small>
     </h2>

     <ul class="summary">

         <li class="public ">
   <span class="summary_signature">

       <a href="#wrap-class_method" title="wrap (class method)">.<strong>wrap</strong>(impl)  </a>


   </span>


     <span class="summary_desc"><div class='inline'></div></span>

 </li>


     </ul>

     <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="#connection-instance_method" title="#connection (instance method)">#<strong>connection</strong>  &#x21d2; Connection </a>


   </span>


     <span class="summary_desc"><div class='inline'>
 <p>The parent connection.</p>
 </div></span>

 </li>


         <li class="public ">
   <span class="summary_signature">

       <a href="#id-instance_method" title="#id (instance method)">#<strong>id</strong>  &#x21d2; String </a>


   </span>


     <span class="summary_desc"><div class='inline'>
 <p>Unique ID for the transfer in the context of the <span class='object_link'><a href="#link-instance_method" title="Qpid::Proton::Transfer#link (method)">#link</a></span>.</p>
 </div></span>

 </li>


         <li class="public ">
   <span class="summary_signature">

       <a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(impl)  &#x21d2; Transfer </a>


   </span>


     <span class="note title constructor">constructor</span>


     <span class="summary_desc"><div class='inline'>
 <p>A new instance of Transfer.</p>
 </div></span>

 </li>


         <li class="public ">
   <span class="summary_signature">

       <a href="#inspect-instance_method" title="#inspect (instance method)">#<strong>inspect</strong>  </a>


   </span>


     <span class="summary_desc"><div class='inline'></div></span>

 </li>


         <li class="public ">
   <span class="summary_signature">

       <a href="#link-instance_method" title="#link (instance method)">#<strong>link</strong>  &#x21d2; Link </a>


   </span>


     <span class="summary_desc"><div class='inline'>
 <p>The parent link.</p>
 </div></span>

 </li>


         <li class="public deprecated">
   <span class="summary_signature">

       <a href="#local_state-instance_method" title="#local_state (instance method)">#<strong>local_state</strong>  </a>


   </span>


   <span class="deprecated note title">deprecated</span>


     <span class="summary_desc"><strong>Deprecated.</strong> <div class='inline'>
 <p>internal use only</p>
 </div></span>

 </li>


         <li class="public ">
   <span class="summary_signature">

       <a href="#session-instance_method" title="#session (instance method)">#<strong>session</strong>  &#x21d2; Session </a>


   </span>


     <span class="summary_desc"><div class='inline'>
 <p>The parent session.</p>
 </div></span>

 </li>


         <li class="public deprecated">
   <span class="summary_signature">

       <a href="#settle-instance_method" title="#settle (instance method)">#<strong>settle</strong>(state = nil)  </a>


   </span>


   <span class="deprecated note title">deprecated</span>


     <span class="summary_desc"><strong>Deprecated.</strong> <div class='inline'>
 <p>internal use only</p>
 </div></span>

 </li>


         <li class="public ">
   <span class="summary_signature">

       <a href="#settled%3F-instance_method" title="#settled? (instance method)">#<strong>settled?</strong>  &#x21d2; Boolean </a>


   </span>


     <span class="summary_desc"><div class='inline'>
 <p>True if the transfer is remotely settled.</p>
 </div></span>

 </li>


         <li class="public ">
   <span class="summary_signature">

       <a href="#state-instance_method" title="#state (instance method)">#<strong>state</strong>  &#x21d2; Integer </a>


   </span>


     <span class="summary_desc"><div class='inline'>
 <p>Remote state of the transfer, one of the values in <span class='object_link'><a href="#State-constant" title="Qpid::Proton::Transfer::State (constant)">State</a></span>.</p>
 </div></span>

 </li>


         <li class="public ">
   <span class="summary_signature">

       <a href="#to_s-instance_method" title="#to_s (instance method)">#<strong>to_s</strong>  </a>


   </span>


     <span class="summary_desc"><div class='inline'></div></span>

 </li>


         <li class="public ">
   <span class="summary_signature">

       <a href="#transport-instance_method" title="#transport (instance method)">#<strong>transport</strong>  &#x21d2; Transport </a>


   </span>


     <span class="summary_desc"><div class='inline'>
 <p>The parent connection&#39;s transport.</p>
 </div></span>

 </li>


         <li class="public deprecated">
   <span class="summary_signature">

       <a href="#update-instance_method" title="#update (instance method)">#<strong>update</strong>(state)  </a>


   </span>


   <span class="deprecated note title">deprecated</span>


     <span class="summary_desc"><strong>Deprecated.</strong> <div class='inline'>
 <p>internal use only</p>
 </div></span>

 </li>


         <li class="public ">
   <span class="summary_signature">

       <a href="#work_queue-instance_method" title="#work_queue (instance method)">#<strong>work_queue</strong>  &#x21d2; WorkQueue </a>


   </span>


     <span class="summary_desc"><div class='inline'>
 <p>The parent connection&#39;s work-queue.</p>
 </div></span>

 </li>


     </ul>


   <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>

     <div class="method_details first">
   <h3 class="signature first" id="initialize-instance_method">

     #<strong>initialize</strong>(impl)  &#x21d2; <tt><span class='object_link'><a href="" title="Qpid::Proton::Transfer (class)">Transfer</a></span></tt>


 </h3><div class="docstring">
   <div class="discussion">

 <p>Returns a new instance of Transfer.</p>


   </div>
 </div>
 <div class="tags">


 </div><table class="source_code">
   <tr>
     <td>
       <pre class="lines">


 37
 38
 39
 40
 41</pre>
     </td>
     <td>
       <pre class="code"><span class="info file"># File 'lib/core/transfer.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_impl'>impl</span><span class='rparen'>)</span>
   <span class='ivar'>@impl</span> <span class='op'>=</span> <span class='id identifier rubyid_impl'>impl</span>
   <span class='ivar'>@inspect</span> <span class='op'>=</span> <span class='kw'>nil</span>
   <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_class'>class</span><span class='period'>.</span><span class='id identifier rubyid_store_instance'>store_instance</span><span class='lparen'>(</span><span class='kw'>self</span><span class='comma'>,</span> <span class='symbol'>:pn_delivery_attachments</span><span class='rparen'>)</span>
 <span class='kw'>end</span></pre>
     </td>
   </tr>
 </table>
 </div>

 </div>


   <div id="class_method_details" class="method_details_list">
     <h2>Class Method Details</h2>


       <div class="method_details first">
   <h3 class="signature first" id="wrap-class_method">

     .<strong>wrap</strong>(impl)


 </h3><div class="docstring">
   <div class="discussion">


   </div>
 </div>
 <div class="tags">


 </div><table class="source_code">
   <tr>
     <td>
       <pre class="lines">


 31
 32
 33
 34
 35</pre>
     </td>
     <td>
       <pre class="code"><span class="info file"># File 'lib/core/transfer.rb', line 31</span>

 <span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_wrap'>wrap</span><span class='lparen'>(</span><span class='id identifier rubyid_impl'>impl</span><span class='rparen'>)</span>
   <span class='kw'>return</span> <span class='kw'>unless</span> <span class='id identifier rubyid_impl'>impl</span>
   <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_fetch_instance'>fetch_instance</span><span class='lparen'>(</span><span class='id identifier rubyid_impl'>impl</span><span class='comma'>,</span> <span class='symbol'>:pn_delivery_attachments</span><span class='rparen'>)</span> <span class='op'>||</span>
     <span class='lparen'>(</span><span class='const'>Cproton</span><span class='period'>.</span><span class='id identifier rubyid_pn_link_is_sender'>pn_link_is_sender</span><span class='lparen'>(</span><span class='const'>Cproton</span><span class='period'>.</span><span class='id identifier rubyid_pn_delivery_link'>pn_delivery_link</span><span class='lparen'>(</span><span class='id identifier rubyid_impl'>impl</span><span class='rparen'>)</span><span class='rparen'>)</span> <span class='op'>?</span> <span class='const'><span class='object_link'><a href="Tracker.html" title="Qpid::Proton::Tracker (class)">Tracker</a></span></span> <span class='op'>:</span> <span class='const'><span class='object_link'><a href="Delivery.html" title="Qpid::Proton::Delivery (class)">Delivery</a></span></span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='id identifier rubyid_impl'>impl</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="connection-instance_method">

     #<strong>connection</strong>  &#x21d2; <tt><span class='object_link'><a href="Connection.html" title="Qpid::Proton::Connection (class)">Connection</a></span></tt>


 </h3><div class="docstring">
   <div class="discussion">

 <p>Returns The parent connection.</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="Connection.html" title="Qpid::Proton::Connection (class)">Connection</a></span></tt>)</span>


         &mdash;
         <div class='inline'>
 <p>The parent connection.</p>
 </div>

     </li>

 </ul>

 </div><table class="source_code">
   <tr>
     <td>
       <pre class="lines">


 67</pre>
     </td>
     <td>
       <pre class="code"><span class="info file"># File 'lib/core/transfer.rb', line 67</span>

 <span class='kw'>def</span> <span class='id identifier rubyid_connection'>connection</span><span class='lparen'>(</span><span class='rparen'>)</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_session'>session</span><span class='period'>.</span><span class='id identifier rubyid_connection'>connection</span><span class='semicolon'>;</span> <span class='kw'>end</span></pre>
     </td>
   </tr>
 </table>
 </div>

       <div class="method_details ">
   <h3 class="signature " id="id-instance_method">

     #<strong>id</strong>  &#x21d2; <tt>String</tt>


 </h3><div class="docstring">
   <div class="discussion">

 <p>Returns Unique ID for the transfer in the context of the <span class='object_link'><a href="#link-instance_method" title="Qpid::Proton::Transfer#link (method)">#link</a></span>.</p>


   </div>
 </div>
 <div class="tags">

 <p class="tag_title">Returns:</p>
 <ul class="return">

     <li>


         <span class='type'>(<tt>String</tt>)</span>


         &mdash;
         <div class='inline'>
 <p>Unique ID for the transfer in the context of the <span class='object_link'><a href="#link-instance_method" title="Qpid::Proton::Transfer#link (method)">#link</a></span></p>
 </div>

     </li>

 </ul>

 </div><table class="source_code">
   <tr>
     <td>
       <pre class="lines">


 49</pre>
     </td>
     <td>
       <pre class="code"><span class="info file"># File 'lib/core/transfer.rb', line 49</span>

 <span class='kw'>def</span> <span class='id identifier rubyid_id'>id</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_tag'>pn_delivery_tag</span><span class='lparen'>(</span><span class='ivar'>@impl</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="inspect-instance_method">

     #<strong>inspect</strong>


 </h3><div class="docstring">
   <div class="discussion">


   </div>
 </div>
 <div class="tags">


 </div><table class="source_code">
   <tr>
     <td>
       <pre class="lines">


 102</pre>
     </td>
     <td>
       <pre class="code"><span class="info file"># File 'lib/core/transfer.rb', line 102</span>

 <span class='kw'>def</span> <span class='id identifier rubyid_inspect'>inspect</span><span class='lparen'>(</span><span class='rparen'>)</span> <span class='ivar'>@inspect</span> <span class='op'>||</span> <span class='kw'>super</span><span class='semicolon'>;</span> <span class='kw'>end</span></pre>
     </td>
   </tr>
 </table>
 </div>

       <div class="method_details ">
   <h3 class="signature " id="link-instance_method">

     #<strong>link</strong>  &#x21d2; <tt><span class='object_link'><a href="Link.html" title="Qpid::Proton::Link (class)">Link</a></span></tt>


 </h3><div class="docstring">
   <div class="discussion">

 <p>Returns The parent 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="Link.html" title="Qpid::Proton::Link (class)">Link</a></span></tt>)</span>


         &mdash;
         <div class='inline'>
 <p>The parent link.</p>
 </div>

     </li>

 </ul>

 </div><table class="source_code">
   <tr>
     <td>
       <pre class="lines">


 61</pre>
     </td>
     <td>
       <pre class="code"><span class="info file"># File 'lib/core/transfer.rb', line 61</span>

 <span class='kw'>def</span> <span class='id identifier rubyid_link'>link</span><span class='lparen'>(</span><span class='rparen'>)</span> <span class='const'><span class='object_link'><a href="Link.html" title="Qpid::Proton::Link (class)">Link</a></span></span><span class='period'>.</span><span class='id identifier rubyid_wrap'>wrap</span><span class='lparen'>(</span><span class='const'>Cproton</span><span class='period'>.</span><span class='id identifier rubyid_pn_delivery_link'>pn_delivery_link</span><span class='lparen'>(</span><span class='ivar'>@impl</span><span class='rparen'>)</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="local_state-instance_method">

     #<strong>local_state</strong>


 </h3><div class="docstring">
   <div class="discussion">
     <div class="note deprecated"><strong>Deprecated.</strong> <div class='inline'>
 <p>internal use only</p>
 </div></div>


   </div>
 </div>
 <div class="tags">


 </div><table class="source_code">
   <tr>
     <td>
       <pre class="lines">


 92</pre>
     </td>
     <td>
       <pre class="code"><span class="info file"># File 'lib/core/transfer.rb', line 92</span>

 <span class='kw'>def</span> <span class='id identifier rubyid_local_state'>local_state</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_local_state'>pn_delivery_local_state</span><span class='lparen'>(</span><span class='ivar'>@impl</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="session-instance_method">

     #<strong>session</strong>  &#x21d2; <tt><span class='object_link'><a href="Session.html" title="Qpid::Proton::Session (class)">Session</a></span></tt>


 </h3><div class="docstring">
   <div class="discussion">

 <p>Returns The parent session.</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="Session.html" title="Qpid::Proton::Session (class)">Session</a></span></tt>)</span>


         &mdash;
         <div class='inline'>
 <p>The parent session.</p>
 </div>

     </li>

 </ul>

 </div><table class="source_code">
   <tr>
     <td>
       <pre class="lines">


 64</pre>
     </td>
     <td>
       <pre class="code"><span class="info file"># File 'lib/core/transfer.rb', line 64</span>

 <span class='kw'>def</span> <span class='id identifier rubyid_session'>session</span><span class='lparen'>(</span><span class='rparen'>)</span> <span class='id identifier rubyid_link'>link</span><span class='period'>.</span><span class='id identifier rubyid_session'>session</span><span class='semicolon'>;</span> <span class='kw'>end</span></pre>
     </td>
   </tr>
 </table>
 </div>

       <div class="method_details ">
   <h3 class="signature " id="settle-instance_method">

     #<strong>settle</strong>(state = nil)


 </h3><div class="docstring">
   <div class="discussion">
     <div class="note deprecated"><strong>Deprecated.</strong> <div class='inline'>
 <p>internal use only</p>
 </div></div>


   </div>
 </div>
 <div class="tags">


 </div><table class="source_code">
   <tr>
     <td>
       <pre class="lines">


 96
 97
 98
 99
 100</pre>
     </td>
     <td>
       <pre class="code"><span class="info file"># File 'lib/core/transfer.rb', line 96</span>

 <span class='kw'>def</span> <span class='id identifier rubyid_settle'>settle</span><span class='lparen'>(</span><span class='id identifier rubyid_state'>state</span> <span class='op'>=</span> <span class='kw'>nil</span><span class='rparen'>)</span>
   <span class='id identifier rubyid_update'>update</span><span class='lparen'>(</span><span class='id identifier rubyid_state'>state</span><span class='rparen'>)</span> <span class='kw'>unless</span> <span class='id identifier rubyid_state'>state</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
   <span class='const'>Cproton</span><span class='period'>.</span><span class='id identifier rubyid_pn_delivery_settle'>pn_delivery_settle</span><span class='lparen'>(</span><span class='ivar'>@impl</span><span class='rparen'>)</span>
   <span class='ivar'>@inspect</span> <span class='op'>=</span> <span class='id identifier rubyid_inspect'>inspect</span> <span class='comment'># Save the inspect string, the delivery pointer will go bad.
 </span><span class='kw'>end</span></pre>
     </td>
   </tr>
 </table>
 </div>

       <div class="method_details ">
   <h3 class="signature " id="settled?-instance_method">

     #<strong>settled?</strong>  &#x21d2; <tt>Boolean</tt>


 </h3><div class="docstring">
   <div class="discussion">

 <p>Returns True if the transfer is remotely settled.</p>


   </div>
 </div>
 <div class="tags">

 <p class="tag_title">Returns:</p>
 <ul class="return">

     <li>


         <span class='type'>(<tt>Boolean</tt>)</span>


         &mdash;
         <div class='inline'>
 <p>True if the transfer is remotely settled.</p>
 </div>

     </li>

 </ul>

 </div><table class="source_code">
   <tr>
     <td>
       <pre class="lines">


 55</pre>
     </td>
     <td>
       <pre class="code"><span class="info file"># File 'lib/core/transfer.rb', line 55</span>

 <span class='id identifier rubyid_proton_caller'>proton_caller</span> <span class='symbol'>:settled?</span></pre>
     </td>
   </tr>
 </table>
 </div>

       <div class="method_details ">
   <h3 class="signature " id="state-instance_method">

     #<strong>state</strong>  &#x21d2; <tt>Integer</tt>


 </h3><div class="docstring">
   <div class="discussion">

 <p>Returns Remote state of the transfer, one of the values in <span class='object_link'><a href="#State-constant" title="Qpid::Proton::Transfer::State (constant)">State</a></span>.</p>


   </div>
 </div>
 <div class="tags">

 <p class="tag_title">Returns:</p>
 <ul class="return">

     <li>


         <span class='type'>(<tt>Integer</tt>)</span>


         &mdash;
         <div class='inline'>
 <p>Remote state of the transfer, one of the values in <span class='object_link'><a href="#State-constant" title="Qpid::Proton::Transfer::State (constant)">State</a></span></p>
 </div>

     </li>

 </ul>

 </div><table class="source_code">
   <tr>
     <td>
       <pre class="lines">


 58</pre>
     </td>
     <td>
       <pre class="code"><span class="info file"># File 'lib/core/transfer.rb', line 58</span>

 <span class='kw'>def</span> <span class='id identifier rubyid_state'>state</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_remote_state'>pn_delivery_remote_state</span><span class='lparen'>(</span><span class='ivar'>@impl</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="to_s-instance_method">

     #<strong>to_s</strong>


 </h3><div class="docstring">
   <div class="discussion">


   </div>
 </div>
 <div class="tags">


 </div><table class="source_code">
   <tr>
     <td>
       <pre class="lines">


 103</pre>
     </td>
     <td>
       <pre class="code"><span class="info file"># File 'lib/core/transfer.rb', line 103</span>

 <span class='kw'>def</span> <span class='id identifier rubyid_to_s'>to_s</span><span class='lparen'>(</span><span class='rparen'>)</span> <span class='id identifier rubyid_inspect'>inspect</span><span class='semicolon'>;</span> <span class='kw'>end</span></pre>
     </td>
   </tr>
 </table>
 </div>

       <div class="method_details ">
   <h3 class="signature " id="transport-instance_method">

     #<strong>transport</strong>  &#x21d2; <tt><span class='object_link'><a href="Transport.html" title="Qpid::Proton::Transport (class)">Transport</a></span></tt>


 </h3><div class="docstring">
   <div class="discussion">

 <p>Returns The parent connection&#39;s transport.</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="Transport.html" title="Qpid::Proton::Transport (class)">Transport</a></span></tt>)</span>


         &mdash;
         <div class='inline'>
 <p>The parent connection&#39;s transport.</p>
 </div>

     </li>

 </ul>

 </div><table class="source_code">
   <tr>
     <td>
       <pre class="lines">


 70</pre>
     </td>
     <td>
       <pre class="code"><span class="info file"># File 'lib/core/transfer.rb', line 70</span>

 <span class='kw'>def</span> <span class='id identifier rubyid_transport'>transport</span><span class='lparen'>(</span><span class='rparen'>)</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_connection'>connection</span><span class='period'>.</span><span class='id identifier rubyid_transport'>transport</span><span class='semicolon'>;</span> <span class='kw'>end</span></pre>
     </td>
   </tr>
 </table>
 </div>

       <div class="method_details ">
   <h3 class="signature " id="update-instance_method">

     #<strong>update</strong>(state)


 </h3><div class="docstring">
   <div class="discussion">
     <div class="note deprecated"><strong>Deprecated.</strong> <div class='inline'>
 <p>internal use only</p>
 </div></div>


   </div>
 </div>
 <div class="tags">


 </div><table class="source_code">
   <tr>
     <td>
       <pre class="lines">


 88</pre>
     </td>
     <td>
       <pre class="code"><span class="info file"># File 'lib/core/transfer.rb', line 88</span>

 <span class='kw'>def</span> <span class='id identifier rubyid_update'>update</span><span class='lparen'>(</span><span class='id identifier rubyid_state'>state</span><span class='rparen'>)</span> <span class='const'>Cproton</span><span class='period'>.</span><span class='id identifier rubyid_pn_delivery_update'>pn_delivery_update</span><span class='lparen'>(</span><span class='ivar'>@impl</span><span class='comma'>,</span> <span class='id identifier rubyid_state'>state</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="work_queue-instance_method">

     #<strong>work_queue</strong>  &#x21d2; <tt><span class='object_link'><a href="WorkQueue.html" title="Qpid::Proton::WorkQueue (class)">WorkQueue</a></span></tt>


 </h3><div class="docstring">
   <div class="discussion">

 <p>Returns The parent connection&#39;s work-queue.</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="WorkQueue.html" title="Qpid::Proton::WorkQueue (class)">WorkQueue</a></span></tt>)</span>


         &mdash;
         <div class='inline'>
 <p>The parent connection&#39;s work-queue.</p>
 </div>

     </li>

 </ul>

 </div><table class="source_code">
   <tr>
     <td>
       <pre class="lines">


 73</pre>
     </td>
     <td>
       <pre class="code"><span class="info file"># File 'lib/core/transfer.rb', line 73</span>

 <span class='kw'>def</span> <span class='id identifier rubyid_work_queue'>work_queue</span><span class='lparen'>(</span><span class='rparen'>)</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_connection'>connection</span><span class='period'>.</span><span class='id identifier rubyid_work_queue'>work_queue</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>