| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <title>QueueReceiver</title> |
| <link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style"> |
| <script type="text/javascript" src="../../script.js"></script> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="QueueReceiver"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":6}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]}; |
| var altColor = "altColor"; |
| var rowColor = "rowColor"; |
| var tableTab = "tableTab"; |
| var activeTableTab = "activeTableTab"; |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a name="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.top.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../index-all.html">Index</a></li> |
| <li><a href="../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../jakarta/jms/QueueConnectionFactory.html" title="interface in jakarta.jms"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../jakarta/jms/QueueRequestor.html" title="class in jakarta.jms"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../index.html?jakarta/jms/QueueReceiver.html" target="_top">Frames</a></li> |
| <li><a href="QueueReceiver.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_top"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="subTitle">jakarta.jms</div> |
| <h2 title="Interface QueueReceiver" class="title">Interface QueueReceiver</h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Superinterfaces:</dt> |
| <dd>java.lang.AutoCloseable, <a href="../../jakarta/jms/MessageConsumer.html" title="interface in jakarta.jms">MessageConsumer</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public interface <span class="typeNameLabel">QueueReceiver</span> |
| extends <a href="../../jakarta/jms/MessageConsumer.html" title="interface in jakarta.jms">MessageConsumer</a></pre> |
| <div class="block">A client uses a <code>QueueReceiver</code> object to receive messages that have been delivered to a queue. |
| |
| <p> |
| Although it is possible to have multiple <code>QueueReceiver</code>s for the same queue, the Jakarta Messaging API does not define how |
| messages are distributed between the <code>QueueReceiver</code>s. |
| |
| <p> |
| If a <code>QueueReceiver</code> specifies a message selector, the messages that are not selected remain on the queue. By |
| definition, a message selector allows a <code>QueueReceiver</code> to skip messages. This means that when the skipped |
| messages are eventually read, the total ordering of the reads does not retain the partial order defined by each |
| message producer. Only <code>QueueReceiver</code>s without a message selector will read messages in message producer |
| order. |
| |
| <p> |
| Creating a <code>MessageConsumer</code> provides the same features as creating a <code>QueueReceiver</code>. A |
| <code>MessageConsumer</code> object is recommended for creating new code. The <code>QueueReceiver</code> is provided to support |
| existing code.</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>JMS 1.0</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../jakarta/jms/Session.html#createConsumer-jakarta.jms.Destination-java.lang.String-"><code>Session.createConsumer(Destination, String)</code></a>, |
| <a href="../../jakarta/jms/Session.html#createConsumer-jakarta.jms.Destination-"><code>Session.createConsumer(Destination)</code></a>, |
| <a href="../../jakarta/jms/QueueSession.html#createReceiver-jakarta.jms.Queue-java.lang.String-"><code>QueueSession.createReceiver(Queue, String)</code></a>, |
| <a href="../../jakarta/jms/QueueSession.html#createReceiver-jakarta.jms.Queue-"><code>QueueSession.createReceiver(Queue)</code></a>, |
| <a href="../../jakarta/jms/MessageConsumer.html" title="interface in jakarta.jms"><code>MessageConsumer</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> |
| <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </span></span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Method and Description</th> |
| </tr> |
| <tr id="i0" class="altColor"> |
| <td class="colFirst"><code><a href="../../jakarta/jms/Queue.html" title="interface in jakarta.jms">Queue</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../jakarta/jms/QueueReceiver.html#getQueue--">getQueue</a></span>()</code> |
| <div class="block">Gets the <code>Queue</code> associated with this queue receiver.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.jakarta.jms.MessageConsumer"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from interface jakarta.jms.<a href="../../jakarta/jms/MessageConsumer.html" title="interface in jakarta.jms">MessageConsumer</a></h3> |
| <code><a href="../../jakarta/jms/MessageConsumer.html#close--">close</a>, <a href="../../jakarta/jms/MessageConsumer.html#getMessageListener--">getMessageListener</a>, <a href="../../jakarta/jms/MessageConsumer.html#getMessageSelector--">getMessageSelector</a>, <a href="../../jakarta/jms/MessageConsumer.html#receive--">receive</a>, <a href="../../jakarta/jms/MessageConsumer.html#receive-long-">receive</a>, <a href="../../jakarta/jms/MessageConsumer.html#receiveNoWait--">receiveNoWait</a>, <a href="../../jakarta/jms/MessageConsumer.html#setMessageListener-jakarta.jms.MessageListener-">setMessageListener</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="getQueue--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>getQueue</h4> |
| <pre><a href="../../jakarta/jms/Queue.html" title="interface in jakarta.jms">Queue</a> getQueue() |
| throws <a href="../../jakarta/jms/JMSException.html" title="class in jakarta.jms">JMSException</a></pre> |
| <div class="block">Gets the <code>Queue</code> associated with this queue receiver.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this receiver's <code>Queue</code></dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../jakarta/jms/JMSException.html" title="class in jakarta.jms">JMSException</a></code> - if the Jakarta Messaging provider fails to get the queue for this queue receiver due to some internal |
| error.</dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a name="navbar.bottom"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.bottom.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../index-all.html">Index</a></li> |
| <li><a href="../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../jakarta/jms/QueueConnectionFactory.html" title="interface in jakarta.jms"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../jakarta/jms/QueueRequestor.html" title="class in jakarta.jms"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../index.html?jakarta/jms/QueueReceiver.html" target="_top">Frames</a></li> |
| <li><a href="QueueReceiver.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_bottom"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </body> |
| </html> |
