| <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> |
| <html xmlns="http://www.w3.org/1999/xhtml"> |
| <head> |
| <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> |
| <title>activemq-cpp-3.4.0: cms::QueueBrowser Class Reference</title> |
| <link href="tabs.css" rel="stylesheet" type="text/css"/> |
| <link href="navtree.css" rel="stylesheet" type="text/css"/> |
| <script type="text/javascript" src="jquery.js"></script> |
| <script type="text/javascript" src="navtree.js"></script> |
| <script type="text/javascript" src="resize.js"></script> |
| <script type="text/javascript"> |
| $(document).ready(initResizable); |
| </script> |
| <link href="doxygen.css" rel="stylesheet" type="text/css"/> |
| </head> |
| <body> |
| <!-- Generated by Doxygen 1.7.3 --> |
| <div id="top"> |
| <div id="titlearea"> |
| <table cellspacing="0" cellpadding="0"> |
| <tbody> |
| <tr style="height: 56px;"> |
| <td style="padding-left: 0.5em;"> |
| <div id="projectname">activemq-cpp-3.4.0</div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| <div id="navrow1" class="tabs"> |
| <ul class="tablist"> |
| <li><a href="index.html"><span>Main Page</span></a></li> |
| <li><a href="namespaces.html"><span>Namespaces</span></a></li> |
| <li class="current"><a href="annotated.html"><span>Data Structures</span></a></li> |
| <li><a href="files.html"><span>Files</span></a></li> |
| </ul> |
| </div> |
| <div id="navrow2" class="tabs2"> |
| <ul class="tablist"> |
| <li><a href="annotated.html"><span>Data Structures</span></a></li> |
| <li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li> |
| <li><a href="functions.html"><span>Data Fields</span></a></li> |
| </ul> |
| </div> |
| </div> |
| <div id="side-nav" class="ui-resizable side-nav-resizable"> |
| <div id="nav-tree"> |
| <div id="nav-tree-contents"> |
| </div> |
| </div> |
| <div id="splitbar" style="-moz-user-select:none;" |
| class="ui-resizable-handle"> |
| </div> |
| </div> |
| <script type="text/javascript"> |
| initNavTree('classcms_1_1_queue_browser.html',''); |
| </script> |
| <div id="doc-content"> |
| <div class="header"> |
| <div class="summary"> |
| <a href="#pub-methods">Public Member Functions</a> </div> |
| <div class="headertitle"> |
| <h1>cms::QueueBrowser Class Reference</h1> </div> |
| </div> |
| <div class="contents"> |
| <!-- doxytag: class="cms::QueueBrowser" --><!-- doxytag: inherits="cms::Closeable" --> |
| <p>This class implements in interface for browsing the messages in a <a class="el" href="classcms_1_1_queue.html" title="An interface encapsulating a provider-specific queue name.">Queue</a> without removing them. |
| <a href="#_details">More...</a></p> |
| |
| <p><code>#include <<a class="el" href="_queue_browser_8h_source.html">src/main/cms/QueueBrowser.h</a>></code></p> |
| <div class="dynheader"> |
| Inheritance diagram for cms::QueueBrowser:</div> |
| <div class="dyncontent"> |
| <div class="center"><img src="classcms_1_1_queue_browser__inherit__graph.png" border="0" usemap="#cms_1_1_queue_browser_inherit__map" alt="Inheritance graph"/></div> |
| <map name="cms_1_1_queue_browser_inherit__map" id="cms_1_1_queue_browser_inherit__map"> |
| <area shape="rect" id="node5" href="classactivemq_1_1core_1_1_active_m_q_queue_browser.html" title="activemq::core::ActiveMQQueueBrowser" alt="" coords="5,160,307,189"/><area shape="rect" id="node2" href="classcms_1_1_closeable.html" title="Interface for a class that implements the close method." alt="" coords="93,5,219,35"/></map> |
| <center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div> |
| <table class="memberdecls"> |
| <tr><td colspan="2"><h2><a name="pub-methods"></a> |
| Public Member Functions</h2></td></tr> |
| <tr><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classcms_1_1_queue_browser.html#a86dac6b8583bbefde8e7ef7e711519bc">~QueueBrowser</a> () throw ()</td></tr> |
| <tr><td class="memItemLeft" align="right" valign="top">virtual const <a class="el" href="classcms_1_1_queue.html">Queue</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classcms_1_1_queue_browser.html#addc7edc65adf3506f6a6a647bc94a7dd">getQueue</a> () const =0</td></tr> |
| <tr><td class="memItemLeft" align="right" valign="top">virtual std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classcms_1_1_queue_browser.html#a143e45480df282268d8a5cd9a2bf6925">getMessageSelector</a> () const =0</td></tr> |
| <tr><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classcms_1_1_message_enumeration.html">cms::MessageEnumeration</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classcms_1_1_queue_browser.html#ace610a8ff3235b9209e45a3c6464cf50">getEnumeration</a> ()=0</td></tr> |
| <tr><td class="mdescLeft"> </td><td class="mdescRight">Gets a pointer to an Enumeration object for browsing the Messages currently in the <a class="el" href="classcms_1_1_queue.html" title="An interface encapsulating a provider-specific queue name.">Queue</a> in the order that a client would receive them. <a href="#ace610a8ff3235b9209e45a3c6464cf50"></a><br/></td></tr> |
| </table> |
| <hr/><a name="_details"></a><h2>Detailed Description</h2> |
| <div class="textblock"><p>This class implements in interface for browsing the messages in a <a class="el" href="classcms_1_1_queue.html" title="An interface encapsulating a provider-specific queue name.">Queue</a> without removing them. </p> |
| <p>To browse the contents of the <a class="el" href="classcms_1_1_queue.html" title="An interface encapsulating a provider-specific queue name.">Queue</a> the client calls the <code>getEnumeration</code> method to retrieve a new instance of a <a class="el" href="classcms_1_1_queue.html" title="An interface encapsulating a provider-specific queue name.">Queue</a> Enumerator. The client then calls the hasMoreMessages method of the Enumeration, if it returns true the client can safely call the nextMessage method of the Enumeration instance.</p> |
| <p>Enumeration* enumeration = queueBrowser-><a class="el" href="classcms_1_1_queue_browser.html#ace610a8ff3235b9209e45a3c6464cf50" title="Gets a pointer to an Enumeration object for browsing the Messages currently in the Queue in the order...">getEnumeration()</a>;</p> |
| <p>while( enumeration->hasMoreMessages() ) { <a class="el" href="classcms_1_1_message.html" title="Root of all messages.">cms::Message</a>* message = enumeration->nextMessage();</p> |
| <p>// ... Do something with the <a class="el" href="classcms_1_1_message.html" title="Root of all messages.">Message</a>.</p> |
| <p>delete message; }</p> |
| <dl class="since"><dt><b>Since:</b></dt><dd>1.1 </dd></dl> |
| </div><hr/><h2>Constructor & Destructor Documentation</h2> |
| <a class="anchor" id="a86dac6b8583bbefde8e7ef7e711519bc"></a><!-- doxytag: member="cms::QueueBrowser::~QueueBrowser" ref="a86dac6b8583bbefde8e7ef7e711519bc" args="()" --> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">virtual cms::QueueBrowser::~QueueBrowser </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td> throw ()<code> [virtual]</code></td> |
| </tr> |
| </table> |
| </div> |
| <div class="memdoc"> |
| |
| </div> |
| </div> |
| <hr/><h2>Member Function Documentation</h2> |
| <a class="anchor" id="ace610a8ff3235b9209e45a3c6464cf50"></a><!-- doxytag: member="cms::QueueBrowser::getEnumeration" ref="ace610a8ff3235b9209e45a3c6464cf50" args="()=0" --> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">virtual <a class="el" href="classcms_1_1_message_enumeration.html">cms::MessageEnumeration</a>* cms::QueueBrowser::getEnumeration </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td><code> [pure virtual]</code></td> |
| </tr> |
| </table> |
| </div> |
| <div class="memdoc"> |
| |
| <p>Gets a pointer to an Enumeration object for browsing the Messages currently in the <a class="el" href="classcms_1_1_queue.html" title="An interface encapsulating a provider-specific queue name.">Queue</a> in the order that a client would receive them. </p> |
| <p>The pointer returned is owned by the browser and should not be deleted by the client application.</p> |
| <dl class="return"><dt><b>Returns:</b></dt><dd>a pointer to a <a class="el" href="classcms_1_1_queue.html" title="An interface encapsulating a provider-specific queue name.">Queue</a> Enumeration, this Pointer is owned by the <a class="el" href="classcms_1_1_queue_browser.html" title="This class implements in interface for browsing the messages in a Queue without removing them...">QueueBrowser</a> and should not be deleted by the client.</dd></dl> |
| <dl><dt><b>Exceptions:</b></dt><dd> |
| <table class="exception"> |
| <tr><td class="paramname"><a class="el" href="classcms_1_1_c_m_s_exception.html" title="CMS API Exception that is the base for all exceptions thrown from CMS classes.">CMSException</a></td><td>if an internal error occurs. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| <p>Implemented in <a class="el" href="classactivemq_1_1core_1_1_active_m_q_queue_browser.html#ade39252a95b50256a7b0e68b2c07492f">activemq::core::ActiveMQQueueBrowser</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a143e45480df282268d8a5cd9a2bf6925"></a><!-- doxytag: member="cms::QueueBrowser::getMessageSelector" ref="a143e45480df282268d8a5cd9a2bf6925" args="() const =0" --> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">virtual std::string cms::QueueBrowser::getMessageSelector </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td> const<code> [pure virtual]</code></td> |
| </tr> |
| </table> |
| </div> |
| <div class="memdoc"> |
| <dl class="return"><dt><b>Returns:</b></dt><dd>the MessageSelector that is used on when this browser was created or empty string if no selector was present.</dd></dl> |
| <dl><dt><b>Exceptions:</b></dt><dd> |
| <table class="exception"> |
| <tr><td class="paramname"><a class="el" href="classcms_1_1_c_m_s_exception.html" title="CMS API Exception that is the base for all exceptions thrown from CMS classes.">CMSException</a></td><td>if an internal error occurs. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| <p>Implemented in <a class="el" href="classactivemq_1_1core_1_1_active_m_q_queue_browser.html#aab274cc0cf43a59b132c3bb87d4c19ad">activemq::core::ActiveMQQueueBrowser</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="addc7edc65adf3506f6a6a647bc94a7dd"></a><!-- doxytag: member="cms::QueueBrowser::getQueue" ref="addc7edc65adf3506f6a6a647bc94a7dd" args="() const =0" --> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">virtual const <a class="el" href="classcms_1_1_queue.html">Queue</a>* cms::QueueBrowser::getQueue </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td> const<code> [pure virtual]</code></td> |
| </tr> |
| </table> |
| </div> |
| <div class="memdoc"> |
| <dl class="return"><dt><b>Returns:</b></dt><dd>the <a class="el" href="classcms_1_1_queue.html" title="An interface encapsulating a provider-specific queue name.">Queue</a> that this browser is listening on.</dd></dl> |
| <dl><dt><b>Exceptions:</b></dt><dd> |
| <table class="exception"> |
| <tr><td class="paramname"><a class="el" href="classcms_1_1_c_m_s_exception.html" title="CMS API Exception that is the base for all exceptions thrown from CMS classes.">CMSException</a></td><td>if an internal error occurs. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| <p>Implemented in <a class="el" href="classactivemq_1_1core_1_1_active_m_q_queue_browser.html#a90bfcdfa770ae8c7e55b040be801f29e">activemq::core::ActiveMQQueueBrowser</a>.</p> |
| |
| </div> |
| </div> |
| <hr/>The documentation for this class was generated from the following file:<ul> |
| <li>src/main/cms/<a class="el" href="_queue_browser_8h_source.html">QueueBrowser.h</a></li> |
| </ul> |
| </div> |
| </div> |
| <div id="nav-path" class="navpath"> |
| <ul> |
| <li class="navelem"><a class="el" href="namespacecms.html">cms</a> </li> |
| <li class="navelem"><a class="el" href="classcms_1_1_queue_browser.html">QueueBrowser</a> </li> |
| <li class="footer">Generated on Mon Apr 25 2011 for activemq-cpp-3.4.0 by  |
| <a href="http://www.doxygen.org/index.html"> |
| <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.3 </li> |
| </ul> |
| </div> |
| |
| </body> |
| </html> |
