| <!DOCTYPE html> |
| <html> |
| <head> |
| <meta charset="utf-8"> |
| <meta name="viewport" content="width=device-width, initial-scale=1.0"> |
| <title> |
| Class: Qpid::Proton::Endpoint |
| |
| — 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::Endpoint"; |
| 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 (E)</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">Endpoint</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::Endpoint |
| |
| |
| |
| </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::Endpoint</li> |
| |
| </ul> |
| <a href="#" class="inheritanceTree">show all</a> |
| |
| </dd> |
| </dl> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <dl> |
| <dt>Defined in:</dt> |
| <dd>lib/core/endpoint.rb</dd> |
| </dl> |
| |
| </div> |
| |
| <h2>Overview</h2><div class="docstring"> |
| <div class="discussion"> |
| |
| <p>Endpoint is the parent classes for Link and Session.</p> |
| |
| <p>It provides a namespace for constant values that relate to the current state of both links and sessions.</p> |
| |
| |
| </div> |
| </div> |
| <div class="tags"> |
| |
| <div class="examples"> |
| <p class="tag_title">Examples:</p> |
| |
| |
| <pre class="example code"><code> |
| <span class='id identifier rubyid_conn'>conn</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="../../Qpid.html" title="Qpid (module)">Qpid</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Proton.html" title="Qpid::Proton (module)">Proton</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Connection.html" title="Qpid::Proton::Connection (class)">Connection</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span> |
| <span class='id identifier rubyid_puts'>puts</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>Local connection flags : </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_conn'>conn</span><span class='period'>.</span><span class='id identifier rubyid_state'>state</span> <span class='op'>||</span> <span class='const'><span class='object_link'><a href="../../Qpid.html" title="Qpid (module)">Qpid</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Proton.html" title="Qpid::Proton (module)">Proton</a></span></span><span class='op'>::</span><span class='const'>Endpoint</span><span class='op'>::</span><span class='const'><span class='object_link'><a href="#LOCAL_MASK-constant" title="Qpid::Proton::Endpoint::LOCAL_MASK (constant)">LOCAL_MASK</a></span></span><span class='embexpr_end'>}</span><span class='tstring_end'>"</span></span> |
| <span class='id identifier rubyid_puts'>puts</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>Remote connection flags: </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_conn'>conn</span><span class='period'>.</span><span class='id identifier rubyid_state'>state</span> <span class='op'>||</span> <span class='const'><span class='object_link'><a href="../../Qpid.html" title="Qpid (module)">Qpid</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Proton.html" title="Qpid::Proton (module)">Proton</a></span></span><span class='op'>::</span><span class='const'>Endpoint</span><span class='op'>::</span><span class='const'><span class='object_link'><a href="#REMOTE_MASK-constant" title="Qpid::Proton::Endpoint::REMOTE_MASK (constant)">REMOTE_MASK</a></span></span><span class='embexpr_end'>}</span><span class='tstring_end'>"</span></span></code></pre> |
| |
| </div> |
| |
| |
| </div><div id="subclasses"> |
| <h2>Direct Known Subclasses</h2> |
| <p class="children"><span class='object_link'><a href="Connection.html" title="Qpid::Proton::Connection (class)">Connection</a></span>, <span class='object_link'><a href="Link.html" title="Qpid::Proton::Link (class)">Link</a></span>, <span class='object_link'><a href="Session.html" title="Qpid::Proton::Session (class)">Session</a></span></p> |
| </div> |
| |
| |
| <h2> |
| Constant Summary |
| <small><a href="#" class="constants_summary_toggle">collapse</a></small> |
| </h2> |
| |
| <dl class="constants"> |
| |
| <dt id="LOCAL_UNINIT-constant" class="">LOCAL_UNINIT = |
| <div class="docstring"> |
| <div class="discussion"> |
| |
| <p>The local connection is uninitialized.</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_LOCAL_UNINIT</span></pre></dd> |
| |
| <dt id="LOCAL_ACTIVE-constant" class="">LOCAL_ACTIVE = |
| <div class="docstring"> |
| <div class="discussion"> |
| |
| <p>The local connection is active.</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_LOCAL_ACTIVE</span></pre></dd> |
| |
| <dt id="LOCAL_CLOSED-constant" class="">LOCAL_CLOSED = |
| <div class="docstring"> |
| <div class="discussion"> |
| |
| <p>The local 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_LOCAL_CLOSED</span></pre></dd> |
| |
| <dt id="REMOTE_UNINIT-constant" class="">REMOTE_UNINIT = |
| <div class="docstring"> |
| <div class="discussion"> |
| |
| <p>The remote connection is unitialized.</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_REMOTE_UNINIT</span></pre></dd> |
| |
| <dt id="REMOTE_ACTIVE-constant" class="">REMOTE_ACTIVE = |
| <div class="docstring"> |
| <div class="discussion"> |
| |
| <p>The remote connection is active.</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_REMOTE_ACTIVE</span></pre></dd> |
| |
| <dt id="REMOTE_CLOSED-constant" class="">REMOTE_CLOSED = |
| <div class="docstring"> |
| <div class="discussion"> |
| |
| <p>The remote 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_REMOTE_CLOSED</span></pre></dd> |
| |
| <dt id="LOCAL_MASK-constant" class="">LOCAL_MASK = |
| <div class="docstring"> |
| <div class="discussion"> |
| |
| <p>Bitmask for the local-only flags.</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_LOCAL_UNINIT</span> <span class='op'>|</span> <span class='const'>Cproton</span><span class='op'>::</span><span class='const'>PN_LOCAL_ACTIVE</span> <span class='op'>|</span> <span class='const'>Cproton</span><span class='op'>::</span><span class='const'>PN_LOCAL_CLOSED</span></pre></dd> |
| |
| <dt id="REMOTE_MASK-constant" class="">REMOTE_MASK = |
| <div class="docstring"> |
| <div class="discussion"> |
| |
| <p>Bitmask for the remote-only flags.</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_REMOTE_UNINIT</span> <span class='op'>|</span> <span class='const'>Cproton</span><span class='op'>::</span><span class='const'>PN_REMOTE_ACTIVE</span> <span class='op'>|</span> <span class='const'>Cproton</span><span class='op'>::</span><span class='const'>PN_REMOTE_CLOSED</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="#closed%3F-instance_method" title="#closed? (instance method)">#<strong>closed?</strong> ⇒ Bool </a> |
| |
| |
| |
| </span> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <span class="summary_desc"><div class='inline'> |
| <p>True if endpoint has sent and received a CLOSE frame.</p> |
| </div></span> |
| |
| </li> |
| |
| |
| <li class="public "> |
| <span class="summary_signature"> |
| |
| <a href="#local_closed%3F-instance_method" title="#local_closed? (instance method)">#<strong>local_closed?</strong> ⇒ Boolean </a> |
| |
| |
| |
| </span> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <span class="summary_desc"><div class='inline'></div></span> |
| |
| </li> |
| |
| |
| <li class="public "> |
| <span class="summary_signature"> |
| |
| <a href="#local_open%3F-instance_method" title="#local_open? (instance method)">#<strong>local_open?</strong> ⇒ Boolean </a> |
| |
| |
| |
| (also: #local_active?) |
| |
| </span> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <span class="summary_desc"><div class='inline'></div></span> |
| |
| </li> |
| |
| |
| <li class="public "> |
| <span class="summary_signature"> |
| |
| <a href="#local_uninit%3F-instance_method" title="#local_uninit? (instance method)">#<strong>local_uninit?</strong> ⇒ Boolean </a> |
| |
| |
| |
| </span> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <span class="summary_desc"><div class='inline'></div></span> |
| |
| </li> |
| |
| |
| <li class="public "> |
| <span class="summary_signature"> |
| |
| <a href="#open%3F-instance_method" title="#open? (instance method)">#<strong>open?</strong> ⇒ Bool </a> |
| |
| |
| |
| </span> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <span class="summary_desc"><div class='inline'> |
| <p>True if endpoint has sent and received an OPEN frame.</p> |
| </div></span> |
| |
| </li> |
| |
| |
| <li class="public "> |
| <span class="summary_signature"> |
| |
| <a href="#remote_closed%3F-instance_method" title="#remote_closed? (instance method)">#<strong>remote_closed?</strong> ⇒ Boolean </a> |
| |
| |
| |
| </span> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <span class="summary_desc"><div class='inline'></div></span> |
| |
| </li> |
| |
| |
| <li class="public "> |
| <span class="summary_signature"> |
| |
| <a href="#remote_open%3F-instance_method" title="#remote_open? (instance method)">#<strong>remote_open?</strong> ⇒ Boolean </a> |
| |
| |
| |
| (also: #remote_active?) |
| |
| </span> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <span class="summary_desc"><div class='inline'></div></span> |
| |
| </li> |
| |
| |
| <li class="public "> |
| <span class="summary_signature"> |
| |
| <a href="#remote_uninit%3F-instance_method" title="#remote_uninit? (instance method)">#<strong>remote_uninit?</strong> ⇒ Boolean </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> ⇒ Transport </a> |
| |
| |
| |
| </span> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <span class="summary_desc"><div class='inline'> |
| <p>Return the transport associated with this endpoint.</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> ⇒ WorkQueue </a> |
| |
| |
| |
| </span> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <span class="summary_desc"><div class='inline'> |
| <p>The work queue for work on this endpoint.</p> |
| </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="closed?-instance_method"> |
| |
| #<strong>closed?</strong> ⇒ <tt>Bool</tt> |
| |
| |
| |
| |
| |
| </h3><div class="docstring"> |
| <div class="discussion"> |
| |
| <p>Returns true if endpoint has sent and received a CLOSE frame.</p> |
| |
| |
| </div> |
| </div> |
| <div class="tags"> |
| |
| <p class="tag_title">Returns:</p> |
| <ul class="return"> |
| |
| <li> |
| |
| |
| <span class='type'>(<tt>Bool</tt>)</span> |
| |
| |
| |
| — |
| <div class='inline'> |
| <p>true if endpoint has sent and received a CLOSE frame</p> |
| </div> |
| |
| </li> |
| |
| </ul> |
| |
| </div><table class="source_code"> |
| <tr> |
| <td> |
| <pre class="lines"> |
| |
| |
| 78</pre> |
| </td> |
| <td> |
| <pre class="code"><span class="info file"># File 'lib/core/endpoint.rb', line 78</span> |
| |
| <span class='kw'>def</span> <span class='id identifier rubyid_closed?'>closed?</span><span class='lparen'>(</span><span class='rparen'>)</span> <span class='id identifier rubyid_check_state'>check_state</span><span class='lparen'>(</span><span class='const'><span class='object_link'><a href="#LOCAL_CLOSED-constant" title="Qpid::Proton::Endpoint::LOCAL_CLOSED (constant)">LOCAL_CLOSED</a></span></span> <span class='op'>|</span> <span class='const'><span class='object_link'><a href="#REMOTE_CLOSED-constant" title="Qpid::Proton::Endpoint::REMOTE_CLOSED (constant)">REMOTE_CLOSED</a></span></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_closed?-instance_method"> |
| |
| #<strong>local_closed?</strong> ⇒ <tt>Boolean</tt> |
| |
| |
| |
| |
| |
| </h3><div class="docstring"> |
| <div class="discussion"> |
| |
| |
| </div> |
| </div> |
| <div class="tags"> |
| |
| <p class="tag_title">Returns:</p> |
| <ul class="return"> |
| |
| <li> |
| |
| |
| <span class='type'>(<tt>Boolean</tt>)</span> |
| |
| |
| |
| </li> |
| |
| </ul> |
| |
| </div><table class="source_code"> |
| <tr> |
| <td> |
| <pre class="lines"> |
| |
| |
| 91 |
| 92 |
| 93</pre> |
| </td> |
| <td> |
| <pre class="code"><span class="info file"># File 'lib/core/endpoint.rb', line 91</span> |
| |
| <span class='kw'>def</span> <span class='id identifier rubyid_local_closed?'>local_closed?</span> |
| <span class='id identifier rubyid_check_state'>check_state</span><span class='lparen'>(</span><span class='const'><span class='object_link'><a href="#LOCAL_CLOSED-constant" title="Qpid::Proton::Endpoint::LOCAL_CLOSED (constant)">LOCAL_CLOSED</a></span></span><span class='rparen'>)</span> |
| <span class='kw'>end</span></pre> |
| </td> |
| </tr> |
| </table> |
| </div> |
| |
| <div class="method_details "> |
| <h3 class="signature " id="local_open?-instance_method"> |
| |
| #<strong>local_open?</strong> ⇒ <tt>Boolean</tt> |
| |
| |
| |
| <span class="aliases">Also known as: |
| <span class="names"><span id='local_active?-instance_method'>local_active?</span></span> |
| </span> |
| |
| |
| |
| </h3><div class="docstring"> |
| <div class="discussion"> |
| |
| |
| </div> |
| </div> |
| <div class="tags"> |
| |
| <p class="tag_title">Returns:</p> |
| <ul class="return"> |
| |
| <li> |
| |
| |
| <span class='type'>(<tt>Boolean</tt>)</span> |
| |
| |
| |
| </li> |
| |
| </ul> |
| |
| </div><table class="source_code"> |
| <tr> |
| <td> |
| <pre class="lines"> |
| |
| |
| 87 |
| 88 |
| 89</pre> |
| </td> |
| <td> |
| <pre class="code"><span class="info file"># File 'lib/core/endpoint.rb', line 87</span> |
| |
| <span class='kw'>def</span> <span class='id identifier rubyid_local_open?'>local_open?</span> |
| <span class='id identifier rubyid_check_state'>check_state</span><span class='lparen'>(</span><span class='const'><span class='object_link'><a href="#LOCAL_ACTIVE-constant" title="Qpid::Proton::Endpoint::LOCAL_ACTIVE (constant)">LOCAL_ACTIVE</a></span></span><span class='rparen'>)</span> |
| <span class='kw'>end</span></pre> |
| </td> |
| </tr> |
| </table> |
| </div> |
| |
| <div class="method_details "> |
| <h3 class="signature " id="local_uninit?-instance_method"> |
| |
| #<strong>local_uninit?</strong> ⇒ <tt>Boolean</tt> |
| |
| |
| |
| |
| |
| </h3><div class="docstring"> |
| <div class="discussion"> |
| |
| |
| </div> |
| </div> |
| <div class="tags"> |
| |
| <p class="tag_title">Returns:</p> |
| <ul class="return"> |
| |
| <li> |
| |
| |
| <span class='type'>(<tt>Boolean</tt>)</span> |
| |
| |
| |
| </li> |
| |
| </ul> |
| |
| </div><table class="source_code"> |
| <tr> |
| <td> |
| <pre class="lines"> |
| |
| |
| 83 |
| 84 |
| 85</pre> |
| </td> |
| <td> |
| <pre class="code"><span class="info file"># File 'lib/core/endpoint.rb', line 83</span> |
| |
| <span class='kw'>def</span> <span class='id identifier rubyid_local_uninit?'>local_uninit?</span> |
| <span class='id identifier rubyid_check_state'>check_state</span><span class='lparen'>(</span><span class='const'><span class='object_link'><a href="#LOCAL_UNINIT-constant" title="Qpid::Proton::Endpoint::LOCAL_UNINIT (constant)">LOCAL_UNINIT</a></span></span><span class='rparen'>)</span> |
| <span class='kw'>end</span></pre> |
| </td> |
| </tr> |
| </table> |
| </div> |
| |
| <div class="method_details "> |
| <h3 class="signature " id="open?-instance_method"> |
| |
| #<strong>open?</strong> ⇒ <tt>Bool</tt> |
| |
| |
| |
| |
| |
| </h3><div class="docstring"> |
| <div class="discussion"> |
| |
| <p>Returns true if endpoint has sent and received an OPEN frame.</p> |
| |
| |
| </div> |
| </div> |
| <div class="tags"> |
| |
| <p class="tag_title">Returns:</p> |
| <ul class="return"> |
| |
| <li> |
| |
| |
| <span class='type'>(<tt>Bool</tt>)</span> |
| |
| |
| |
| — |
| <div class='inline'> |
| <p>true if endpoint has sent and received an OPEN frame</p> |
| </div> |
| |
| </li> |
| |
| </ul> |
| |
| </div><table class="source_code"> |
| <tr> |
| <td> |
| <pre class="lines"> |
| |
| |
| 81</pre> |
| </td> |
| <td> |
| <pre class="code"><span class="info file"># File 'lib/core/endpoint.rb', line 81</span> |
| |
| <span class='kw'>def</span> <span class='id identifier rubyid_open?'>open?</span><span class='lparen'>(</span><span class='rparen'>)</span> <span class='id identifier rubyid_check_state'>check_state</span><span class='lparen'>(</span><span class='const'><span class='object_link'><a href="#LOCAL_ACTIVE-constant" title="Qpid::Proton::Endpoint::LOCAL_ACTIVE (constant)">LOCAL_ACTIVE</a></span></span> <span class='op'>|</span> <span class='const'><span class='object_link'><a href="#REMOTE_ACTIVE-constant" title="Qpid::Proton::Endpoint::REMOTE_ACTIVE (constant)">REMOTE_ACTIVE</a></span></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="remote_closed?-instance_method"> |
| |
| #<strong>remote_closed?</strong> ⇒ <tt>Boolean</tt> |
| |
| |
| |
| |
| |
| </h3><div class="docstring"> |
| <div class="discussion"> |
| |
| |
| </div> |
| </div> |
| <div class="tags"> |
| |
| <p class="tag_title">Returns:</p> |
| <ul class="return"> |
| |
| <li> |
| |
| |
| <span class='type'>(<tt>Boolean</tt>)</span> |
| |
| |
| |
| </li> |
| |
| </ul> |
| |
| </div><table class="source_code"> |
| <tr> |
| <td> |
| <pre class="lines"> |
| |
| |
| 103 |
| 104 |
| 105</pre> |
| </td> |
| <td> |
| <pre class="code"><span class="info file"># File 'lib/core/endpoint.rb', line 103</span> |
| |
| <span class='kw'>def</span> <span class='id identifier rubyid_remote_closed?'>remote_closed?</span> |
| <span class='id identifier rubyid_check_state'>check_state</span><span class='lparen'>(</span><span class='const'><span class='object_link'><a href="#REMOTE_CLOSED-constant" title="Qpid::Proton::Endpoint::REMOTE_CLOSED (constant)">REMOTE_CLOSED</a></span></span><span class='rparen'>)</span> |
| <span class='kw'>end</span></pre> |
| </td> |
| </tr> |
| </table> |
| </div> |
| |
| <div class="method_details "> |
| <h3 class="signature " id="remote_open?-instance_method"> |
| |
| #<strong>remote_open?</strong> ⇒ <tt>Boolean</tt> |
| |
| |
| |
| <span class="aliases">Also known as: |
| <span class="names"><span id='remote_active?-instance_method'>remote_active?</span></span> |
| </span> |
| |
| |
| |
| </h3><div class="docstring"> |
| <div class="discussion"> |
| |
| |
| </div> |
| </div> |
| <div class="tags"> |
| |
| <p class="tag_title">Returns:</p> |
| <ul class="return"> |
| |
| <li> |
| |
| |
| <span class='type'>(<tt>Boolean</tt>)</span> |
| |
| |
| |
| </li> |
| |
| </ul> |
| |
| </div><table class="source_code"> |
| <tr> |
| <td> |
| <pre class="lines"> |
| |
| |
| 99 |
| 100 |
| 101</pre> |
| </td> |
| <td> |
| <pre class="code"><span class="info file"># File 'lib/core/endpoint.rb', line 99</span> |
| |
| <span class='kw'>def</span> <span class='id identifier rubyid_remote_open?'>remote_open?</span> |
| <span class='id identifier rubyid_check_state'>check_state</span><span class='lparen'>(</span><span class='const'><span class='object_link'><a href="#REMOTE_ACTIVE-constant" title="Qpid::Proton::Endpoint::REMOTE_ACTIVE (constant)">REMOTE_ACTIVE</a></span></span><span class='rparen'>)</span> |
| <span class='kw'>end</span></pre> |
| </td> |
| </tr> |
| </table> |
| </div> |
| |
| <div class="method_details "> |
| <h3 class="signature " id="remote_uninit?-instance_method"> |
| |
| #<strong>remote_uninit?</strong> ⇒ <tt>Boolean</tt> |
| |
| |
| |
| |
| |
| </h3><div class="docstring"> |
| <div class="discussion"> |
| |
| |
| </div> |
| </div> |
| <div class="tags"> |
| |
| <p class="tag_title">Returns:</p> |
| <ul class="return"> |
| |
| <li> |
| |
| |
| <span class='type'>(<tt>Boolean</tt>)</span> |
| |
| |
| |
| </li> |
| |
| </ul> |
| |
| </div><table class="source_code"> |
| <tr> |
| <td> |
| <pre class="lines"> |
| |
| |
| 95 |
| 96 |
| 97</pre> |
| </td> |
| <td> |
| <pre class="code"><span class="info file"># File 'lib/core/endpoint.rb', line 95</span> |
| |
| <span class='kw'>def</span> <span class='id identifier rubyid_remote_uninit?'>remote_uninit?</span> |
| <span class='id identifier rubyid_check_state'>check_state</span><span class='lparen'>(</span><span class='const'><span class='object_link'><a href="#REMOTE_UNINIT-constant" title="Qpid::Proton::Endpoint::REMOTE_UNINIT (constant)">REMOTE_UNINIT</a></span></span><span class='rparen'>)</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> ⇒ <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>Return the transport associated with this endpoint.</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> |
| |
| |
| |
| — |
| <div class='inline'> |
| <p>The transport.</p> |
| </div> |
| |
| </li> |
| |
| </ul> |
| |
| </div><table class="source_code"> |
| <tr> |
| <td> |
| <pre class="lines"> |
| |
| |
| 66 |
| 67 |
| 68</pre> |
| </td> |
| <td> |
| <pre class="code"><span class="info file"># File 'lib/core/endpoint.rb', line 66</span> |
| |
| <span class='kw'>def</span> <span class='id identifier rubyid_transport'>transport</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='kw'>end</span></pre> |
| </td> |
| </tr> |
| </table> |
| </div> |
| |
| <div class="method_details "> |
| <h3 class="signature " id="work_queue-instance_method"> |
| |
| #<strong>work_queue</strong> ⇒ <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 work queue for work on this endpoint.</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> |
| |
| |
| |
| — |
| <div class='inline'> |
| <p>the work queue for work on this endpoint.</p> |
| </div> |
| |
| </li> |
| |
| </ul> |
| |
| </div><table class="source_code"> |
| <tr> |
| <td> |
| <pre class="lines"> |
| |
| |
| 71</pre> |
| </td> |
| <td> |
| <pre class="code"><span class="info file"># File 'lib/core/endpoint.rb', line 71</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='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: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> |