| <!DOCTYPE html> |
| <html> |
| <head> |
| <meta charset="utf-8"> |
| <meta name="viewport" content="width=device-width, initial-scale=1.0"> |
| <title> |
| Class: Qpid::Proton::Session |
| |
| — 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::Session"; |
| 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 (S)</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">Session</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::Session |
| |
| |
| |
| </h1> |
| <div class="box_info"> |
| |
| <dl> |
| <dt>Inherits:</dt> |
| <dd> |
| <span class="inheritName"><span class='object_link'><a href="Endpoint.html" title="Qpid::Proton::Endpoint (class)">Endpoint</a></span></span> |
| |
| <ul class="fullTree"> |
| <li>Object</li> |
| |
| <li class="next"><span class='object_link'><a href="Endpoint.html" title="Qpid::Proton::Endpoint (class)">Endpoint</a></span></li> |
| |
| <li class="next">Qpid::Proton::Session</li> |
| |
| </ul> |
| <a href="#" class="inheritanceTree">show all</a> |
| |
| </dd> |
| </dl> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <dl> |
| <dt>Defined in:</dt> |
| <dd>lib/core/session.rb</dd> |
| </dl> |
| |
| </div> |
| |
| <h2>Overview</h2><div class="docstring"> |
| <div class="discussion"> |
| |
| <p>A session is the parent for senders and receivers.</p> |
| |
| <p>A Session has a single parent Qpid::Proton::Connection instance.</p> |
| |
| |
| </div> |
| </div> |
| <div class="tags"> |
| |
| |
| </div> |
| |
| |
| <h2>Constant Summary</h2> |
| |
| <h3 class="inherited">Constants inherited |
| from <span class='object_link'><a href="Endpoint.html" title="Qpid::Proton::Endpoint (class)">Endpoint</a></span></h3> |
| <p class="inherited"><span class='object_link'><a href="Endpoint.html#LOCAL_ACTIVE-constant" title="Qpid::Proton::Endpoint::LOCAL_ACTIVE (constant)">Endpoint::LOCAL_ACTIVE</a></span>, <span class='object_link'><a href="Endpoint.html#LOCAL_CLOSED-constant" title="Qpid::Proton::Endpoint::LOCAL_CLOSED (constant)">Endpoint::LOCAL_CLOSED</a></span>, <span class='object_link'><a href="Endpoint.html#LOCAL_MASK-constant" title="Qpid::Proton::Endpoint::LOCAL_MASK (constant)">Endpoint::LOCAL_MASK</a></span>, <span class='object_link'><a href="Endpoint.html#LOCAL_UNINIT-constant" title="Qpid::Proton::Endpoint::LOCAL_UNINIT (constant)">Endpoint::LOCAL_UNINIT</a></span>, <span class='object_link'><a href="Endpoint.html#REMOTE_ACTIVE-constant" title="Qpid::Proton::Endpoint::REMOTE_ACTIVE (constant)">Endpoint::REMOTE_ACTIVE</a></span>, <span class='object_link'><a href="Endpoint.html#REMOTE_CLOSED-constant" title="Qpid::Proton::Endpoint::REMOTE_CLOSED (constant)">Endpoint::REMOTE_CLOSED</a></span>, <span class='object_link'><a href="Endpoint.html#REMOTE_MASK-constant" title="Qpid::Proton::Endpoint::REMOTE_MASK (constant)">Endpoint::REMOTE_MASK</a></span>, <span class='object_link'><a href="Endpoint.html#REMOTE_UNINIT-constant" title="Qpid::Proton::Endpoint::REMOTE_UNINIT (constant)">Endpoint::REMOTE_UNINIT</a></span></p> |
| |
| |
| |
| |
| |
| |
| <h2> |
| Instance Method Summary |
| <small><a href="#" class="summary_toggle">collapse</a></small> |
| </h2> |
| |
| <ul class="summary"> |
| |
| <li class="public "> |
| <span class="summary_signature"> |
| |
| <a href="#close-instance_method" title="#close (instance method)">#<strong>close</strong>(error = nil) </a> |
| |
| |
| |
| </span> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <span class="summary_desc"><div class='inline'> |
| <p>Close the local end of the session.</p> |
| </div></span> |
| |
| </li> |
| |
| |
| <li class="public "> |
| <span class="summary_signature"> |
| |
| <a href="#connection-instance_method" title="#connection (instance method)">#<strong>connection</strong> ⇒ Connection </a> |
| |
| |
| |
| </span> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <span class="summary_desc"><div class='inline'> |
| <p>Returns the parent connection.</p> |
| </div></span> |
| |
| </li> |
| |
| |
| <li class="public "> |
| <span class="summary_signature"> |
| |
| <a href="#each_link-instance_method" title="#each_link (instance method)">#<strong>each_link</strong> </a> |
| |
| |
| |
| </span> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <span class="summary_desc"><div class='inline'> |
| <p>Get the links on this Session.</p> |
| </div></span> |
| |
| </li> |
| |
| |
| <li class="public "> |
| <span class="summary_signature"> |
| |
| <a href="#each_receiver-instance_method" title="#each_receiver (instance method)">#<strong>each_receiver</strong> </a> |
| |
| |
| |
| </span> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <span class="summary_desc"><div class='inline'> |
| <p>Get the <span class='object_link'><a href="Receiver.html" title="Qpid::Proton::Receiver (class)">Receiver</a></span> links - see <span class='object_link'><a href="#each_link-instance_method" title="Qpid::Proton::Session#each_link (method)">#each_link</a></span>.</p> |
| </div></span> |
| |
| </li> |
| |
| |
| <li class="public "> |
| <span class="summary_signature"> |
| |
| <a href="#each_sender-instance_method" title="#each_sender (instance method)">#<strong>each_sender</strong> </a> |
| |
| |
| |
| </span> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <span class="summary_desc"><div class='inline'> |
| <p>Get the <span class='object_link'><a href="Sender.html" title="Qpid::Proton::Sender (class)">Sender</a></span> links - see <span class='object_link'><a href="#each_link-instance_method" title="Qpid::Proton::Session#each_link (method)">#each_link</a></span>.</p> |
| </div></span> |
| |
| </li> |
| |
| |
| <li class="public deprecated"> |
| <span class="summary_signature"> |
| |
| <a href="#next-instance_method" title="#next (instance method)">#<strong>next</strong>(state_mask) </a> |
| |
| |
| |
| </span> |
| |
| |
| |
| |
| |
| <span class="deprecated note title">deprecated</span> |
| |
| |
| |
| <span class="summary_desc"><strong>Deprecated.</strong> <div class='inline'> |
| <p>use <span class='object_link'><a href="Connection.html#each_session-instance_method" title="Qpid::Proton::Connection#each_session (method)">Connection#each_session</a></span></p> |
| </div></span> |
| |
| </li> |
| |
| |
| <li class="public "> |
| <span class="summary_signature"> |
| |
| <a href="#open_receiver-instance_method" title="#open_receiver (instance method)">#<strong>open_receiver</strong>(opts = nil) ⇒ Receiver </a> |
| |
| |
| |
| </span> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <span class="summary_desc"><div class='inline'> |
| <p>Create and open a <span class='object_link'><a href="Receiver.html" title="Qpid::Proton::Receiver (class)">Receiver</a></span> link, see <span class='object_link'><a href="Receiver.html#open-instance_method" title="Qpid::Proton::Receiver#open (method)">Receiver#open</a></span>.</p> |
| </div></span> |
| |
| </li> |
| |
| |
| <li class="public "> |
| <span class="summary_signature"> |
| |
| <a href="#open_sender-instance_method" title="#open_sender (instance method)">#<strong>open_sender</strong>(opts = nil) ⇒ Sender </a> |
| |
| |
| |
| </span> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <span class="summary_desc"><div class='inline'> |
| <p>Create and open a <span class='object_link'><a href="Sender.html" title="Qpid::Proton::Sender (class)">Sender</a></span> link, see #open.</p> |
| </div></span> |
| |
| </li> |
| |
| |
| <li class="public deprecated"> |
| <span class="summary_signature"> |
| |
| <a href="#receiver-instance_method" title="#receiver (instance method)">#<strong>receiver</strong>(name) </a> |
| |
| |
| |
| </span> |
| |
| |
| |
| |
| |
| <span class="deprecated note title">deprecated</span> |
| |
| |
| |
| <span class="summary_desc"><strong>Deprecated.</strong> <div class='inline'> |
| <p>use <span class='object_link'><a href="#open_receiver-instance_method" title="Qpid::Proton::Session#open_receiver (method)">#open_receiver</a></span></p> |
| </div></span> |
| |
| </li> |
| |
| |
| <li class="public deprecated"> |
| <span class="summary_signature"> |
| |
| <a href="#sender-instance_method" title="#sender (instance method)">#<strong>sender</strong>(name) </a> |
| |
| |
| |
| </span> |
| |
| |
| |
| |
| |
| <span class="deprecated note title">deprecated</span> |
| |
| |
| |
| <span class="summary_desc"><strong>Deprecated.</strong> <div class='inline'> |
| <p>use <span class='object_link'><a href="#open_sender-instance_method" title="Qpid::Proton::Session#open_sender (method)">#open_sender</a></span></p> |
| </div></span> |
| |
| </li> |
| |
| |
| </ul> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <h3 class="inherited">Methods inherited from <span class='object_link'><a href="Endpoint.html" title="Qpid::Proton::Endpoint (class)">Endpoint</a></span></h3> |
| <p class="inherited"><span class='object_link'><a href="Endpoint.html#closed%3F-instance_method" title="Qpid::Proton::Endpoint#closed? (method)">#closed?</a></span>, <span class='object_link'><a href="Endpoint.html#local_closed%3F-instance_method" title="Qpid::Proton::Endpoint#local_closed? (method)">#local_closed?</a></span>, <span class='object_link'><a href="Endpoint.html#local_open%3F-instance_method" title="Qpid::Proton::Endpoint#local_open? (method)">#local_open?</a></span>, <span class='object_link'><a href="Endpoint.html#local_uninit%3F-instance_method" title="Qpid::Proton::Endpoint#local_uninit? (method)">#local_uninit?</a></span>, <span class='object_link'><a href="Endpoint.html#open%3F-instance_method" title="Qpid::Proton::Endpoint#open? (method)">#open?</a></span>, <span class='object_link'><a href="Endpoint.html#remote_closed%3F-instance_method" title="Qpid::Proton::Endpoint#remote_closed? (method)">#remote_closed?</a></span>, <span class='object_link'><a href="Endpoint.html#remote_open%3F-instance_method" title="Qpid::Proton::Endpoint#remote_open? (method)">#remote_open?</a></span>, <span class='object_link'><a href="Endpoint.html#remote_uninit%3F-instance_method" title="Qpid::Proton::Endpoint#remote_uninit? (method)">#remote_uninit?</a></span>, <span class='object_link'><a href="Endpoint.html#transport-instance_method" title="Qpid::Proton::Endpoint#transport (method)">#transport</a></span>, <span class='object_link'><a href="Endpoint.html#work_queue-instance_method" title="Qpid::Proton::Endpoint#work_queue (method)">#work_queue</a></span></p> |
| |
| |
| <div id="instance_method_details" class="method_details_list"> |
| <h2>Instance Method Details</h2> |
| |
| |
| <div class="method_details first"> |
| <h3 class="signature first" id="close-instance_method"> |
| |
| #<strong>close</strong>(error = nil) |
| |
| |
| |
| |
| |
| </h3><div class="docstring"> |
| <div class="discussion"> |
| |
| <p>Close the local end of the session. The remote end may or may not be closed.</p> |
| |
| |
| </div> |
| </div> |
| <div class="tags"> |
| <p class="tag_title">Parameters:</p> |
| <ul class="param"> |
| |
| <li> |
| |
| <span class='name'>error</span> |
| |
| |
| <span class='type'>(<tt><span class='object_link'><a href="Condition.html" title="Qpid::Proton::Condition (class)">Condition</a></span></tt>)</span> |
| |
| |
| <em class="default">(defaults to: <tt>nil</tt>)</em> |
| |
| |
| — |
| <div class='inline'> |
| <p>Optional error condition to send with the close.</p> |
| </div> |
| |
| </li> |
| |
| </ul> |
| |
| |
| </div><table class="source_code"> |
| <tr> |
| <td> |
| <pre class="lines"> |
| |
| |
| 82 |
| 83 |
| 84 |
| 85</pre> |
| </td> |
| <td> |
| <pre class="code"><span class="info file"># File 'lib/core/session.rb', line 82</span> |
| |
| <span class='kw'>def</span> <span class='id identifier rubyid_close'>close</span><span class='lparen'>(</span><span class='id identifier rubyid_error'>error</span><span class='op'>=</span><span class='kw'>nil</span><span class='rparen'>)</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_assign'>assign</span><span class='lparen'>(</span><span class='id identifier rubyid__local_condition'>_local_condition</span><span class='comma'>,</span> <span class='id identifier rubyid_error'>error</span><span class='rparen'>)</span> |
| <span class='const'>Cproton</span><span class='period'>.</span><span class='id identifier rubyid_pn_session_close'>pn_session_close</span><span class='lparen'>(</span><span class='ivar'>@impl</span><span class='rparen'>)</span> |
| <span class='kw'>end</span></pre> |
| </td> |
| </tr> |
| </table> |
| </div> |
| |
| <div class="method_details "> |
| <h3 class="signature " id="connection-instance_method"> |
| |
| #<strong>connection</strong> ⇒ <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> |
| |
| |
| |
| — |
| <div class='inline'> |
| <p>The connection.</p> |
| </div> |
| |
| </li> |
| |
| </ul> |
| |
| </div><table class="source_code"> |
| <tr> |
| <td> |
| <pre class="lines"> |
| |
| |
| 97 |
| 98 |
| 99</pre> |
| </td> |
| <td> |
| <pre class="code"><span class="info file"># File 'lib/core/session.rb', line 97</span> |
| |
| <span class='kw'>def</span> <span class='id identifier rubyid_connection'>connection</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_wrap'>wrap</span><span class='lparen'>(</span><span class='const'>Cproton</span><span class='period'>.</span><span class='id identifier rubyid_pn_session_connection'>pn_session_connection</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="each_link-instance_method"> |
| |
| |
| <span class="overload">#<strong>each_link</strong> {|l| ... } </span> |
| |
| <span class="overload">#<strong>each_link</strong> ⇒ <tt>Enumerator</tt> </span> |
| |
| |
| |
| |
| |
| |
| </h3><div class="docstring"> |
| <div class="discussion"> |
| |
| <p>Get the links on this Session.</p> |
| |
| |
| </div> |
| </div> |
| <div class="tags"> |
| |
| <p class="tag_title">Overloads:</p> |
| <ul class="overload"> |
| |
| |
| <li class="overload_item"> |
| <span class="signature">#<strong>each_link</strong> {|l| ... } </span> |
| <div class="docstring"> |
| <div class="discussion"> |
| |
| |
| </div> |
| </div> |
| <div class="tags"> |
| |
| <p class="tag_title">Yield Parameters:</p> |
| <ul class="yieldparam"> |
| |
| <li> |
| |
| <span class='name'>l</span> |
| |
| |
| <span class='type'>(<tt><span class='object_link'><a href="Link.html" title="Qpid::Proton::Link (class)">Link</a></span></tt>)</span> |
| |
| |
| |
| — |
| <div class='inline'> |
| <p>pass each link to block</p> |
| </div> |
| |
| </li> |
| |
| </ul> |
| |
| </div> |
| </li> |
| |
| |
| <li class="overload_item"> |
| <span class="signature">#<strong>each_link</strong> ⇒ <tt>Enumerator</tt> </span> |
| <div class="docstring"> |
| <div class="discussion"> |
| |
| <p>Returns enumerator over links.</p> |
| |
| |
| </div> |
| </div> |
| <div class="tags"> |
| |
| <p class="tag_title">Returns:</p> |
| <ul class="return"> |
| |
| <li> |
| |
| |
| <span class='type'>(<tt>Enumerator</tt>)</span> |
| |
| |
| |
| — |
| <div class='inline'> |
| <p>enumerator over links</p> |
| </div> |
| |
| </li> |
| |
| </ul> |
| |
| </div> |
| </li> |
| |
| </ul> |
| |
| |
| </div><table class="source_code"> |
| <tr> |
| <td> |
| <pre class="lines"> |
| |
| |
| 132 |
| 133 |
| 134 |
| 135 |
| 136 |
| 137 |
| 138 |
| 139 |
| 140 |
| 141</pre> |
| </td> |
| <td> |
| <pre class="code"><span class="info file"># File 'lib/core/session.rb', line 132</span> |
| |
| <span class='kw'>def</span> <span class='id identifier rubyid_each_link'>each_link</span> |
| <span class='kw'>return</span> <span class='id identifier rubyid_enum_for'>enum_for</span><span class='lparen'>(</span><span class='symbol'>:each_link</span><span class='rparen'>)</span> <span class='kw'>unless</span> <span class='id identifier rubyid_block_given?'>block_given?</span> |
| <span class='id identifier rubyid_l'>l</span> <span class='op'>=</span> <span class='const'>Cproton</span><span class='period'>.</span><span class='id identifier rubyid_pn_link_head'>pn_link_head</span><span class='lparen'>(</span><span class='const'>Cproton</span><span class='period'>.</span><span class='id identifier rubyid_pn_session_connection'>pn_session_connection</span><span class='lparen'>(</span><span class='ivar'>@impl</span><span class='rparen'>)</span><span class='comma'>,</span> <span class='int'>0</span><span class='rparen'>)</span><span class='semicolon'>;</span> |
| <span class='kw'>while</span> <span class='id identifier rubyid_l'>l</span> |
| <span class='id identifier rubyid_link'>link</span> <span class='op'>=</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='id identifier rubyid_l'>l</span><span class='rparen'>)</span> |
| <span class='kw'>yield</span> <span class='id identifier rubyid_link'>link</span> <span class='kw'>if</span> <span class='id identifier rubyid_link'>link</span><span class='period'>.</span><span class='id identifier rubyid_session'>session</span> <span class='op'>==</span> <span class='kw'>self</span> |
| <span class='id identifier rubyid_l'>l</span> <span class='op'>=</span> <span class='const'>Cproton</span><span class='period'>.</span><span class='id identifier rubyid_pn_link_next'>pn_link_next</span><span class='lparen'>(</span><span class='id identifier rubyid_l'>l</span><span class='comma'>,</span> <span class='int'>0</span><span class='rparen'>)</span> |
| <span class='kw'>end</span> |
| <span class='kw'>self</span> |
| <span class='kw'>end</span></pre> |
| </td> |
| </tr> |
| </table> |
| </div> |
| |
| <div class="method_details "> |
| <h3 class="signature " id="each_receiver-instance_method"> |
| |
| #<strong>each_receiver</strong> |
| |
| |
| |
| |
| |
| </h3><div class="docstring"> |
| <div class="discussion"> |
| |
| <p>Get the <span class='object_link'><a href="Receiver.html" title="Qpid::Proton::Receiver (class)">Receiver</a></span> links - see <span class='object_link'><a href="#each_link-instance_method" title="Qpid::Proton::Session#each_link (method)">#each_link</a></span></p> |
| |
| |
| </div> |
| </div> |
| <div class="tags"> |
| |
| |
| </div><table class="source_code"> |
| <tr> |
| <td> |
| <pre class="lines"> |
| |
| |
| 147</pre> |
| </td> |
| <td> |
| <pre class="code"><span class="info file"># File 'lib/core/session.rb', line 147</span> |
| |
| <span class='kw'>def</span> <span class='id identifier rubyid_each_receiver'>each_receiver</span><span class='lparen'>(</span><span class='rparen'>)</span> <span class='id identifier rubyid_each_link'>each_link</span><span class='period'>.</span><span class='id identifier rubyid_select'>select</span> <span class='lbrace'>{</span> <span class='op'>|</span><span class='id identifier rubyid_l'>l</span><span class='op'>|</span> <span class='id identifier rubyid_l'>l</span><span class='period'>.</span><span class='id identifier rubyid_receiver?'>receiver?</span> <span class='rbrace'>}</span><span class='semicolon'>;</span> <span class='kw'>end</span></pre> |
| </td> |
| </tr> |
| </table> |
| </div> |
| |
| <div class="method_details "> |
| <h3 class="signature " id="each_sender-instance_method"> |
| |
| #<strong>each_sender</strong> |
| |
| |
| |
| |
| |
| </h3><div class="docstring"> |
| <div class="discussion"> |
| |
| <p>Get the <span class='object_link'><a href="Sender.html" title="Qpid::Proton::Sender (class)">Qpid::Proton::Sender</a></span> links - see <span class='object_link'><a href="#each_link-instance_method" title="Qpid::Proton::Session#each_link (method)">#each_link</a></span></p> |
| |
| |
| </div> |
| </div> |
| <div class="tags"> |
| |
| |
| </div><table class="source_code"> |
| <tr> |
| <td> |
| <pre class="lines"> |
| |
| |
| 144</pre> |
| </td> |
| <td> |
| <pre class="code"><span class="info file"># File 'lib/core/session.rb', line 144</span> |
| |
| <span class='kw'>def</span> <span class='id identifier rubyid_each_sender'>each_sender</span><span class='lparen'>(</span><span class='rparen'>)</span> <span class='id identifier rubyid_each_link'>each_link</span><span class='period'>.</span><span class='id identifier rubyid_select'>select</span> <span class='lbrace'>{</span> <span class='op'>|</span><span class='id identifier rubyid_l'>l</span><span class='op'>|</span> <span class='id identifier rubyid_l'>l</span><span class='period'>.</span><span class='id identifier rubyid_sender?'>sender?</span> <span class='rbrace'>}</span><span class='semicolon'>;</span> <span class='kw'>end</span></pre> |
| </td> |
| </tr> |
| </table> |
| </div> |
| |
| <div class="method_details "> |
| <h3 class="signature " id="next-instance_method"> |
| |
| #<strong>next</strong>(state_mask) |
| |
| |
| |
| |
| |
| </h3><div class="docstring"> |
| <div class="discussion"> |
| <div class="note deprecated"><strong>Deprecated.</strong> <div class='inline'> |
| <p>use <span class='object_link'><a href="Connection.html#each_session-instance_method" title="Qpid::Proton::Connection#each_session (method)">Connection#each_session</a></span></p> |
| </div></div> |
| |
| |
| </div> |
| </div> |
| <div class="tags"> |
| |
| |
| </div><table class="source_code"> |
| <tr> |
| <td> |
| <pre class="lines"> |
| |
| |
| 88 |
| 89 |
| 90 |
| 91</pre> |
| </td> |
| <td> |
| <pre class="code"><span class="info file"># File 'lib/core/session.rb', line 88</span> |
| |
| <span class='kw'>def</span> <span class='kw'>next</span><span class='lparen'>(</span><span class='id identifier rubyid_state_mask'>state_mask</span><span class='rparen'>)</span> |
| <span class='id identifier rubyid_deprecated'>deprecated</span> <span class='id identifier rubyid___method__'>__method__</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>Connection#each_session</span><span class='tstring_end'>"</span></span> |
| <span class='const'><span class='object_link'><a href="" title="Qpid::Proton::Session (class)">Session</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_session_next'>pn_session_next</span><span class='lparen'>(</span><span class='ivar'>@impl</span><span class='comma'>,</span> <span class='id identifier rubyid_state_mask'>state_mask</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="open_receiver-instance_method"> |
| |
| #<strong>open_receiver</strong>(opts = nil) ⇒ <tt><span class='object_link'><a href="Receiver.html" title="Qpid::Proton::Receiver (class)">Receiver</a></span></tt> |
| |
| |
| |
| |
| |
| </h3><div class="docstring"> |
| <div class="discussion"> |
| |
| <p>Create and open a <span class='object_link'><a href="Receiver.html" title="Qpid::Proton::Receiver (class)">Receiver</a></span> link, see <span class='object_link'><a href="Receiver.html#open-instance_method" title="Qpid::Proton::Receiver#open (method)">Receiver#open</a></span></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>receiver options, see <span class='object_link'><a href="Receiver.html#open-instance_method" title="Qpid::Proton::Receiver#open (method)">Receiver#open</a></span></p> |
| </div> |
| |
| </li> |
| |
| </ul> |
| |
| <p class="tag_title">Returns:</p> |
| <ul class="return"> |
| |
| <li> |
| |
| |
| <span class='type'>(<tt><span class='object_link'><a href="Receiver.html" title="Qpid::Proton::Receiver (class)">Receiver</a></span></tt>)</span> |
| |
| |
| |
| </li> |
| |
| </ul> |
| |
| </div><table class="source_code"> |
| <tr> |
| <td> |
| <pre class="lines"> |
| |
| |
| 116 |
| 117 |
| 118</pre> |
| </td> |
| <td> |
| <pre class="code"><span class="info file"># File 'lib/core/session.rb', line 116</span> |
| |
| <span class='kw'>def</span> <span class='id identifier rubyid_open_receiver'>open_receiver</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='const'><span class='object_link'><a href="Receiver.html" title="Qpid::Proton::Receiver (class)">Receiver</a></span></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_receiver'>pn_receiver</span><span class='lparen'>(</span><span class='ivar'>@impl</span><span class='comma'>,</span> <span class='id identifier rubyid_link_name'>link_name</span><span class='lparen'>(</span><span class='id identifier rubyid_opts'>opts</span><span class='rparen'>)</span><span class='rparen'>)</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_open'>open</span><span class='lparen'>(</span><span class='id identifier rubyid_opts'>opts</span><span class='rparen'>)</span> |
| <span class='kw'>end</span></pre> |
| </td> |
| </tr> |
| </table> |
| </div> |
| |
| <div class="method_details "> |
| <h3 class="signature " id="open_sender-instance_method"> |
| |
| #<strong>open_sender</strong>(opts = nil) ⇒ <tt><span class='object_link'><a href="Sender.html" title="Qpid::Proton::Sender (class)">Sender</a></span></tt> |
| |
| |
| |
| |
| |
| </h3><div class="docstring"> |
| <div class="discussion"> |
| |
| <p>Create and open a <span class='object_link'><a href="Sender.html" title="Qpid::Proton::Sender (class)">Qpid::Proton::Sender</a></span> link, see #open</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>sender options, see <span class='object_link'><a href="Sender.html#open-instance_method" title="Qpid::Proton::Sender#open (method)">Qpid::Proton::Sender#open</a></span></p> |
| </div> |
| |
| </li> |
| |
| </ul> |
| |
| <p class="tag_title">Returns:</p> |
| <ul class="return"> |
| |
| <li> |
| |
| |
| <span class='type'>(<tt><span class='object_link'><a href="Sender.html" title="Qpid::Proton::Sender (class)">Sender</a></span></tt>)</span> |
| |
| |
| |
| </li> |
| |
| </ul> |
| |
| </div><table class="source_code"> |
| <tr> |
| <td> |
| <pre class="lines"> |
| |
| |
| 123 |
| 124 |
| 125</pre> |
| </td> |
| <td> |
| <pre class="code"><span class="info file"># File 'lib/core/session.rb', line 123</span> |
| |
| <span class='kw'>def</span> <span class='id identifier rubyid_open_sender'>open_sender</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='const'><span class='object_link'><a href="Sender.html" title="Qpid::Proton::Sender (class)">Sender</a></span></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_sender'>pn_sender</span><span class='lparen'>(</span><span class='ivar'>@impl</span><span class='comma'>,</span> <span class='id identifier rubyid_link_name'>link_name</span><span class='lparen'>(</span><span class='id identifier rubyid_opts'>opts</span><span class='rparen'>)</span><span class='rparen'>)</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_open'><span class='object_link'><a href="Sender.html#open-instance_method" title="Qpid::Proton::Sender#open (method)">open</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_opts'>opts</span><span class='rparen'>)</span> |
| <span class='kw'>end</span></pre> |
| </td> |
| </tr> |
| </table> |
| </div> |
| |
| <div class="method_details "> |
| <h3 class="signature " id="receiver-instance_method"> |
| |
| #<strong>receiver</strong>(name) |
| |
| |
| |
| |
| |
| </h3><div class="docstring"> |
| <div class="discussion"> |
| <div class="note deprecated"><strong>Deprecated.</strong> <div class='inline'> |
| <p>use <span class='object_link'><a href="#open_receiver-instance_method" title="Qpid::Proton::Session#open_receiver (method)">#open_receiver</a></span></p> |
| </div></div> |
| |
| |
| </div> |
| </div> |
| <div class="tags"> |
| |
| |
| </div><table class="source_code"> |
| <tr> |
| <td> |
| <pre class="lines"> |
| |
| |
| 108 |
| 109 |
| 110 |
| 111</pre> |
| </td> |
| <td> |
| <pre class="code"><span class="info file"># File 'lib/core/session.rb', line 108</span> |
| |
| <span class='kw'>def</span> <span class='id identifier rubyid_receiver'>receiver</span><span class='lparen'>(</span><span class='id identifier rubyid_name'>name</span><span class='rparen'>)</span> |
| <span class='id identifier rubyid_deprecated'>deprecated</span> <span class='id identifier rubyid___method__'>__method__</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>open_receiver</span><span class='tstring_end'>"</span></span> |
| <span class='const'><span class='object_link'><a href="Receiver.html" title="Qpid::Proton::Receiver (class)">Receiver</a></span></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_receiver'>pn_receiver</span><span class='lparen'>(</span><span class='ivar'>@impl</span><span class='comma'>,</span> <span class='id identifier rubyid_name'>name</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="sender-instance_method"> |
| |
| #<strong>sender</strong>(name) |
| |
| |
| |
| |
| |
| </h3><div class="docstring"> |
| <div class="discussion"> |
| <div class="note deprecated"><strong>Deprecated.</strong> <div class='inline'> |
| <p>use <span class='object_link'><a href="#open_sender-instance_method" title="Qpid::Proton::Session#open_sender (method)">#open_sender</a></span></p> |
| </div></div> |
| |
| |
| </div> |
| </div> |
| <div class="tags"> |
| |
| |
| </div><table class="source_code"> |
| <tr> |
| <td> |
| <pre class="lines"> |
| |
| |
| 102 |
| 103 |
| 104 |
| 105</pre> |
| </td> |
| <td> |
| <pre class="code"><span class="info file"># File 'lib/core/session.rb', line 102</span> |
| |
| <span class='kw'>def</span> <span class='id identifier rubyid_sender'>sender</span><span class='lparen'>(</span><span class='id identifier rubyid_name'>name</span><span class='rparen'>)</span> |
| <span class='id identifier rubyid_deprecated'>deprecated</span> <span class='id identifier rubyid___method__'>__method__</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>open_sender</span><span class='tstring_end'>"</span></span> |
| <span class='const'><span class='object_link'><a href="Sender.html" title="Qpid::Proton::Sender (class)">Sender</a></span></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_sender'>pn_sender</span><span class='lparen'>(</span><span class='ivar'>@impl</span><span class='comma'>,</span> <span class='id identifier rubyid_name'>name</span><span class='rparen'>)</span><span class='rparen'>)</span><span class='semicolon'>;</span> |
| <span class='kw'>end</span></pre> |
| </td> |
| </tr> |
| </table> |
| </div> |
| |
| </div> |
| |
| </div> |
| |
| <div id="footer"> |
| Generated on Tue Apr 13 13:43:58 2021 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> |