| <!DOCTYPE html> |
| <html> |
| <head> |
| <meta charset="utf-8"> |
| <meta name="viewport" content="width=device-width, initial-scale=1.0"> |
| <title> |
| Class: Qpid::Proton::Sender |
| |
| — 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::Sender"; |
| 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">Sender</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::Sender |
| |
| |
| |
| </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::Sender</li> |
| |
| </ul> |
| <a href="#" class="inheritanceTree">show all</a> |
| |
| </dd> |
| </dl> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <dl> |
| <dt>Defined in:</dt> |
| <dd>lib/core/sender.rb</dd> |
| </dl> |
| |
| </div> |
| |
| <h2>Overview</h2><div class="docstring"> |
| <div class="discussion"> |
| |
| <p>The sending endpoint.</p> |
| |
| |
| </div> |
| </div> |
| <div class="tags"> |
| |
| |
| <p class="tag_title">See Also:</p> |
| <ul class="see"> |
| |
| <li><span class='object_link'><a href="Receiver.html" title="Qpid::Proton::Receiver (class)">Receiver</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_settle-instance_method" title="#auto_settle (instance method)">#<strong>auto_settle</strong> ⇒ Boolean </a> |
| |
| |
| |
| </span> |
| |
| |
| |
| |
| <span class="note title readonly">readonly</span> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <span class="summary_desc"><div class='inline'> |
| <p>Auto_settle flag, see <span class='object_link'><a href="#open-instance_method" title="Qpid::Proton::Sender#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 deprecated"> |
| <span class="summary_signature"> |
| |
| <a href="#delivery_tag-instance_method" title="#delivery_tag (instance method)">#<strong>delivery_tag</strong> </a> |
| |
| |
| |
| </span> |
| |
| |
| |
| |
| |
| <span class="deprecated note title">deprecated</span> |
| |
| |
| |
| <span class="summary_desc"><strong>Deprecated.</strong> <div class='inline'> |
| <p>internal use only</p> |
| </div></span> |
| |
| </li> |
| |
| |
| <li class="public "> |
| <span class="summary_signature"> |
| |
| <a href="#offered-instance_method" title="#offered (instance method)">#<strong>offered</strong>(n) </a> |
| |
| |
| |
| </span> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <span class="summary_desc"><div class='inline'> |
| <p>Hint to the remote receiver about the number of messages available.</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 the <span class='object_link'><a href="" title="Qpid::Proton::Sender (class)">Sender</a></span> link.</p> |
| </div></span> |
| |
| </li> |
| |
| |
| <li class="public "> |
| <span class="summary_signature"> |
| |
| <a href="#send-instance_method" title="#send (instance method)">#<strong>send</strong>(message) ⇒ Tracker </a> |
| |
| |
| |
| </span> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <span class="summary_desc"><div class='inline'> |
| <p>Send a message.</p> |
| </div></span> |
| |
| </li> |
| |
| |
| <li class="public deprecated"> |
| <span class="summary_signature"> |
| |
| <a href="#stream-instance_method" title="#stream (instance method)">#<strong>stream</strong>(bytes) </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="#send-instance_method" title="Qpid::Proton::Sender#send (method)">#send</a></span></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_settle-instance_method"> |
| |
| #<strong>auto_settle</strong> ⇒ <tt>Boolean</tt> <span class="extras">(readonly)</span> |
| |
| |
| |
| |
| |
| </h3><div class="docstring"> |
| <div class="discussion"> |
| |
| <p>Returns auto_settle flag, see <span class='object_link'><a href="#open-instance_method" title="Qpid::Proton::Sender#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> |
| |
| |
| |
| — |
| <div class='inline'> |
| <p>auto_settle flag, see <span class='object_link'><a href="#open-instance_method" title="Qpid::Proton::Sender#open (method)">#open</a></span></p> |
| </div> |
| |
| </li> |
| |
| </ul> |
| |
| </div><table class="source_code"> |
| <tr> |
| <td> |
| <pre class="lines"> |
| |
| |
| 52 |
| 53 |
| 54</pre> |
| </td> |
| <td> |
| <pre class="code"><span class="info file"># File 'lib/core/sender.rb', line 52</span> |
| |
| <span class='kw'>def</span> <span class='id identifier rubyid_auto_settle'>auto_settle</span> |
| <span class='ivar'>@auto_settle</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="delivery_tag-instance_method"> |
| |
| #<strong>delivery_tag</strong> |
| |
| |
| |
| |
| |
| </h3><div class="docstring"> |
| <div class="discussion"> |
| <div class="note deprecated"><strong>Deprecated.</strong> <div class='inline'> |
| <p>internal use only</p> |
| </div></div> |
| |
| |
| </div> |
| </div> |
| <div class="tags"> |
| |
| |
| </div><table class="source_code"> |
| <tr> |
| <td> |
| <pre class="lines"> |
| |
| |
| 89</pre> |
| </td> |
| <td> |
| <pre class="code"><span class="info file"># File 'lib/core/sender.rb', line 89</span> |
| |
| <span class='kw'>def</span> <span class='id identifier rubyid_delivery_tag'>delivery_tag</span><span class='lparen'>(</span><span class='rparen'>)</span> <span class='id identifier rubyid_deprecated'>deprecated</span><span class='lparen'>(</span><span class='id identifier rubyid___method__'>__method__</span><span class='rparen'>)</span><span class='semicolon'>;</span> <span class='id identifier rubyid_next_tag'>next_tag</span><span class='semicolon'>;</span> <span class='kw'>end</span></pre> |
| </td> |
| </tr> |
| </table> |
| </div> |
| |
| <div class="method_details "> |
| <h3 class="signature " id="offered-instance_method"> |
| |
| #<strong>offered</strong>(n) |
| |
| |
| |
| |
| |
| </h3><div class="docstring"> |
| <div class="discussion"> |
| |
| <p>Hint to the remote receiver about the number of messages available. The receiver may use this to optimize credit flow, or may ignore it.</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> |
| |
| |
| |
| — |
| <div class='inline'> |
| <p>The number of deliveries potentially available.</p> |
| </div> |
| |
| </li> |
| |
| </ul> |
| |
| |
| </div><table class="source_code"> |
| <tr> |
| <td> |
| <pre class="lines"> |
| |
| |
| 57 |
| 58 |
| 59</pre> |
| </td> |
| <td> |
| <pre class="code"><span class="info file"># File 'lib/core/sender.rb', line 57</span> |
| |
| <span class='kw'>def</span> <span class='id identifier rubyid_offered'>offered</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_offered'>pn_link_offered</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_sender</strong>(address) </span> |
| |
| <span class="overload">#<strong>open_sender</strong>(opts) </span> |
| |
| |
| |
| |
| |
| |
| </h3><div class="docstring"> |
| <div class="discussion"> |
| |
| <p>Open the <span class='object_link'><a href="" title="Qpid::Proton::Sender (class)">Qpid::Proton::Sender</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_sender</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> |
| |
| |
| |
| — |
| <div class='inline'> |
| <p>address of the target to send to</p> |
| </div> |
| |
| </li> |
| |
| </ul> |
| |
| |
| </div> |
| </li> |
| |
| |
| <li class="overload_item"> |
| <span class="signature">#<strong>open_sender</strong>(opts) </span> |
| <div class="docstring"> |
| <div class="discussion"> |
| |
| |
| </div> |
| </div> |
| <div class="tags"> |
| |
| |
| |
| |
| <p class="tag_title">Options Hash (<tt>opts</tt>):</p> |
| <ul class="option"> |
| |
| <li> |
| <span class="name">:auto_settle</span> |
| <span class="type">(<tt>Boolean</tt>)</span> |
| <span class="default"> |
| |
| — default: |
| <tt>true</tt> |
| |
| </span> |
| |
| — <div class='inline'> |
| <p>if true, automatically settle transfers</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>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> |
| |
| — <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> |
| |
| — <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"> |
| |
| — default: |
| <tt>generated</tt> |
| |
| </span> |
| |
| — <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"> |
| |
| |
| 40 |
| 41 |
| 42 |
| 43 |
| 44 |
| 45 |
| 46 |
| 47 |
| 48 |
| 49</pre> |
| </td> |
| <td> |
| <pre class="code"><span class="info file"># File 'lib/core/sender.rb', line 40</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='symbol'>:target</span> <span class='op'>=></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='id identifier rubyid_opts'>opts</span> <span class='op'>||=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span> |
| <span class='id identifier rubyid_target'>target</span><span class='period'>.</span><span class='id identifier rubyid_apply'>apply</span> <span class='id identifier rubyid_opts'>opts</span><span class='lbracket'>[</span><span class='symbol'>:target</span><span class='rbracket'>]</span> |
| <span class='id identifier rubyid_source'>source</span><span class='period'>.</span><span class='id identifier rubyid_apply'>apply</span> <span class='id identifier rubyid_opts'>opts</span><span class='lbracket'>[</span><span class='symbol'>:source</span><span class='rbracket'>]</span> |
| <span class='id identifier rubyid_target'>target</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='ivar'>@auto_settle</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_settle</span><span class='comma'>,</span> <span class='kw'>true</span><span class='rparen'>)</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="send-instance_method"> |
| |
| #<strong>send</strong>(message) ⇒ <tt><span class='object_link'><a href="Tracker.html" title="Qpid::Proton::Tracker (class)">Tracker</a></span></tt> |
| |
| |
| |
| |
| |
| </h3><div class="docstring"> |
| <div class="discussion"> |
| |
| <p>Send a message.</p> |
| |
| |
| </div> |
| </div> |
| <div class="tags"> |
| <p class="tag_title">Parameters:</p> |
| <ul class="param"> |
| |
| <li> |
| |
| <span class='name'>message</span> |
| |
| |
| <span class='type'>(<tt><span class='object_link'><a href="Message.html" title="Qpid::Proton::Message (class)">Message</a></span></tt>)</span> |
| |
| |
| |
| — |
| <div class='inline'> |
| <p>The message to send.</p> |
| </div> |
| |
| </li> |
| |
| </ul> |
| |
| <p class="tag_title">Returns:</p> |
| <ul class="return"> |
| |
| <li> |
| |
| |
| <span class='type'>(<tt><span class='object_link'><a href="Tracker.html" title="Qpid::Proton::Tracker (class)">Tracker</a></span></tt>)</span> |
| |
| |
| |
| — |
| <div class='inline'> |
| <p>Tracks the outcome of the message.</p> |
| </div> |
| |
| </li> |
| |
| </ul> |
| |
| </div><table class="source_code"> |
| <tr> |
| <td> |
| <pre class="lines"> |
| |
| |
| 67 |
| 68 |
| 69 |
| 70 |
| 71 |
| 72 |
| 73 |
| 74 |
| 75 |
| 76 |
| 77 |
| 78 |
| 79 |
| 80</pre> |
| </td> |
| <td> |
| <pre class="code"><span class="info file"># File 'lib/core/sender.rb', line 67</span> |
| |
| <span class='kw'>def</span> <span class='id identifier rubyid_send'>send</span><span class='lparen'>(</span><span class='id identifier rubyid_message'>message</span><span class='comma'>,</span> <span class='op'>*</span><span class='id identifier rubyid_args'>args</span><span class='rparen'>)</span> |
| <span class='id identifier rubyid_tag'>tag</span> <span class='op'>=</span> <span class='kw'>nil</span> |
| <span class='kw'>if</span> <span class='id identifier rubyid_args'>args</span><span class='period'>.</span><span class='id identifier rubyid_size'>size</span> <span class='op'>></span> <span class='int'>0</span> <span class='comment'># deprecated: allow tag in args[0] for backwards compat |
| </span> |
| <span class='id identifier rubyid_raise'>raise</span> <span class='const'><span class='object_link'><a href="ArgumentError.html" title="Qpid::Proton::ArgumentError (class)">ArgumentError</a></span></span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>too many arguments</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span> <span class='kw'>if</span> <span class='id identifier rubyid_args'>args</span><span class='period'>.</span><span class='id identifier rubyid_size'>size</span> <span class='op'>></span> <span class='int'>1</span> |
| <span class='id identifier rubyid_tag'>tag</span> <span class='op'>=</span> <span class='id identifier rubyid_args'>args</span><span class='lbracket'>[</span><span class='int'>0</span><span class='rbracket'>]</span> |
| <span class='kw'>end</span> |
| <span class='id identifier rubyid_tag'>tag</span> <span class='op'>||=</span> <span class='id identifier rubyid_next_tag'>next_tag</span> |
| <span class='id identifier rubyid_t'>t</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="Tracker.html" title="Qpid::Proton::Tracker (class)">Tracker</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Transfer.html#initialize-instance_method" title="Qpid::Proton::Transfer#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='const'>Cproton</span><span class='period'>.</span><span class='id identifier rubyid_pn_delivery'>pn_delivery</span><span class='lparen'>(</span><span class='ivar'>@impl</span><span class='comma'>,</span> <span class='id identifier rubyid_tag'>tag</span><span class='rparen'>)</span><span class='rparen'>)</span> |
| <span class='const'>Cproton</span><span class='period'>.</span><span class='id identifier rubyid_pn_link_send'>pn_link_send</span><span class='lparen'>(</span><span class='ivar'>@impl</span><span class='comma'>,</span> <span class='id identifier rubyid_message'>message</span><span class='period'>.</span><span class='id identifier rubyid_encode'>encode</span><span class='rparen'>)</span> |
| <span class='const'>Cproton</span><span class='period'>.</span><span class='id identifier rubyid_pn_link_advance'>pn_link_advance</span><span class='lparen'>(</span><span class='ivar'>@impl</span><span class='rparen'>)</span> |
| <span class='id identifier rubyid_t'>t</span><span class='period'>.</span><span class='id identifier rubyid_settle'>settle</span> <span class='kw'>if</span> <span class='id identifier rubyid_snd_settle_mode'>snd_settle_mode</span> <span class='op'>==</span> <span class='const'><span class='object_link'><a href="Link.html#SND_SETTLED-constant" title="Qpid::Proton::Link::SND_SETTLED (constant)">SND_SETTLED</a></span></span> |
| <span class='kw'>return</span> <span class='id identifier rubyid_t'>t</span> |
| <span class='kw'>end</span></pre> |
| </td> |
| </tr> |
| </table> |
| </div> |
| |
| <div class="method_details "> |
| <h3 class="signature " id="stream-instance_method"> |
| |
| #<strong>stream</strong>(bytes) |
| |
| |
| |
| |
| |
| </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="#send-instance_method" title="Qpid::Proton::Sender#send (method)">#send</a></span></p> |
| </div></div> |
| |
| |
| </div> |
| </div> |
| <div class="tags"> |
| |
| |
| </div><table class="source_code"> |
| <tr> |
| <td> |
| <pre class="lines"> |
| |
| |
| 83 |
| 84 |
| 85 |
| 86</pre> |
| </td> |
| <td> |
| <pre class="code"><span class="info file"># File 'lib/core/sender.rb', line 83</span> |
| |
| <span class='kw'>def</span> <span class='id identifier rubyid_stream'>stream</span><span class='lparen'>(</span><span class='id identifier rubyid_bytes'>bytes</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'>send</span><span class='tstring_end'>"</span></span> |
| <span class='const'>Cproton</span><span class='period'>.</span><span class='id identifier rubyid_pn_link_send'>pn_link_send</span><span class='lparen'>(</span><span class='ivar'>@impl</span><span class='comma'>,</span> <span class='id identifier rubyid_bytes'>bytes</span><span class='rparen'>)</span> |
| <span class='kw'>end</span></pre> |
| </td> |
| </tr> |
| </table> |
| </div> |
| |
| </div> |
| |
| </div> |
| |
| <div id="footer"> |
| Generated on Wed Nov 11 12:57:54 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> |