Google Git
Sign in
apache / qpid-site / 04beb6e78eda47fdfc2fcfc1d2eeb9a270f89a87 / . / input / releases / qpid-proton-0.32.0 / proton / ruby / api / Qpid / Proton / Receiver.html
blob: 00beac1bd53a455957fccd525a57c0fc0dc730e0 [file] [log] [blame]
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
Class: Qpid::Proton::Receiver
&mdash; Qpid Proton Ruby API
</title>
<link rel="stylesheet" href="../../css/style.css" type="text/css" />
<link rel="stylesheet" href="../../css/common.css" type="text/css" />
<script type="text/javascript">
pathId = "Qpid::Proton::Receiver";
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 (R)</a> &raquo;
<span class='title'><span class='object_link'><a href="../../Qpid.html" title="Qpid (module)">Qpid</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Proton.html" title="Qpid::Proton (module)">Proton</a></span></span>
&raquo;
<span class="title">Receiver</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::Receiver
</h1>
<div class="box_info">
<dl>
<dt>Inherits:</dt>
<dd>
<span class="inheritName"><span class='object_link'><a href="Link.html" title="Qpid::Proton::Link (class)">Link</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"><span class='object_link'><a href="Link.html" title="Qpid::Proton::Link (class)">Link</a></span></li>
<li class="next">Qpid::Proton::Receiver</li>
</ul>
<a href="#" class="inheritanceTree">show all</a>
</dd>
</dl>
<dl>
<dt>Defined in:</dt>
<dd>lib/core/receiver.rb</dd>
</dl>
</div>
<h2>Overview</h2><div class="docstring">
<div class="discussion">
<p>The receiving endpoint.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">See Also:</p>
<ul class="see">
<li><span class='object_link'><a href="Sender.html" title="Qpid::Proton::Sender (class)">Sender</a></span></li>
</ul>
</div>
<h2>Constant Summary</h2>
<h3 class="inherited">Constants inherited
from <span class='object_link'><a href="Link.html" title="Qpid::Proton::Link (class)">Link</a></span></h3>
<p class="inherited"><span class='object_link'><a href="Link.html#RCV_FIRST-constant" title="Qpid::Proton::Link::RCV_FIRST (constant)">Link::RCV_FIRST</a></span>, <span class='object_link'><a href="Link.html#RCV_SECOND-constant" title="Qpid::Proton::Link::RCV_SECOND (constant)">Link::RCV_SECOND</a></span>, <span class='object_link'><a href="Link.html#SND_MIXED-constant" title="Qpid::Proton::Link::SND_MIXED (constant)">Link::SND_MIXED</a></span>, <span class='object_link'><a href="Link.html#SND_SETTLED-constant" title="Qpid::Proton::Link::SND_SETTLED (constant)">Link::SND_SETTLED</a></span>, <span class='object_link'><a href="Link.html#SND_UNSETTLED-constant" title="Qpid::Proton::Link::SND_UNSETTLED (constant)">Link::SND_UNSETTLED</a></span></p>
<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 Attribute Summary <small><a href="#" class="summary_toggle">collapse</a></small></h2>
<ul class="summary">
<li class="public ">
<span class="summary_signature">
<a href="#auto_accept-instance_method" title="#auto_accept (instance method)">#<strong>auto_accept</strong> &#x21d2; Boolean </a>
</span>
<span class="note title readonly">readonly</span>
<span class="summary_desc"><div class='inline'>
<p>Auto_accept flag, see <span class='object_link'><a href="#open-instance_method" title="Qpid::Proton::Receiver#open (method)">#open</a></span>.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#credit_window-instance_method" title="#credit_window (instance method)">#<strong>credit_window</strong> &#x21d2; Integer </a>
</span>
<span class="note title readonly">readonly</span>
<span class="summary_desc"><div class='inline'>
<p>Credit window, see <span class='object_link'><a href="#open-instance_method" title="Qpid::Proton::Receiver#open (method)">#open</a></span>.</p>
</div></span>
</li>
</ul>
<h2>
Instance Method Summary
<small><a href="#" class="summary_toggle">collapse</a></small>
</h2>
<ul class="summary">
<li class="public ">
<span class="summary_signature">
<a href="#flow-instance_method" title="#flow (instance method)">#<strong>flow</strong>(n) </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Grants credit for incoming deliveries.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#open-instance_method" title="#open (instance method)">#<strong>open</strong>(opts = nil) </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Open <span class='object_link'><a href="" title="Qpid::Proton::Receiver (class)">Receiver</a></span> link.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#receive-instance_method" title="#receive (instance method)">#<strong>receive</strong>(limit) &#x21d2; Integer<sup>?</sup> </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Allows receiving up to the specified limit of data from the remote endpoint.</p>
</div></span>
</li>
</ul>
<h3 class="inherited">Methods inherited from <span class='object_link'><a href="Link.html" title="Qpid::Proton::Link (class)">Link</a></span></h3>
<p class="inherited"><span class='object_link'><a href="Link.html#==-instance_method" title="Qpid::Proton::Link#== (method)">#==</a></span>, <span class='object_link'><a href="Link.html#advance-instance_method" title="Qpid::Proton::Link#advance (method)">#advance</a></span>, <span class='object_link'><a href="Link.html#close-instance_method" title="Qpid::Proton::Link#close (method)">#close</a></span>, <span class='object_link'><a href="Link.html#connection-instance_method" title="Qpid::Proton::Link#connection (method)">#connection</a></span>, <span class='object_link'><a href="Link.html#current-instance_method" title="Qpid::Proton::Link#current (method)">#current</a></span>, <span class='object_link'><a href="Link.html#delivery-instance_method" title="Qpid::Proton::Link#delivery (method)">#delivery</a></span>, <span class='object_link'><a href="Link.html#drained-instance_method" title="Qpid::Proton::Link#drained (method)">#drained</a></span>, <span class='object_link'><a href="Link.html#error-instance_method" title="Qpid::Proton::Link#error (method)">#error</a></span>, <span class='object_link'><a href="Link.html#next-instance_method" title="Qpid::Proton::Link#next (method)">#next</a></span>, <span class='object_link'><a href="Link.html#rcv_settle_mode-instance_method" title="Qpid::Proton::Link#rcv_settle_mode (method)">#rcv_settle_mode</a></span>, <span class='object_link'><a href="Link.html#rcv_settle_mode=-instance_method" title="Qpid::Proton::Link#rcv_settle_mode= (method)">#rcv_settle_mode=</a></span>, <span class='object_link'><a href="Link.html#remote_source-instance_method" title="Qpid::Proton::Link#remote_source (method)">#remote_source</a></span>, <span class='object_link'><a href="Link.html#remote_target-instance_method" title="Qpid::Proton::Link#remote_target (method)">#remote_target</a></span>, <span class='object_link'><a href="Link.html#session-instance_method" title="Qpid::Proton::Link#session (method)">#session</a></span>, <span class='object_link'><a href="Link.html#snd_settle_mode-instance_method" title="Qpid::Proton::Link#snd_settle_mode (method)">#snd_settle_mode</a></span>, <span class='object_link'><a href="Link.html#snd_settle_mode=-instance_method" title="Qpid::Proton::Link#snd_settle_mode= (method)">#snd_settle_mode=</a></span>, <span class='object_link'><a href="Link.html#source-instance_method" title="Qpid::Proton::Link#source (method)">#source</a></span>, <span class='object_link'><a href="Link.html#target-instance_method" title="Qpid::Proton::Link#target (method)">#target</a></span></p>
<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_attr_details" class="attr_details">
<h2>Instance Attribute Details</h2>
<span id=""></span>
<div class="method_details first">
<h3 class="signature first" id="auto_accept-instance_method">
#<strong>auto_accept</strong> &#x21d2; <tt>Boolean</tt> <span class="extras">(readonly)</span>
</h3><div class="docstring">
<div class="discussion">
<p>Returns auto_accept flag, see <span class='object_link'><a href="#open-instance_method" title="Qpid::Proton::Receiver#open (method)">#open</a></span>.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>Boolean</tt>)</span>
&mdash;
<div class='inline'>
<p>auto_accept flag, see <span class='object_link'><a href="#open-instance_method" title="Qpid::Proton::Receiver#open (method)">#open</a></span></p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
62
63
64</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/core/receiver.rb', line 62</span>
<span class='kw'>def</span> <span class='id identifier rubyid_auto_accept'>auto_accept</span>
<span class='ivar'>@auto_accept</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id=""></span>
<div class="method_details ">
<h3 class="signature " id="credit_window-instance_method">
#<strong>credit_window</strong> &#x21d2; <tt>Integer</tt> <span class="extras">(readonly)</span>
</h3><div class="docstring">
<div class="discussion">
<p>Returns credit window, see <span class='object_link'><a href="#open-instance_method" title="Qpid::Proton::Receiver#open (method)">#open</a></span>.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>Integer</tt>)</span>
&mdash;
<div class='inline'>
<p>credit window, see <span class='object_link'><a href="#open-instance_method" title="Qpid::Proton::Receiver#open (method)">#open</a></span></p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
59
60
61</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/core/receiver.rb', line 59</span>
<span class='kw'>def</span> <span class='id identifier rubyid_credit_window'>credit_window</span>
<span class='ivar'>@credit_window</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
<div id="instance_method_details" class="method_details_list">
<h2>Instance Method Details</h2>
<div class="method_details first">
<h3 class="signature first" id="flow-instance_method">
#<strong>flow</strong>(n)
</h3><div class="docstring">
<div class="discussion">
<p>Grants credit for incoming deliveries.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>n</span>
<span class='type'>(<tt>Integer</tt>)</span>
&mdash;
<div class='inline'>
<p>The amount to increment the link credit.</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
93
94
95</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/core/receiver.rb', line 93</span>
<span class='kw'>def</span> <span class='id identifier rubyid_flow'>flow</span><span class='lparen'>(</span><span class='id identifier rubyid_n'>n</span><span class='rparen'>)</span>
<span class='const'>Cproton</span><span class='period'>.</span><span class='id identifier rubyid_pn_link_flow'>pn_link_flow</span><span class='lparen'>(</span><span class='ivar'>@impl</span><span class='comma'>,</span> <span class='id identifier rubyid_n'>n</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">
<span class="overload">#<strong>open_receiver</strong>(address) </span>
<span class="overload">#<strong>open_receiver</strong>(opts) </span>
</h3><div class="docstring">
<div class="discussion">
<p>Open <span class='object_link'><a href="" title="Qpid::Proton::Receiver (class)">Qpid::Proton::Receiver</a></span> link</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Overloads:</p>
<ul class="overload">
<li class="overload_item">
<span class="signature">#<strong>open_receiver</strong>(address) </span>
<div class="docstring">
<div class="discussion">
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>address</span>
<span class='type'>(<tt>String</tt>)</span>
&mdash;
<div class='inline'>
<p>address of the source to receive from</p>
</div>
</li>
</ul>
</div>
</li>
<li class="overload_item">
<span class="signature">#<strong>open_receiver</strong>(opts) </span>
<div class="docstring">
<div class="discussion">
</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>
&mdash;
<div class='inline'>
<p>Receiver options, see <span class='object_link'><a href="#open-instance_method" title="Qpid::Proton::Receiver#open (method)">#open</a></span></p>
</div>
</li>
</ul>
<p class="tag_title">Options Hash (<tt>opts</tt>):</p>
<ul class="option">
<li>
<span class="name">:credit_window</span>
<span class="type">(<tt>Integer</tt>)</span>
<span class="default">
</span>
&mdash; <div class='inline'>
<p>automatically maintain this much credit for messages to be pre-fetched while the current message is processed.</p>
</div>
</li>
<li>
<span class="name">:auto_accept</span>
<span class="type">(<tt>Boolean</tt>)</span>
<span class="default">
</span>
&mdash; <div class='inline'>
<p>if true, deliveries that are not settled by the application in <span class='object_link'>MessagingHandler#on_message</span> are automatically accepted.</p>
</div>
</li>
<li>
<span class="name">:dynamic</span>
<span class="type">(<tt>Boolean</tt>)</span>
<span class="default">
&mdash; default:
<tt>false</tt>
</span>
&mdash; <div class='inline'>
<p>dynamic property for source Terminus#dynamic</p>
</div>
</li>
<li>
<span class="name">:source</span>
<span class="type">(<tt>String</tt>, <tt><span class='object_link'>Hash</span></tt>)</span>
<span class="default">
</span>
&mdash; <div class='inline'>
<p>source address or source options, see <span class='object_link'><a href="Terminus.html#apply-instance_method" title="Qpid::Proton::Terminus#apply (method)">Terminus#apply</a></span></p>
</div>
</li>
<li>
<span class="name">:target</span>
<span class="type">(<tt>String</tt>, <tt><span class='object_link'>Hash</span></tt>)</span>
<span class="default">
</span>
&mdash; <div class='inline'>
<p>target address or target options, see <span class='object_link'><a href="Terminus.html#apply-instance_method" title="Qpid::Proton::Terminus#apply (method)">Terminus#apply</a></span></p>
</div>
</li>
<li>
<span class="name">:name</span>
<span class="type">(<tt>String</tt>)</span>
<span class="default">
&mdash; default:
<tt>generated</tt>
</span>
&mdash; <div class='inline'>
<p>unique name for the link.</p>
</div>
</li>
</ul>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
46
47
48
49
50
51
52
53
54
55
56</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/core/receiver.rb', line 46</span>
<span class='kw'>def</span> <span class='id identifier rubyid_open'>open</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='id identifier rubyid_opts'>opts</span> <span class='op'>||=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
<span class='id identifier rubyid_opts'>opts</span> <span class='op'>=</span> <span class='lbrace'>{</span> <span class='symbol'>:source</span> <span class='op'>=&gt;</span> <span class='id identifier rubyid_opts'>opts</span> <span class='rbrace'>}</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='ivar'>@credit_window</span> <span class='op'>=</span> <span class='id identifier rubyid_opts'>opts</span><span class='period'>.</span><span class='id identifier rubyid_fetch'>fetch</span><span class='lparen'>(</span><span class='symbol'>:credit_window</span><span class='comma'>,</span> <span class='int'>10</span><span class='rparen'>)</span>
<span class='ivar'>@auto_accept</span> <span class='op'>=</span> <span class='id identifier rubyid_opts'>opts</span><span class='period'>.</span><span class='id identifier rubyid_fetch'>fetch</span><span class='lparen'>(</span><span class='symbol'>:auto_accept</span><span class='comma'>,</span> <span class='kw'>true</span><span class='rparen'>)</span>
<span class='id identifier rubyid_source'>source</span><span class='period'>.</span><span class='id identifier rubyid_apply'>apply</span><span class='lparen'>(</span><span class='id identifier rubyid_opts'>opts</span><span class='lbracket'>[</span><span class='symbol'>:source</span><span class='rbracket'>]</span><span class='rparen'>)</span>
<span class='id identifier rubyid_target'>target</span><span class='period'>.</span><span class='id identifier rubyid_apply'>apply</span><span class='lparen'>(</span><span class='id identifier rubyid_opts'>opts</span><span class='lbracket'>[</span><span class='symbol'>:target</span><span class='rbracket'>]</span><span class='rparen'>)</span>
<span class='id identifier rubyid_source'>source</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_opts'>opts</span><span class='lbracket'>[</span><span class='symbol'>:dynamic</span><span class='rbracket'>]</span>
<span class='kw'>super</span><span class='lparen'>(</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="receive-instance_method">
#<strong>receive</strong>(limit) &#x21d2; <tt>Integer</tt><sup>?</sup>
</h3><div class="docstring">
<div class="discussion">
<p>Allows receiving up to the specified limit of data from the remote endpoint.</p>
<p>Note that large messages can be streamed across the network, so just because there is no data to read does not imply the message is complete.</p>
<p>To ensure the entirety of the message data has been read, either call #receive until nil is returned, or verify that #partial? is false and Delivery#pending is 0.</p>
<p>the stream was reached.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>limit</span>
<span class='type'>(<tt>Integer</tt>)</span>
&mdash;
<div class='inline'>
<p>The maximum bytes to receive.</p>
</div>
</li>
</ul>
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>Integer</tt>, <tt>nil</tt>)</span>
&mdash;
<div class='inline'>
<p>The number of bytes received, or nil if the end of</p>
</div>
</li>
</ul>
<p class="tag_title">Raises:</p>
<ul class="raise">
<li>
<span class='type'>(<tt><span class='object_link'><a href="LinkError.html" title="Qpid::Proton::LinkError (class)">LinkError</a></span></tt>)</span>
&mdash;
<div class='inline'>
<p>If an error occurs.</p>
</div>
</li>
</ul>
<p class="tag_title">See Also:</p>
<ul class="see">
<li>To see how much buffer space is needed.</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
116
117
118
119
120
121</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/core/receiver.rb', line 116</span>
<span class='kw'>def</span> <span class='id identifier rubyid_receive'>receive</span><span class='lparen'>(</span><span class='id identifier rubyid_limit'>limit</span><span class='rparen'>)</span>
<span class='lparen'>(</span><span class='id identifier rubyid_n'>n</span><span class='comma'>,</span> <span class='id identifier rubyid_bytes'>bytes</span><span class='rparen'>)</span> <span class='op'>=</span> <span class='const'>Cproton</span><span class='period'>.</span><span class='id identifier rubyid_pn_link_recv'>pn_link_recv</span><span class='lparen'>(</span><span class='ivar'>@impl</span><span class='comma'>,</span> <span class='id identifier rubyid_limit'>limit</span><span class='rparen'>)</span>
<span class='kw'>return</span> <span class='kw'>nil</span> <span class='kw'>if</span> <span class='id identifier rubyid_n'>n</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'>Error</span><span class='op'>::</span><span class='const'>EOS</span>
<span class='id identifier rubyid_raise'>raise</span> <span class='const'><span class='object_link'><a href="LinkError.html" title="Qpid::Proton::LinkError (class)">LinkError</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>[</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_n'>n</span><span class='embexpr_end'>}</span><span class='tstring_content'>]: </span><span class='embexpr_beg'>#{</span><span class='const'>Cproton</span><span class='period'>.</span><span class='id identifier rubyid_pn_link_error'>pn_link_error</span><span class='lparen'>(</span><span class='ivar'>@impl</span><span class='rparen'>)</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span> <span class='kw'>if</span> <span class='id identifier rubyid_n'>n</span> <span class='op'>&lt;</span> <span class='int'>0</span>
<span class='kw'>return</span> <span class='id identifier rubyid_bytes'>bytes</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>