| <!DOCTYPE html> |
| <html> |
| <head> |
| <meta charset="utf-8"> |
| <meta name="viewport" content="width=device-width, initial-scale=1.0"> |
| <title> |
| Class: Qpid::Proton::Terminus |
| |
| — Qpid Proton Ruby API |
| |
| </title> |
| |
| <link rel="stylesheet" href="../../css/style.css" type="text/css" charset="utf-8" /> |
| |
| <link rel="stylesheet" href="../../css/common.css" type="text/css" charset="utf-8" /> |
| |
| <script type="text/javascript" charset="utf-8"> |
| pathId = "Qpid::Proton::Terminus"; |
| 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">Terminus</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::Terminus |
| |
| |
| |
| </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::Terminus</li> |
| |
| </ul> |
| <a href="#" class="inheritanceTree">show all</a> |
| |
| </dd> |
| </dl> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <dl> |
| <dt>Defined in:</dt> |
| <dd>lib/core/terminus.rb</dd> |
| </dl> |
| |
| </div> |
| |
| <h2>Overview</h2><div class="docstring"> |
| <div class="discussion"> |
| |
| <p>Represents an endpoint for an AMQP connection..</p> |
| |
| <p>An AMQP terminus acts as either a source or a target for messages, but |
| never as both. Every Link is associated iwth both a source and a target |
| Terminus that is negotiated during link establishment.</p> |
| |
| <p>A terminus is composed of an AMQP address along with a number of other |
| properties defining the quality of service and behavior of the Link.</p> |
| |
| |
| </div> |
| </div> |
| <div class="tags"> |
| |
| |
| </div> |
| <h2>Constant Summary</h2> |
| <dl class="constants"> |
| |
| <dt id="UNSPECIFIED-constant" class="">UNSPECIFIED = |
| <div class="docstring"> |
| <div class="discussion"> |
| |
| <p>Indicates a non-existent source or target terminus.</p> |
| |
| |
| </div> |
| </div> |
| <div class="tags"> |
| |
| |
| </div> |
| </dt> |
| <dd><pre class="code"><span class='const'>Cproton</span><span class='op'>::</span><span class='const'>PN_UNSPECIFIED</span></pre></dd> |
| |
| <dt id="SOURCE-constant" class="">SOURCE = |
| <div class="docstring"> |
| <div class="discussion"> |
| |
| <p>Indicates a source for messages.</p> |
| |
| |
| </div> |
| </div> |
| <div class="tags"> |
| |
| |
| </div> |
| </dt> |
| <dd><pre class="code"><span class='const'>Cproton</span><span class='op'>::</span><span class='const'>PN_SOURCE</span></pre></dd> |
| |
| <dt id="TARGET-constant" class="">TARGET = |
| <div class="docstring"> |
| <div class="discussion"> |
| |
| <p>Indicates a target for messages.</p> |
| |
| |
| </div> |
| </div> |
| <div class="tags"> |
| |
| |
| </div> |
| </dt> |
| <dd><pre class="code"><span class='const'>Cproton</span><span class='op'>::</span><span class='const'>PN_TARGET</span></pre></dd> |
| |
| <dt id="COORDINATOR-constant" class="">COORDINATOR = |
| <div class="docstring"> |
| <div class="discussion"> |
| |
| <p>A special target identifying a transaction coordinator.</p> |
| |
| |
| </div> |
| </div> |
| <div class="tags"> |
| |
| |
| </div> |
| </dt> |
| <dd><pre class="code"><span class='const'>Cproton</span><span class='op'>::</span><span class='const'>PN_COORDINATOR</span></pre></dd> |
| |
| <dt id="EXPIRE_WITH_LINK-constant" class="">EXPIRE_WITH_LINK = |
| <div class="docstring"> |
| <div class="discussion"> |
| |
| <p>The terminus is orphaned when the parent link is closed.</p> |
| |
| |
| </div> |
| </div> |
| <div class="tags"> |
| |
| |
| </div> |
| </dt> |
| <dd><pre class="code"><span class='const'>Cproton</span><span class='op'>::</span><span class='const'>PN_EXPIRE_WITH_LINK</span></pre></dd> |
| |
| <dt id="EXPIRE_WITH_SESSION-constant" class="">EXPIRE_WITH_SESSION = |
| <div class="docstring"> |
| <div class="discussion"> |
| |
| <p>The terminus is orphaned whent he parent sessio is closed.</p> |
| |
| |
| </div> |
| </div> |
| <div class="tags"> |
| |
| |
| </div> |
| </dt> |
| <dd><pre class="code"><span class='const'>Cproton</span><span class='op'>::</span><span class='const'>PN_EXPIRE_WITH_SESSION</span></pre></dd> |
| |
| <dt id="EXPIRE_WITH_CONNECTION-constant" class="">EXPIRE_WITH_CONNECTION = |
| <div class="docstring"> |
| <div class="discussion"> |
| |
| <p>The terminus is orphaned when the parent connection is closed.</p> |
| |
| |
| </div> |
| </div> |
| <div class="tags"> |
| |
| |
| </div> |
| </dt> |
| <dd><pre class="code"><span class='const'>Cproton</span><span class='op'>::</span><span class='const'>PN_EXPIRE_WITH_CONNECTION</span></pre></dd> |
| |
| <dt id="EXPIRE_NEVER-constant" class="">EXPIRE_NEVER = |
| <div class="docstring"> |
| <div class="discussion"> |
| |
| <p>The terminus is never considered orphaned.</p> |
| |
| |
| </div> |
| </div> |
| <div class="tags"> |
| |
| |
| </div> |
| </dt> |
| <dd><pre class="code"><span class='const'>Cproton</span><span class='op'>::</span><span class='const'>PN_EXPIRE_NEVER</span></pre></dd> |
| |
| <dt id="NONDURABLE-constant" class="">NONDURABLE = |
| <div class="docstring"> |
| <div class="discussion"> |
| |
| <p>Indicates a non-durable Terminus.</p> |
| |
| |
| </div> |
| </div> |
| <div class="tags"> |
| |
| |
| </div> |
| </dt> |
| <dd><pre class="code"><span class='const'>Cproton</span><span class='op'>::</span><span class='const'>PN_NONDURABLE</span></pre></dd> |
| |
| <dt id="CONFIGURATION-constant" class="">CONFIGURATION = |
| <div class="docstring"> |
| <div class="discussion"> |
| |
| <p>Indicates a Terminus with durably held configuration, but not the delivery |
| state.</p> |
| |
| |
| </div> |
| </div> |
| <div class="tags"> |
| |
| |
| </div> |
| </dt> |
| <dd><pre class="code"><span class='const'>Cproton</span><span class='op'>::</span><span class='const'>PN_CONFIGURATION</span></pre></dd> |
| |
| <dt id="DELIVERIES-constant" class="">DELIVERIES = |
| <div class="docstring"> |
| <div class="discussion"> |
| |
| <p>Indicates a Terminus with both durably held configuration and durably held |
| delivery states.</p> |
| |
| |
| </div> |
| </div> |
| <div class="tags"> |
| |
| |
| </div> |
| </dt> |
| <dd><pre class="code"><span class='const'>Cproton</span><span class='op'>::</span><span class='const'>PN_DELIVERIES</span></pre></dd> |
| |
| <dt id="DIST_MODE_UNSPECIFIED-constant" class="">DIST_MODE_UNSPECIFIED = |
| <div class="docstring"> |
| <div class="discussion"> |
| |
| <p>The behavior is defined by the nod.e</p> |
| |
| |
| </div> |
| </div> |
| <div class="tags"> |
| |
| |
| </div> |
| </dt> |
| <dd><pre class="code"><span class='const'>Cproton</span><span class='op'>::</span><span class='const'>PN_DIST_MODE_UNSPECIFIED</span></pre></dd> |
| |
| <dt id="DIST_MODE_COPY-constant" class="">DIST_MODE_COPY = |
| <div class="docstring"> |
| <div class="discussion"> |
| |
| <p>The receiver gets all messages.</p> |
| |
| |
| </div> |
| </div> |
| <div class="tags"> |
| |
| |
| </div> |
| </dt> |
| <dd><pre class="code"><span class='const'>Cproton</span><span class='op'>::</span><span class='const'>PN_DIST_MODE_COPY</span></pre></dd> |
| |
| <dt id="DIST_MODE_MOVE-constant" class="">DIST_MODE_MOVE = |
| <div class="docstring"> |
| <div class="discussion"> |
| |
| <p>The receives compete for messages.</p> |
| |
| |
| </div> |
| </div> |
| <div class="tags"> |
| |
| |
| </div> |
| </dt> |
| <dd><pre class="code"><span class='const'>Cproton</span><span class='op'>::</span><span class='const'>PN_DIST_MODE_MOVE</span></pre></dd> |
| |
| </dl> |
| |
| |
| |
| |
| |
| |
| |
| |
| <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="#apply-instance_method" title="#apply (instance method)">#<strong>apply</strong>(opts = nil) </a> |
| |
| |
| |
| </span> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <span class="summary_desc"><div class='inline'> |
| <p>Apply options to this terminus.</p> |
| </div></span> |
| |
| </li> |
| |
| |
| <li class="public "> |
| <span class="summary_signature"> |
| |
| <a href="#capabilities-instance_method" title="#capabilities (instance method)">#<strong>capabilities</strong> ⇒ Data </a> |
| |
| |
| |
| </span> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <span class="summary_desc"><div class='inline'> |
| <p>Access and modify the AMQP capabilities data for the Terminus.</p> |
| </div></span> |
| |
| </li> |
| |
| |
| <li class="public "> |
| <span class="summary_signature"> |
| |
| <a href="#filter-instance_method" title="#filter (instance method)">#<strong>filter</strong> ⇒ Data </a> |
| |
| |
| |
| </span> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <span class="summary_desc"><div class='inline'> |
| <p>Access and modify the AMQP filter set for a source terminus.</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="#outcomes-instance_method" title="#outcomes (instance method)">#<strong>outcomes</strong> ⇒ Data </a> |
| |
| |
| |
| </span> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <span class="summary_desc"><div class='inline'> |
| <p>Access and modify the AMQP outcomes for the Terminus.</p> |
| </div></span> |
| |
| </li> |
| |
| |
| <li class="public "> |
| <span class="summary_signature"> |
| |
| <a href="#properties-instance_method" title="#properties (instance method)">#<strong>properties</strong> ⇒ Data </a> |
| |
| |
| |
| </span> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <span class="summary_desc"><div class='inline'> |
| <p>Access and modify the AMQP properties data for the Terminus.</p> |
| </div></span> |
| |
| </li> |
| |
| |
| <li class="public "> |
| <span class="summary_signature"> |
| |
| <a href="#replace-instance_method" title="#replace (instance method)">#<strong>replace</strong>(other) </a> |
| |
| |
| |
| </span> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <span class="summary_desc"><div class='inline'> |
| <p>Replace the data in this Terminus with the contents of <code>other</code>.</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> |
| |
| |
| </ul> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <div id="instance_method_details" class="method_details_list"> |
| <h2>Instance Method Details</h2> |
| |
| |
| <div class="method_details first"> |
| <h3 class="signature first" id="apply-instance_method"> |
| |
| #<strong>apply</strong>(opts = nil) |
| |
| |
| |
| |
| |
| </h3><div class="docstring"> |
| <div class="discussion"> |
| |
| <p>Apply options to this terminus.</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> |
| |
| |
| — |
| <div class='inline'> |
| <p>a customizable set of options</p> |
| </div> |
| |
| </li> |
| |
| </ul> |
| |
| |
| |
| |
| <p class="tag_title">Options Hash (<tt>opts</tt>):</p> |
| <ul class="option"> |
| |
| <li> |
| <span class="name">:address</span> |
| <span class="type">(<tt>String</tt>)</span> |
| <span class="default"> |
| |
| </span> |
| |
| — <div class='inline'> |
| <p>the node address</p> |
| </div> |
| |
| </li> |
| |
| <li> |
| <span class="name">:dynamic</span> |
| <span class="type">(<tt>Boolean</tt>)</span> |
| <span class="default"> |
| |
| — default: |
| <tt>false</tt> |
| |
| </span> |
| |
| — <div class='inline'> |
| <p>if true, request a new node with a unique address to be created. |
| <code>:address</code> is ignored.</p> |
| </div> |
| |
| </li> |
| |
| <li> |
| <span class="name">:distribution_mode</span> |
| <span class="type">(<tt>Integer</tt>)</span> |
| <span class="default"> |
| |
| </span> |
| |
| — <div class='inline'> |
| <p>see <span class='object_link'>#distribution_mode</span>, only for source nodes</p> |
| </div> |
| |
| </li> |
| |
| <li> |
| <span class="name">:durability_mode</span> |
| <span class="type">(<tt>Integer</tt>)</span> |
| <span class="default"> |
| |
| </span> |
| |
| — <div class='inline'> |
| <p>see <span class='object_link'>#durability_mode</span></p> |
| </div> |
| |
| </li> |
| |
| <li> |
| <span class="name">:timeout</span> |
| <span class="type">(<tt>Integer</tt>)</span> |
| <span class="default"> |
| |
| </span> |
| |
| — <div class='inline'> |
| <p>see <span class='object_link'>#timeout</span></p> |
| </div> |
| |
| </li> |
| |
| <li> |
| <span class="name">:expiry_policy</span> |
| <span class="type">(<tt>Integer</tt>)</span> |
| <span class="default"> |
| |
| </span> |
| |
| — <div class='inline'> |
| <p>see <span class='object_link'>#expiry_policy</span></p> |
| </div> |
| |
| </li> |
| |
| <li> |
| <span class="name">:filter</span> |
| <span class="type">(<tt><span class='object_link'>Hash</span></tt>)</span> |
| <span class="default"> |
| |
| </span> |
| |
| — <div class='inline'> |
| <p>see <span class='object_link'><a href="#filter-instance_method" title="Qpid::Proton::Terminus#filter (method)">#filter</a></span>, only for source nodes</p> |
| </div> |
| |
| </li> |
| |
| <li> |
| <span class="name">:capabilities</span> |
| <span class="type">(<tt><span class='object_link'>Hash</span></tt>)</span> |
| <span class="default"> |
| |
| </span> |
| |
| — <div class='inline'> |
| <p>see <span class='object_link'><a href="#capabilities-instance_method" title="Qpid::Proton::Terminus#capabilities (method)">#capabilities</a></span></p> |
| </div> |
| |
| </li> |
| |
| </ul> |
| |
| |
| |
| </div><table class="source_code"> |
| <tr> |
| <td> |
| <pre class="lines"> |
| |
| |
| 226 |
| 227 |
| 228 |
| 229 |
| 230 |
| 231 |
| 232 |
| 233 |
| 234 |
| 235 |
| 236 |
| 237 |
| 238 |
| 239 |
| 240 |
| 241 |
| 242 |
| 243 |
| 244</pre> |
| </td> |
| <td> |
| <pre class="code"><span class="info file"># File 'lib/core/terminus.rb', line 226</span> |
| |
| <span class='kw'>def</span> <span class='id identifier rubyid_apply'>apply</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='kw'>return</span> <span class='kw'>unless</span> <span class='id identifier rubyid_opts'>opts</span> |
| <span class='kw'>if</span> <span class='id identifier rubyid_opts'>opts</span><span class='period'>.</span><span class='id identifier rubyid_is_a?'>is_a?</span> <span class='const'>String</span> <span class='comment'># Shorthand for address |
| </span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_address'>address</span> <span class='op'>=</span> <span class='id identifier rubyid_opts'>opts</span> |
| <span class='kw'>else</span> |
| <span class='id identifier rubyid_opts'>opts</span><span class='period'>.</span><span class='id identifier rubyid_each_pair'>each_pair</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_k'>k</span><span class='comma'>,</span><span class='id identifier rubyid_v'>v</span><span class='op'>|</span> |
| <span class='kw'>case</span> <span class='id identifier rubyid_k'>k</span> |
| <span class='kw'>when</span> <span class='symbol'>:address</span> <span class='kw'>then</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_address'>address</span> <span class='op'>=</span> <span class='id identifier rubyid_v'>v</span> |
| <span class='kw'>when</span> <span class='symbol'>:dynamic</span> <span class='kw'>then</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_dynamic'>dynamic</span> <span class='op'>=</span> <span class='op'>!</span><span class='op'>!</span><span class='id identifier rubyid_v'>v</span> |
| <span class='kw'>when</span> <span class='symbol'>:distribution_mode</span> <span class='kw'>then</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_distribution_mode'>distribution_mode</span> <span class='op'>=</span> <span class='id identifier rubyid_v'>v</span> |
| <span class='kw'>when</span> <span class='symbol'>:durability_mode</span> <span class='kw'>then</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_durability_mode'>durability_mode</span> <span class='op'>=</span> <span class='id identifier rubyid_v'>v</span> |
| <span class='kw'>when</span> <span class='symbol'>:timeout</span> <span class='kw'>then</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_timeout'>timeout</span> <span class='op'>=</span> <span class='id identifier rubyid_v'>v</span><span class='period'>.</span><span class='id identifier rubyid_round'>round</span> <span class='comment'># Should be integer seconds |
| </span> <span class='kw'>when</span> <span class='symbol'>:expiry_policy</span> <span class='kw'>then</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_expiry_policy'>expiry_policy</span> <span class='op'>=</span> <span class='id identifier rubyid_v'>v</span> |
| <span class='kw'>when</span> <span class='symbol'>:filter</span> <span class='kw'>then</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_filter'>filter</span> <span class='op'><<</span> <span class='id identifier rubyid_v'>v</span> |
| <span class='kw'>when</span> <span class='symbol'>:capabilities</span> <span class='kw'>then</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_capabilities'>capabilities</span> <span class='op'><<</span> <span class='id identifier rubyid_v'>v</span> |
| <span class='kw'>end</span> |
| <span class='kw'>end</span> |
| <span class='kw'>end</span> |
| <span class='kw'>end</span></pre> |
| </td> |
| </tr> |
| </table> |
| </div> |
| |
| <div class="method_details "> |
| <h3 class="signature " id="capabilities-instance_method"> |
| |
| #<strong>capabilities</strong> ⇒ <tt>Data</tt> |
| |
| |
| |
| |
| |
| </h3><div class="docstring"> |
| <div class="discussion"> |
| |
| <p>Access and modify the AMQP capabilities data for the Terminus.</p> |
| |
| <p>This operation will return an instance of Data that is valid until the |
| Terminus is freed due to its parent being freed. Any data contained in the |
| object will be sent as the AMQP properties for the parent Terminus |
| instance.</p> |
| |
| <p>NOTE: this MUST take the form of a symbol keyed map to be valid.</p> |
| |
| |
| </div> |
| </div> |
| <div class="tags"> |
| |
| <p class="tag_title">Returns:</p> |
| <ul class="return"> |
| |
| <li> |
| |
| |
| <span class='type'>(<tt>Data</tt>)</span> |
| |
| |
| |
| — |
| <div class='inline'> |
| <p>The terminus capabilities.</p> |
| </div> |
| |
| </li> |
| |
| </ul> |
| |
| </div><table class="source_code"> |
| <tr> |
| <td> |
| <pre class="lines"> |
| |
| |
| 173 |
| 174 |
| 175</pre> |
| </td> |
| <td> |
| <pre class="code"><span class="info file"># File 'lib/core/terminus.rb', line 173</span> |
| |
| <span class='kw'>def</span> <span class='id identifier rubyid_capabilities'>capabilities</span> |
| <span class='const'>Codec</span><span class='op'>::</span><span class='const'>Data</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='const'>Cproton</span><span class='period'>.</span><span class='id identifier rubyid_pn_terminus_capabilities'>pn_terminus_capabilities</span><span class='lparen'>(</span><span class='ivar'>@impl</span><span class='rparen'>)</span><span class='rparen'>)</span> |
| <span class='kw'>end</span></pre> |
| </td> |
| </tr> |
| </table> |
| </div> |
| |
| <div class="method_details "> |
| <h3 class="signature " id="filter-instance_method"> |
| |
| #<strong>filter</strong> ⇒ <tt>Data</tt> |
| |
| |
| |
| |
| |
| </h3><div class="docstring"> |
| <div class="discussion"> |
| |
| <p>Access and modify the AMQP filter set for a source terminus. Only relevant |
| for a message source.</p> |
| |
| <p>This operation will return an instance of Data that is valid until the |
| Terminus is freed due to its parent being freed. Any data contained in the |
| object will be sent as the AMQP properties for the parent Terminus |
| instance.</p> |
| |
| <p>NOTE: this MUST take the form of a symbol keyed map to be valid.</p> |
| |
| |
| </div> |
| </div> |
| <div class="tags"> |
| |
| <p class="tag_title">Returns:</p> |
| <ul class="return"> |
| |
| <li> |
| |
| |
| <span class='type'>(<tt>Data</tt>)</span> |
| |
| |
| |
| — |
| <div class='inline'> |
| <p>The terminus filter.</p> |
| </div> |
| |
| </li> |
| |
| </ul> |
| |
| </div><table class="source_code"> |
| <tr> |
| <td> |
| <pre class="lines"> |
| |
| |
| 204 |
| 205 |
| 206</pre> |
| </td> |
| <td> |
| <pre class="code"><span class="info file"># File 'lib/core/terminus.rb', line 204</span> |
| |
| <span class='kw'>def</span> <span class='id identifier rubyid_filter'>filter</span> |
| <span class='const'>Codec</span><span class='op'>::</span><span class='const'>Data</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='const'>Cproton</span><span class='period'>.</span><span class='id identifier rubyid_pn_terminus_filter'>pn_terminus_filter</span><span class='lparen'>(</span><span class='ivar'>@impl</span><span class='rparen'>)</span><span class='rparen'>)</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"> |
| |
| |
| 246 |
| 247 |
| 248</pre> |
| </td> |
| <td> |
| <pre class="code"><span class="info file"># File 'lib/core/terminus.rb', line 246</span> |
| |
| <span class='kw'>def</span> <span class='id identifier rubyid_inspect'>inspect</span><span class='lparen'>(</span><span class='rparen'>)</span> |
| <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>\#<</span><span class='embexpr_beg'>#{</span><span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_class'>class</span><span class='embexpr_end'>}</span><span class='tstring_content'>: address=</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_address'>address</span><span class='period'>.</span><span class='id identifier rubyid_inspect'>inspect</span><span class='embexpr_end'>}</span><span class='tstring_content'> dynamic?=</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_dynamic?'>dynamic?</span><span class='period'>.</span><span class='id identifier rubyid_inspect'>inspect</span><span class='embexpr_end'>}</span><span class='tstring_content'>></span><span class='tstring_end'>"</span></span> |
| <span class='kw'>end</span></pre> |
| </td> |
| </tr> |
| </table> |
| </div> |
| |
| <div class="method_details "> |
| <h3 class="signature " id="outcomes-instance_method"> |
| |
| #<strong>outcomes</strong> ⇒ <tt>Data</tt> |
| |
| |
| |
| |
| |
| </h3><div class="docstring"> |
| <div class="discussion"> |
| |
| <p>Access and modify the AMQP outcomes for the Terminus.</p> |
| |
| <p>This operaiton will return an instance of Data that is valid until the |
| Terminus is freed due to its parent being freed. Any data contained in the |
| object will be sent as the AMQP properties for the parent Terminus |
| instance.</p> |
| |
| <p>NOTE: this MUST take the form of a symbol keyed map to be valid.</p> |
| |
| |
| </div> |
| </div> |
| <div class="tags"> |
| |
| <p class="tag_title">Returns:</p> |
| <ul class="return"> |
| |
| <li> |
| |
| |
| <span class='type'>(<tt>Data</tt>)</span> |
| |
| |
| |
| — |
| <div class='inline'> |
| <p>The terminus outcomes.</p> |
| </div> |
| |
| </li> |
| |
| </ul> |
| |
| </div><table class="source_code"> |
| <tr> |
| <td> |
| <pre class="lines"> |
| |
| |
| 188 |
| 189 |
| 190</pre> |
| </td> |
| <td> |
| <pre class="code"><span class="info file"># File 'lib/core/terminus.rb', line 188</span> |
| |
| <span class='kw'>def</span> <span class='id identifier rubyid_outcomes'>outcomes</span> |
| <span class='const'>Codec</span><span class='op'>::</span><span class='const'>Data</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='const'>Cproton</span><span class='period'>.</span><span class='id identifier rubyid_pn_terminus_outcomes'>pn_terminus_outcomes</span><span class='lparen'>(</span><span class='ivar'>@impl</span><span class='rparen'>)</span><span class='rparen'>)</span> |
| <span class='kw'>end</span></pre> |
| </td> |
| </tr> |
| </table> |
| </div> |
| |
| <div class="method_details "> |
| <h3 class="signature " id="properties-instance_method"> |
| |
| #<strong>properties</strong> ⇒ <tt>Data</tt> |
| |
| |
| |
| |
| |
| </h3><div class="docstring"> |
| <div class="discussion"> |
| |
| <p>Access and modify the AMQP properties data for the Terminus.</p> |
| |
| <p>This operation will return an instance of Data that is valid until the |
| Terminus is freed due to its parent being freed. Any data contained in the |
| object will be sent as the AMQP properties for the parent Terminus |
| instance.</p> |
| |
| <p>NOTE: this MUST take the form of a symbol keyed map to be valid.</p> |
| |
| |
| </div> |
| </div> |
| <div class="tags"> |
| |
| <p class="tag_title">Returns:</p> |
| <ul class="return"> |
| |
| <li> |
| |
| |
| <span class='type'>(<tt>Data</tt>)</span> |
| |
| |
| |
| — |
| <div class='inline'> |
| <p>The terminus properties.</p> |
| </div> |
| |
| </li> |
| |
| </ul> |
| |
| </div><table class="source_code"> |
| <tr> |
| <td> |
| <pre class="lines"> |
| |
| |
| 158 |
| 159 |
| 160</pre> |
| </td> |
| <td> |
| <pre class="code"><span class="info file"># File 'lib/core/terminus.rb', line 158</span> |
| |
| <span class='kw'>def</span> <span class='id identifier rubyid_properties'>properties</span> |
| <span class='const'>Codec</span><span class='op'>::</span><span class='const'>Data</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='const'>Cproton</span><span class='period'>.</span><span class='id identifier rubyid_pn_terminus_properties'>pn_terminus_properties</span><span class='lparen'>(</span><span class='ivar'>@impl</span><span class='rparen'>)</span><span class='rparen'>)</span> |
| <span class='kw'>end</span></pre> |
| </td> |
| </tr> |
| </table> |
| </div> |
| |
| <div class="method_details "> |
| <h3 class="signature " id="replace-instance_method"> |
| |
| #<strong>replace</strong>(other) |
| |
| |
| |
| |
| |
| </h3><div class="docstring"> |
| <div class="discussion"> |
| |
| <p>Replace the data in this Terminus with the contents of <code>other</code></p> |
| |
| |
| </div> |
| </div> |
| <div class="tags"> |
| <p class="tag_title">Parameters:</p> |
| <ul class="param"> |
| |
| <li> |
| |
| <span class='name'>other</span> |
| |
| |
| <span class='type'>(<tt><span class='object_link'><a href="" title="Qpid::Proton::Terminus (class)">Terminus</a></span></tt>)</span> |
| |
| |
| |
| — |
| <div class='inline'> |
| <p>The other instance.</p> |
| </div> |
| |
| </li> |
| |
| </ul> |
| |
| |
| </div><table class="source_code"> |
| <tr> |
| <td> |
| <pre class="lines"> |
| |
| |
| 210 |
| 211 |
| 212 |
| 213</pre> |
| </td> |
| <td> |
| <pre class="code"><span class="info file"># File 'lib/core/terminus.rb', line 210</span> |
| |
| <span class='kw'>def</span> <span class='id identifier rubyid_replace'>replace</span><span class='lparen'>(</span><span class='id identifier rubyid_other'>other</span><span class='rparen'>)</span> |
| <span class='const'>Cproton</span><span class='period'>.</span><span class='id identifier rubyid_pn_terminus_copy'>pn_terminus_copy</span><span class='lparen'>(</span><span class='ivar'>@impl</span><span class='comma'>,</span> <span class='id identifier rubyid_other'>other</span><span class='period'>.</span><span class='id identifier rubyid_impl'>impl</span><span class='rparen'>)</span> |
| <span class='kw'>self</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"> |
| |
| |
| 250</pre> |
| </td> |
| <td> |
| <pre class="code"><span class="info file"># File 'lib/core/terminus.rb', line 250</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> |
| |
| </div> |
| |
| <div id="footer"> |
| Generated on Fri Sep 7 14:46:35 2018 by |
| <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> |
| 0.9.8 (ruby-2.4.4). |
| </div> |
| |
| </div> |
| </body> |
| </html> |