| <!DOCTYPE html> |
| <html> |
| <head> |
| <meta charset="utf-8"> |
| <meta name="viewport" content="width=device-width, initial-scale=1.0"> |
| <title> |
| Class: Qpid::Proton::Disposition |
| |
| — 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::Disposition"; |
| 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 (D)</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">Disposition</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::Disposition |
| |
| |
| |
| </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::Disposition</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)">State</a></span></dd> |
| </dl> |
| |
| |
| |
| |
| |
| |
| <dl> |
| <dt>Defined in:</dt> |
| <dd>lib/core/disposition.rb</dd> |
| </dl> |
| |
| </div> |
| |
| <div class="docstring"> |
| <div class="discussion"> |
| |
| |
| </div> |
| </div> |
| <div class="tags"> |
| |
| |
| </div><h2>Defined Under Namespace</h2> |
| <p class="children"> |
| |
| |
| <strong class="modules">Modules:</strong> <span class='object_link'><a href="Disposition/State.html" title="Qpid::Proton::Disposition::State (module)">State</a></span> |
| |
| |
| |
| |
| </p> |
| |
| |
| |
| <h2>Constant Summary</h2> |
| |
| <h3 class="inherited">Constants included |
| from <span class='object_link'><a href="Disposition/State.html" title="Qpid::Proton::Disposition::State (module)">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)">State::ACCEPTED</a></span>, <span class='object_link'><a href="Disposition/State.html#MODIFIED-constant" title="Qpid::Proton::Disposition::State::MODIFIED (constant)">State::MODIFIED</a></span>, <span class='object_link'><a href="Disposition/State.html#RECEIVED-constant" title="Qpid::Proton::Disposition::State::RECEIVED (constant)">State::RECEIVED</a></span>, <span class='object_link'><a href="Disposition/State.html#REJECTED-constant" title="Qpid::Proton::Disposition::State::REJECTED (constant)">State::REJECTED</a></span>, <span class='object_link'><a href="Disposition/State.html#RELEASED-constant" title="Qpid::Proton::Disposition::State::RELEASED (constant)">State::RELEASED</a></span></p> |
| |
| |
| <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="#impl-instance_method" title="#impl (instance method)">#<strong>impl</strong> </a> |
| |
| |
| |
| </span> |
| |
| |
| |
| |
| <span class="note title readonly">readonly</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="#annotations-instance_method" title="#annotations (instance method)">#<strong>annotations</strong> ⇒ Codec::Data </a> |
| |
| |
| |
| </span> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <span class="summary_desc"><div class='inline'> |
| <p>Returns the annotations for the disposition.</p> |
| </div></span> |
| |
| </li> |
| |
| |
| <li class="public "> |
| <span class="summary_signature"> |
| |
| <a href="#annotations=-instance_method" title="#annotations= (instance method)">#<strong>annotations=</strong>(annotations) </a> |
| |
| |
| |
| </span> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <span class="summary_desc"><div class='inline'> |
| <p>Sets the annotations for the disposition.</p> |
| </div></span> |
| |
| </li> |
| |
| |
| <li class="public "> |
| <span class="summary_signature"> |
| |
| <a href="#condition-instance_method" title="#condition (instance method)">#<strong>condition</strong> ⇒ Codec::Data </a> |
| |
| |
| |
| </span> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <span class="summary_desc"><div class='inline'> |
| <p>Returns the condition of the disposition.</p> |
| </div></span> |
| |
| </li> |
| |
| |
| <li class="public "> |
| <span class="summary_signature"> |
| |
| <a href="#condition=-instance_method" title="#condition= (instance method)">#<strong>condition=</strong>(condition) </a> |
| |
| |
| |
| </span> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <span class="summary_desc"><div class='inline'></div></span> |
| |
| </li> |
| |
| |
| <li class="public "> |
| <span class="summary_signature"> |
| |
| <a href="#data-instance_method" title="#data (instance method)">#<strong>data</strong> ⇒ Codec::Data </a> |
| |
| |
| |
| </span> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <span class="summary_desc"><div class='inline'> |
| <p>Returns the data for the disposition.</p> |
| </div></span> |
| |
| </li> |
| |
| |
| <li class="public "> |
| <span class="summary_signature"> |
| |
| <a href="#data=-instance_method" title="#data= (instance method)">#<strong>data=</strong>(data) </a> |
| |
| |
| |
| </span> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <span class="summary_desc"><div class='inline'> |
| <p>Sets the data for the disposition.</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)">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="instance_attr_details" class="attr_details"> |
| <h2>Instance Attribute Details</h2> |
| |
| |
| <span id=""></span> |
| <div class="method_details first"> |
| <h3 class="signature first" id="impl-instance_method"> |
| |
| #<strong>impl</strong> <span class="extras">(readonly)</span> |
| |
| |
| |
| |
| |
| </h3><div class="docstring"> |
| <div class="discussion"> |
| |
| |
| </div> |
| </div> |
| <div class="tags"> |
| |
| |
| </div><table class="source_code"> |
| <tr> |
| <td> |
| <pre class="lines"> |
| |
| |
| 55 |
| 56 |
| 57</pre> |
| </td> |
| <td> |
| <pre class="code"><span class="info file"># File 'lib/core/disposition.rb', line 55</span> |
| |
| <span class='kw'>def</span> <span class='id identifier rubyid_impl'>impl</span> |
| <span class='ivar'>@impl</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="annotations-instance_method"> |
| |
| #<strong>annotations</strong> ⇒ <tt><span class='object_link'>Codec::Data</span></tt> |
| |
| |
| |
| |
| |
| </h3><div class="docstring"> |
| <div class="discussion"> |
| |
| <p>Returns the annotations for the disposition.</p> |
| |
| |
| </div> |
| </div> |
| <div class="tags"> |
| |
| <p class="tag_title">Returns:</p> |
| <ul class="return"> |
| |
| <li> |
| |
| |
| <span class='type'>(<tt><span class='object_link'>Codec::Data</span></tt>)</span> |
| |
| |
| |
| — |
| <div class='inline'> |
| <p>The annotations.</p> |
| </div> |
| |
| </li> |
| |
| </ul> |
| |
| </div><table class="source_code"> |
| <tr> |
| <td> |
| <pre class="lines"> |
| |
| |
| 129 |
| 130 |
| 131 |
| 132 |
| 133 |
| 134 |
| 135</pre> |
| </td> |
| <td> |
| <pre class="code"><span class="info file"># File 'lib/core/disposition.rb', line 129</span> |
| |
| <span class='kw'>def</span> <span class='id identifier rubyid_annotations'>annotations</span> |
| <span class='kw'>if</span> <span class='ivar'>@local</span> |
| <span class='ivar'>@annotations</span> |
| <span class='kw'>else</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='ivar'>@impl</span><span class='rparen'>)</span><span class='rparen'>)</span> |
| <span class='kw'>end</span> |
| <span class='kw'>end</span></pre> |
| </td> |
| </tr> |
| </table> |
| </div> |
| |
| <div class="method_details "> |
| <h3 class="signature " id="annotations=-instance_method"> |
| |
| #<strong>annotations=</strong>(annotations) |
| |
| |
| |
| |
| |
| </h3><div class="docstring"> |
| <div class="discussion"> |
| |
| <p>Sets the annotations for the disposition.</p> |
| |
| |
| </div> |
| </div> |
| <div class="tags"> |
| <p class="tag_title">Parameters:</p> |
| <ul class="param"> |
| |
| <li> |
| |
| <span class='name'>annotations</span> |
| |
| |
| <span class='type'>(<tt><span class='object_link'>Codec::Data</span></tt>)</span> |
| |
| |
| |
| — |
| <div class='inline'> |
| <p>The annotations.</p> |
| </div> |
| |
| </li> |
| |
| </ul> |
| |
| <p class="tag_title">Raises:</p> |
| <ul class="raise"> |
| |
| <li> |
| |
| |
| <span class='type'>(<tt><span class='object_link'><a href="AttributeError.html" title="Qpid::Proton::AttributeError (class)">AttributeError</a></span></tt>)</span> |
| |
| |
| |
| — |
| <div class='inline'> |
| <p>If the disposition is remote.</p> |
| </div> |
| |
| </li> |
| |
| </ul> |
| |
| </div><table class="source_code"> |
| <tr> |
| <td> |
| <pre class="lines"> |
| |
| |
| 120 |
| 121 |
| 122 |
| 123</pre> |
| </td> |
| <td> |
| <pre class="code"><span class="info file"># File 'lib/core/disposition.rb', line 120</span> |
| |
| <span class='kw'>def</span> <span class='id identifier rubyid_annotations='>annotations=</span><span class='lparen'>(</span><span class='id identifier rubyid_annotations'>annotations</span><span class='rparen'>)</span> |
| <span class='id identifier rubyid_raise'>raise</span> <span class='const'><span class='object_link'><a href="AttributeError.html" title="Qpid::Proton::AttributeError (class)">AttributeError</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>annotations attribute is read-only</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span> <span class='kw'>unless</span> <span class='ivar'>@local</span> |
| <span class='ivar'>@annotations</span> <span class='op'>=</span> <span class='id identifier rubyid_annotations'>annotations</span> |
| <span class='kw'>end</span></pre> |
| </td> |
| </tr> |
| </table> |
| </div> |
| |
| <div class="method_details "> |
| <h3 class="signature " id="condition-instance_method"> |
| |
| #<strong>condition</strong> ⇒ <tt><span class='object_link'>Codec::Data</span></tt> |
| |
| |
| |
| |
| |
| </h3><div class="docstring"> |
| <div class="discussion"> |
| |
| <p>Returns the condition of the disposition.</p> |
| |
| |
| </div> |
| </div> |
| <div class="tags"> |
| |
| <p class="tag_title">Returns:</p> |
| <ul class="return"> |
| |
| <li> |
| |
| |
| <span class='type'>(<tt><span class='object_link'>Codec::Data</span></tt>)</span> |
| |
| |
| |
| — |
| <div class='inline'> |
| <p>The condition of the disposition.</p> |
| </div> |
| |
| </li> |
| |
| </ul> |
| |
| </div><table class="source_code"> |
| <tr> |
| <td> |
| <pre class="lines"> |
| |
| |
| 152 |
| 153 |
| 154 |
| 155 |
| 156 |
| 157 |
| 158</pre> |
| </td> |
| <td> |
| <pre class="code"><span class="info file"># File 'lib/core/disposition.rb', line 152</span> |
| |
| <span class='kw'>def</span> <span class='id identifier rubyid_condition'>condition</span> |
| <span class='kw'>if</span> <span class='ivar'>@local</span> |
| <span class='ivar'>@condition</span> |
| <span class='kw'>else</span> |
| <span class='const'><span class='object_link'><a href="Condition.html" title="Qpid::Proton::Condition (class)">Condition</a></span></span><span class='period'>.</span><span class='id identifier rubyid_convert'><span class='object_link'><a href="Condition.html#convert-class_method" title="Qpid::Proton::Condition.convert (method)">convert</a></span></span><span class='lparen'>(</span><span class='const'>Cproton</span><span class='period'>.</span><span class='id identifier rubyid_pn_disposition_condition'>pn_disposition_condition</span><span class='lparen'>(</span><span class='ivar'>@impl</span><span class='rparen'>)</span><span class='rparen'>)</span> |
| <span class='kw'>end</span> |
| <span class='kw'>end</span></pre> |
| </td> |
| </tr> |
| </table> |
| </div> |
| |
| <div class="method_details "> |
| <h3 class="signature " id="condition=-instance_method"> |
| |
| #<strong>condition=</strong>(condition) |
| |
| |
| |
| |
| |
| </h3><div class="docstring"> |
| <div class="discussion"> |
| |
| |
| </div> |
| </div> |
| <div class="tags"> |
| <p class="tag_title">Parameters:</p> |
| <ul class="param"> |
| |
| <li> |
| |
| <span class='name'>condition</span> |
| |
| |
| <span class='type'>(<tt><span class='object_link'>Codec::Data</span></tt>)</span> |
| |
| |
| |
| — |
| <div class='inline'> |
| <p>The condition.</p> |
| </div> |
| |
| </li> |
| |
| </ul> |
| |
| <p class="tag_title">Raises:</p> |
| <ul class="raise"> |
| |
| <li> |
| |
| |
| <span class='type'>(<tt><span class='object_link'><a href="AttributeError.html" title="Qpid::Proton::AttributeError (class)">AttributeError</a></span></tt>)</span> |
| |
| |
| |
| — |
| <div class='inline'> |
| <p>If the disposition is remote.</p> |
| </div> |
| |
| </li> |
| |
| </ul> |
| |
| </div><table class="source_code"> |
| <tr> |
| <td> |
| <pre class="lines"> |
| |
| |
| 143 |
| 144 |
| 145 |
| 146</pre> |
| </td> |
| <td> |
| <pre class="code"><span class="info file"># File 'lib/core/disposition.rb', line 143</span> |
| |
| <span class='kw'>def</span> <span class='id identifier rubyid_condition='>condition=</span><span class='lparen'>(</span><span class='id identifier rubyid_condition'>condition</span><span class='rparen'>)</span> |
| <span class='id identifier rubyid_raise'>raise</span> <span class='const'><span class='object_link'><a href="AttributeError.html" title="Qpid::Proton::AttributeError (class)">AttributeError</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>condition attribute is read-only</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span> <span class='kw'>unless</span> <span class='ivar'>@local</span> |
| <span class='ivar'>@condition</span> <span class='op'>=</span> <span class='id identifier rubyid_condition'>condition</span> |
| <span class='kw'>end</span></pre> |
| </td> |
| </tr> |
| </table> |
| </div> |
| |
| <div class="method_details "> |
| <h3 class="signature " id="data-instance_method"> |
| |
| #<strong>data</strong> ⇒ <tt><span class='object_link'>Codec::Data</span></tt> |
| |
| |
| |
| |
| |
| </h3><div class="docstring"> |
| <div class="discussion"> |
| |
| <p>Returns the data for the disposition.</p> |
| |
| |
| </div> |
| </div> |
| <div class="tags"> |
| |
| <p class="tag_title">Returns:</p> |
| <ul class="return"> |
| |
| <li> |
| |
| |
| <span class='type'>(<tt><span class='object_link'>Codec::Data</span></tt>)</span> |
| |
| |
| |
| — |
| <div class='inline'> |
| <p>The data.</p> |
| </div> |
| |
| </li> |
| |
| </ul> |
| |
| </div><table class="source_code"> |
| <tr> |
| <td> |
| <pre class="lines"> |
| |
| |
| 106 |
| 107 |
| 108 |
| 109 |
| 110 |
| 111 |
| 112</pre> |
| </td> |
| <td> |
| <pre class="code"><span class="info file"># File 'lib/core/disposition.rb', line 106</span> |
| |
| <span class='kw'>def</span> <span class='id identifier rubyid_data'>data</span> |
| <span class='kw'>if</span> <span class='ivar'>@local</span> |
| <span class='ivar'>@data</span> |
| <span class='kw'>else</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_data'>pn_disposition_data</span><span class='lparen'>(</span><span class='ivar'>@impl</span><span class='rparen'>)</span><span class='rparen'>)</span> |
| <span class='kw'>end</span> |
| <span class='kw'>end</span></pre> |
| </td> |
| </tr> |
| </table> |
| </div> |
| |
| <div class="method_details "> |
| <h3 class="signature " id="data=-instance_method"> |
| |
| #<strong>data=</strong>(data) |
| |
| |
| |
| |
| |
| </h3><div class="docstring"> |
| <div class="discussion"> |
| |
| <p>Sets the data for the disposition.</p> |
| |
| |
| </div> |
| </div> |
| <div class="tags"> |
| <p class="tag_title">Parameters:</p> |
| <ul class="param"> |
| |
| <li> |
| |
| <span class='name'>data</span> |
| |
| |
| <span class='type'>(<tt><span class='object_link'>Codec::Data</span></tt>)</span> |
| |
| |
| |
| — |
| <div class='inline'> |
| <p>The data.</p> |
| </div> |
| |
| </li> |
| |
| </ul> |
| |
| <p class="tag_title">Raises:</p> |
| <ul class="raise"> |
| |
| <li> |
| |
| |
| <span class='type'>(<tt><span class='object_link'><a href="AttributeError.html" title="Qpid::Proton::AttributeError (class)">AttributeError</a></span></tt>)</span> |
| |
| |
| |
| — |
| <div class='inline'> |
| <p>If the disposition is remote.</p> |
| </div> |
| |
| </li> |
| |
| </ul> |
| |
| </div><table class="source_code"> |
| <tr> |
| <td> |
| <pre class="lines"> |
| |
| |
| 97 |
| 98 |
| 99 |
| 100</pre> |
| </td> |
| <td> |
| <pre class="code"><span class="info file"># File 'lib/core/disposition.rb', line 97</span> |
| |
| <span class='kw'>def</span> <span class='id identifier rubyid_data='>data=</span><span class='lparen'>(</span><span class='id identifier rubyid_data'>data</span><span class='rparen'>)</span> |
| <span class='id identifier rubyid_raise'>raise</span> <span class='const'><span class='object_link'><a href="AttributeError.html" title="Qpid::Proton::AttributeError (class)">AttributeError</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>data attribute is read-only</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span> <span class='kw'>unless</span> <span class='ivar'>@local</span> |
| <span class='ivar'>@data</span> <span class='op'>=</span> <span class='id identifier rubyid_data'>data</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> |