Permalink
Browse files

Updated doc

  • Loading branch information...
1 parent d16411a commit ae15af1bff72a96dc691da48a22df1f4b3d5125a @morellon committed Jun 10, 2010
@@ -242,7 +242,7 @@ <h2 class='section-bar'>Attributes</h2>
<a class='source-toggle' href='#' onclick="toggleCode('M000028-source'); return false">
[show source]
</a>
- <pre id='M000028-source'> <span class="ruby-comment cmt"># File lib/stomp/client.rb, line 223</span>&#x000A;223: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">close</span> <span class="ruby-identifier">headers</span>={}&#x000A;224: <span class="ruby-ivar">@listener_thread</span>.<span class="ruby-identifier">exit</span>&#x000A;225: <span class="ruby-ivar">@connection</span>.<span class="ruby-identifier">disconnect</span> <span class="ruby-identifier">headers</span>&#x000A;226: <span class="ruby-keyword kw">end</span></pre>
+ <pre id='M000028-source'> <span class="ruby-comment cmt"># File lib/stomp/client.rb, line 222</span>&#x000A;222: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">close</span> <span class="ruby-identifier">headers</span>={}&#x000A;223: <span class="ruby-ivar">@listener_thread</span>.<span class="ruby-identifier">exit</span>&#x000A;224: <span class="ruby-ivar">@connection</span>.<span class="ruby-identifier">disconnect</span> <span class="ruby-identifier">headers</span>&#x000A;225: <span class="ruby-keyword kw">end</span></pre>
</div>
</div>
<div class='method public-instance' id='method-M000027'>
@@ -260,7 +260,7 @@ <h2 class='section-bar'>Attributes</h2>
<a class='source-toggle' href='#' onclick="toggleCode('M000027-source'); return false">
[show source]
</a>
- <pre id='M000027-source'> <span class="ruby-comment cmt"># File lib/stomp/client.rb, line 218</span>&#x000A;218: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">closed?</span>&#x000A;219: <span class="ruby-ivar">@connection</span>.<span class="ruby-identifier">closed?</span>&#x000A;220: <span class="ruby-keyword kw">end</span></pre>
+ <pre id='M000027-source'> <span class="ruby-comment cmt"># File lib/stomp/client.rb, line 217</span>&#x000A;217: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">closed?</span>&#x000A;218: <span class="ruby-ivar">@connection</span>.<span class="ruby-identifier">closed?</span>&#x000A;219: <span class="ruby-keyword kw">end</span></pre>
</div>
</div>
<div class='method public-instance' id='method-M000016'>
@@ -291,7 +291,7 @@ <h2 class='section-bar'>Attributes</h2>
<a class='source-toggle' href='#' onclick="toggleCode('M000024-source'); return false">
[show source]
</a>
- <pre id='M000024-source'> <span class="ruby-comment cmt"># File lib/stomp/client.rb, line 204</span>&#x000A;204: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">connection_frame</span>&#x000A;205: <span class="ruby-ivar">@connection</span>.<span class="ruby-identifier">connection_frame</span>&#x000A;206: <span class="ruby-keyword kw">end</span></pre>
+ <pre id='M000024-source'> <span class="ruby-comment cmt"># File lib/stomp/client.rb, line 203</span>&#x000A;203: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">connection_frame</span>&#x000A;204: <span class="ruby-ivar">@connection</span>.<span class="ruby-identifier">connection_frame</span>&#x000A;205: <span class="ruby-keyword kw">end</span></pre>
</div>
</div>
<div class='method public-instance' id='method-M000025'>
@@ -304,7 +304,7 @@ <h2 class='section-bar'>Attributes</h2>
<a class='source-toggle' href='#' onclick="toggleCode('M000025-source'); return false">
[show source]
</a>
- <pre id='M000025-source'> <span class="ruby-comment cmt"># File lib/stomp/client.rb, line 208</span>&#x000A;208: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">disconnect_receipt</span>&#x000A;209: <span class="ruby-ivar">@connection</span>.<span class="ruby-identifier">disconnect_receipt</span>&#x000A;210: <span class="ruby-keyword kw">end</span></pre>
+ <pre id='M000025-source'> <span class="ruby-comment cmt"># File lib/stomp/client.rb, line 207</span>&#x000A;207: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">disconnect_receipt</span>&#x000A;208: <span class="ruby-ivar">@connection</span>.<span class="ruby-identifier">disconnect_receipt</span>&#x000A;209: <span class="ruby-keyword kw">end</span></pre>
</div>
</div>
<div class='method public-instance' id='method-M000013'>
@@ -336,7 +336,7 @@ <h2 class='section-bar'>Attributes</h2>
<a class='source-toggle' href='#' onclick="toggleCode('M000022-source'); return false">
[show source]
</a>
- <pre id='M000022-source'> <span class="ruby-comment cmt"># File lib/stomp/client.rb, line 195</span>&#x000A;195: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">obj_send</span>(<span class="ruby-operator">*</span><span class="ruby-identifier">args</span>)&#x000A;196: <span class="ruby-identifier">__send__</span>(<span class="ruby-operator">*</span><span class="ruby-identifier">args</span>)&#x000A;197: <span class="ruby-keyword kw">end</span></pre>
+ <pre id='M000022-source'> <span class="ruby-comment cmt"># File lib/stomp/client.rb, line 194</span>&#x000A;194: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">obj_send</span>(<span class="ruby-operator">*</span><span class="ruby-identifier">args</span>)&#x000A;195: <span class="ruby-identifier">__send__</span>(<span class="ruby-operator">*</span><span class="ruby-identifier">args</span>)&#x000A;196: <span class="ruby-keyword kw">end</span></pre>
</div>
</div>
<div class='method public-instance' id='method-M000026'>
@@ -354,7 +354,7 @@ <h2 class='section-bar'>Attributes</h2>
<a class='source-toggle' href='#' onclick="toggleCode('M000026-source'); return false">
[show source]
</a>
- <pre id='M000026-source'> <span class="ruby-comment cmt"># File lib/stomp/client.rb, line 213</span>&#x000A;213: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">open?</span>&#x000A;214: <span class="ruby-ivar">@connection</span>.<span class="ruby-identifier">open?</span>&#x000A;215: <span class="ruby-keyword kw">end</span></pre>
+ <pre id='M000026-source'> <span class="ruby-comment cmt"># File lib/stomp/client.rb, line 212</span>&#x000A;212: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">open?</span>&#x000A;213: <span class="ruby-ivar">@connection</span>.<span class="ruby-identifier">open?</span>&#x000A;214: <span class="ruby-keyword kw">end</span></pre>
</div>
</div>
<div class='method public-instance' id='method-M000021'>
@@ -380,7 +380,7 @@ <h2 class='section-bar'>Attributes</h2>
<a class='source-toggle' href='#' onclick="toggleCode('M000021-source'); return false">
[show source]
</a>
- <pre id='M000021-source'> <span class="ruby-comment cmt"># File lib/stomp/client.rb, line 188</span>&#x000A;188: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">publish</span>(<span class="ruby-identifier">destination</span>, <span class="ruby-identifier">message</span>, <span class="ruby-identifier">headers</span> = {})&#x000A;189: <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">block_given?</span>&#x000A;190: <span class="ruby-identifier">headers</span>[<span class="ruby-value str">'receipt'</span>] = <span class="ruby-identifier">register_receipt_listener</span> <span class="ruby-identifier">lambda</span> {<span class="ruby-operator">|</span><span class="ruby-identifier">r</span><span class="ruby-operator">|</span> <span class="ruby-keyword kw">yield</span> <span class="ruby-identifier">r</span>}&#x000A;191: <span class="ruby-keyword kw">end</span>&#x000A;192: <span class="ruby-ivar">@connection</span>.<span class="ruby-identifier">publish</span>(<span class="ruby-identifier">destination</span>, <span class="ruby-identifier">message</span>, <span class="ruby-identifier">headers</span>)&#x000A;193: <span class="ruby-keyword kw">end</span></pre>
+ <pre id='M000021-source'> <span class="ruby-comment cmt"># File lib/stomp/client.rb, line 187</span>&#x000A;187: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">publish</span>(<span class="ruby-identifier">destination</span>, <span class="ruby-identifier">message</span>, <span class="ruby-identifier">headers</span> = {})&#x000A;188: <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">block_given?</span>&#x000A;189: <span class="ruby-identifier">headers</span>[<span class="ruby-value str">'receipt'</span>] = <span class="ruby-identifier">register_receipt_listener</span> <span class="ruby-identifier">lambda</span> {<span class="ruby-operator">|</span><span class="ruby-identifier">r</span><span class="ruby-operator">|</span> <span class="ruby-keyword kw">yield</span> <span class="ruby-identifier">r</span>}&#x000A;190: <span class="ruby-keyword kw">end</span>&#x000A;191: <span class="ruby-ivar">@connection</span>.<span class="ruby-identifier">publish</span>(<span class="ruby-identifier">destination</span>, <span class="ruby-identifier">message</span>, <span class="ruby-identifier">headers</span>)&#x000A;192: <span class="ruby-keyword kw">end</span></pre>
</div>
</div>
<div class='method public-instance' id='method-M000029'>
@@ -398,7 +398,7 @@ <h2 class='section-bar'>Attributes</h2>
<a class='source-toggle' href='#' onclick="toggleCode('M000029-source'); return false">
[show source]
</a>
- <pre id='M000029-source'> <span class="ruby-comment cmt"># File lib/stomp/client.rb, line 229</span>&#x000A;229: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">running</span>&#x000A;230: <span class="ruby-ivar">@listener_thread</span> <span class="ruby-operator">&amp;&amp;</span> <span class="ruby-operator">!</span><span class="ruby-operator">!</span><span class="ruby-ivar">@listener_thread</span>.<span class="ruby-identifier">status</span>&#x000A;231: <span class="ruby-keyword kw">end</span></pre>
+ <pre id='M000029-source'> <span class="ruby-comment cmt"># File lib/stomp/client.rb, line 228</span>&#x000A;228: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">running</span>&#x000A;229: <span class="ruby-ivar">@listener_thread</span> <span class="ruby-operator">&amp;&amp;</span> <span class="ruby-operator">!</span><span class="ruby-operator">!</span><span class="ruby-ivar">@listener_thread</span>.<span class="ruby-identifier">status</span>&#x000A;230: <span class="ruby-keyword kw">end</span></pre>
</div>
</div>
<div class='method public-instance' id='method-M000023'>
@@ -411,7 +411,7 @@ <h2 class='section-bar'>Attributes</h2>
<a class='source-toggle' href='#' onclick="toggleCode('M000023-source'); return false">
[show source]
</a>
- <pre id='M000023-source'> <span class="ruby-comment cmt"># File lib/stomp/client.rb, line 199</span>&#x000A;199: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">send</span>(<span class="ruby-operator">*</span><span class="ruby-identifier">args</span>)&#x000A;200: <span class="ruby-identifier">warn</span>(<span class="ruby-value str">&quot;This method is deprecated and will be removed on the next release. Use 'publish' instead&quot;</span>)&#x000A;201: <span class="ruby-identifier">publish</span>(<span class="ruby-operator">*</span><span class="ruby-identifier">args</span>)&#x000A;202: <span class="ruby-keyword kw">end</span></pre>
+ <pre id='M000023-source'> <span class="ruby-comment cmt"># File lib/stomp/client.rb, line 198</span>&#x000A;198: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">send</span>(<span class="ruby-operator">*</span><span class="ruby-identifier">args</span>)&#x000A;199: <span class="ruby-identifier">warn</span>(<span class="ruby-value str">&quot;This method is deprecated and will be removed on the next release. Use 'publish' instead&quot;</span>)&#x000A;200: <span class="ruby-identifier">publish</span>(<span class="ruby-operator">*</span><span class="ruby-identifier">args</span>)&#x000A;201: <span class="ruby-keyword kw">end</span></pre>
</div>
</div>
<div class='method public-instance' id='method-M000017'>
@@ -441,20 +441,18 @@ <h2 class='section-bar'>Attributes</h2>
<a name='M000020'></a>
<div class='synopsis'>
<span class='name'>unreceive</span>
- <span class='arguments'>(message)</span>
+ <span class='arguments'>(message, options = {})</span>
</div>
<div class='description'>
<p>
- Unreceive a message, sending it back to its queue or to the DLQ client
- acknowledgement ( connection.subscribe &#8220;/queue/a&#8220;, :ack =>
- &#8216;client&#8217;g
+ Unreceive a message, sending it back to its queue or to the DLQ
</p>
</div>
<div class='source'>
<a class='source-toggle' href='#' onclick="toggleCode('M000020-source'); return false">
[show source]
</a>
- <pre id='M000020-source'> <span class="ruby-comment cmt"># File lib/stomp/client.rb, line 178</span>&#x000A;178: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">unreceive</span>(<span class="ruby-identifier">message</span>)&#x000A;179: <span class="ruby-ivar">@connection</span>.<span class="ruby-identifier">unreceive</span> <span class="ruby-identifier">message</span>&#x000A;180: <span class="ruby-keyword kw">end</span></pre>
+ <pre id='M000020-source'> <span class="ruby-comment cmt"># File lib/stomp/client.rb, line 177</span>&#x000A;177: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">unreceive</span>(<span class="ruby-identifier">message</span>, <span class="ruby-identifier">options</span> = {})&#x000A;178: <span class="ruby-ivar">@connection</span>.<span class="ruby-identifier">unreceive</span>(<span class="ruby-identifier">message</span>, <span class="ruby-identifier">options</span>)&#x000A;179: <span class="ruby-keyword kw">end</span></pre>
</div>
</div>
<div class='method public-instance' id='method-M000018'>
Oops, something went wrong.

0 comments on commit ae15af1

Please sign in to comment.