blob: 900428e4904f0a0d03256d5006c6e4576cb9359c [file] [log] [blame]
<!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: src/main/activemq/cmsutil/CachedConsumer.h Source File</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&#160;Page</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="files.html"><span>File&#160;List</span></a></li>
<li><a href="globals.html"><span>Globals</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('_cached_consumer_8h.html','');
</script>
<div id="doc-content">
<div class="header">
<div class="headertitle">
<h1>src/main/activemq/cmsutil/CachedConsumer.h</h1> </div>
</div>
<div class="contents">
<a href="_cached_consumer_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/*</span>
<a name="l00002"></a>00002 <span class="comment"> * Licensed to the Apache Software Foundation (ASF) under one or more</span>
<a name="l00003"></a>00003 <span class="comment"> * contributor license agreements. See the NOTICE file distributed with</span>
<a name="l00004"></a>00004 <span class="comment"> * this work for additional information regarding copyright ownership.</span>
<a name="l00005"></a>00005 <span class="comment"> * The ASF licenses this file to You under the Apache License, Version 2.0</span>
<a name="l00006"></a>00006 <span class="comment"> * (the &quot;License&quot;); you may not use this file except in compliance with</span>
<a name="l00007"></a>00007 <span class="comment"> * the License. You may obtain a copy of the License at</span>
<a name="l00008"></a>00008 <span class="comment"> *</span>
<a name="l00009"></a>00009 <span class="comment"> * http://www.apache.org/licenses/LICENSE-2.0</span>
<a name="l00010"></a>00010 <span class="comment"> *</span>
<a name="l00011"></a>00011 <span class="comment"> * Unless required by applicable law or agreed to in writing, software</span>
<a name="l00012"></a>00012 <span class="comment"> * distributed under the License is distributed on an &quot;AS IS&quot; BASIS,</span>
<a name="l00013"></a>00013 <span class="comment"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</span>
<a name="l00014"></a>00014 <span class="comment"> * See the License for the specific language governing permissions and</span>
<a name="l00015"></a>00015 <span class="comment"> * limitations under the License.</span>
<a name="l00016"></a>00016 <span class="comment"> */</span>
<a name="l00017"></a>00017
<a name="l00018"></a>00018 <span class="preprocessor">#ifndef ACTIVEMQ_CMSUTIL_CACHEDCONSUMER_H_</span>
<a name="l00019"></a>00019 <span class="preprocessor"></span><span class="preprocessor">#define ACTIVEMQ_CMSUTIL_CACHEDCONSUMER_H_</span>
<a name="l00020"></a>00020 <span class="preprocessor"></span>
<a name="l00021"></a>00021 <span class="preprocessor">#include &lt;cms/MessageConsumer.h&gt;</span>
<a name="l00022"></a>00022 <span class="preprocessor">#include &lt;activemq/util/Config.h&gt;</span>
<a name="l00023"></a>00023
<a name="l00024"></a><a class="code" href="namespaceactivemq.html">00024</a> <span class="keyword">namespace </span>activemq {
<a name="l00025"></a><a class="code" href="namespaceactivemq_1_1cmsutil.html">00025</a> <span class="keyword">namespace </span>cmsutil {
<a name="l00026"></a>00026
<a name="l00030"></a><a class="code" href="classactivemq_1_1cmsutil_1_1_cached_consumer.html">00030</a> <span class="keyword">class </span><a class="code" href="activemq_2util_2_config_8h.html#acbd131a10f5c91fc363bbb90be74faff">AMQCPP_API</a> <a class="code" href="classactivemq_1_1cmsutil_1_1_cached_consumer.html" title="A cached message consumer contained within a pooled session.">CachedConsumer</a> : <span class="keyword">public</span> cms::MessageConsumer {
<a name="l00031"></a>00031 <span class="keyword">private</span>:
<a name="l00032"></a>00032
<a name="l00033"></a>00033 <a class="code" href="classcms_1_1_message_consumer.html" title="A client uses a MessageConsumer to received messages from a destination.">cms::MessageConsumer</a>* consumer;
<a name="l00034"></a>00034
<a name="l00035"></a>00035 <span class="keyword">private</span>:
<a name="l00036"></a>00036
<a name="l00037"></a>00037 <a class="code" href="classactivemq_1_1cmsutil_1_1_cached_consumer.html" title="A cached message consumer contained within a pooled session.">CachedConsumer</a>( <span class="keyword">const</span> <a class="code" href="classactivemq_1_1cmsutil_1_1_cached_consumer.html" title="A cached message consumer contained within a pooled session.">CachedConsumer</a>&amp; );
<a name="l00038"></a>00038 <a class="code" href="classactivemq_1_1cmsutil_1_1_cached_consumer.html" title="A cached message consumer contained within a pooled session.">CachedConsumer</a>&amp; operator= ( <span class="keyword">const</span> <a class="code" href="classactivemq_1_1cmsutil_1_1_cached_consumer.html" title="A cached message consumer contained within a pooled session.">CachedConsumer</a>&amp; );
<a name="l00039"></a>00039
<a name="l00040"></a>00040 <span class="keyword">public</span>:
<a name="l00041"></a>00041
<a name="l00042"></a><a class="code" href="classactivemq_1_1cmsutil_1_1_cached_consumer.html#a13188fadae44c2168123afd7db80c617">00042</a> <a class="code" href="classactivemq_1_1cmsutil_1_1_cached_consumer.html#a13188fadae44c2168123afd7db80c617">CachedConsumer</a>( <a class="code" href="classcms_1_1_message_consumer.html" title="A client uses a MessageConsumer to received messages from a destination.">cms::MessageConsumer</a>* consumer ) : consumer( consumer ) {
<a name="l00043"></a>00043 }
<a name="l00044"></a>00044
<a name="l00045"></a><a class="code" href="classactivemq_1_1cmsutil_1_1_cached_consumer.html#a3b1e93b3d321c63a0d83f11b161d676f">00045</a> <span class="keyword">virtual</span> <a class="code" href="classactivemq_1_1cmsutil_1_1_cached_consumer.html#a3b1e93b3d321c63a0d83f11b161d676f">~CachedConsumer</a>() throw() {}
<a name="l00046"></a>00046
<a name="l00051"></a><a class="code" href="classactivemq_1_1cmsutil_1_1_cached_consumer.html#aafa76f95c9cb69afd5940bfcdae06614">00051</a> <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classactivemq_1_1cmsutil_1_1_cached_consumer.html#aafa76f95c9cb69afd5940bfcdae06614" title="Does nothing - the real producer resource will be closed by the lifecycle manager.">close</a>() {
<a name="l00052"></a>00052 <span class="comment">// Do nothing.</span>
<a name="l00053"></a>00053 }
<a name="l00054"></a>00054
<a name="l00055"></a><a class="code" href="classactivemq_1_1cmsutil_1_1_cached_consumer.html#a0e2cdbb649b72b51cc2ae0085d3e3653">00055</a> <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classactivemq_1_1cmsutil_1_1_cached_consumer.html#a0e2cdbb649b72b51cc2ae0085d3e3653" title="Starts the service.">start</a>() {
<a name="l00056"></a>00056 consumer-&gt;start();
<a name="l00057"></a>00057 }
<a name="l00058"></a>00058
<a name="l00059"></a><a class="code" href="classactivemq_1_1cmsutil_1_1_cached_consumer.html#a17a798de9ae954c200e4b85e4436cf95">00059</a> <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classactivemq_1_1cmsutil_1_1_cached_consumer.html#a17a798de9ae954c200e4b85e4436cf95" title="Stops this service.">stop</a>() {
<a name="l00060"></a>00060 consumer-&gt;stop();
<a name="l00061"></a>00061 }
<a name="l00062"></a>00062
<a name="l00063"></a><a class="code" href="classactivemq_1_1cmsutil_1_1_cached_consumer.html#a73d1cde16247621675020b5f01d30a39">00063</a> <span class="keyword">virtual</span> <a class="code" href="classcms_1_1_message.html" title="Root of all messages.">cms::Message</a>* <a class="code" href="classactivemq_1_1cmsutil_1_1_cached_consumer.html#a73d1cde16247621675020b5f01d30a39" title="Synchronously Receive a Message.">receive</a>() {
<a name="l00064"></a>00064 <span class="keywordflow">return</span> consumer-&gt;receive();
<a name="l00065"></a>00065 }
<a name="l00066"></a>00066
<a name="l00067"></a><a class="code" href="classactivemq_1_1cmsutil_1_1_cached_consumer.html#a1e10717f6f2a0fef6e12b792b903f7df">00067</a> <span class="keyword">virtual</span> <a class="code" href="classcms_1_1_message.html" title="Root of all messages.">cms::Message</a>* <a class="code" href="classactivemq_1_1cmsutil_1_1_cached_consumer.html#a1e10717f6f2a0fef6e12b792b903f7df" title="Synchronously Receive a Message, time out after defined interval.">receive</a>( <span class="keywordtype">int</span> millisecs ) {
<a name="l00068"></a>00068 <span class="keywordflow">return</span> consumer-&gt;receive(millisecs);
<a name="l00069"></a>00069 }
<a name="l00070"></a>00070
<a name="l00071"></a><a class="code" href="classactivemq_1_1cmsutil_1_1_cached_consumer.html#a0d4d8c2df9bbcaf9e776baf4ab7f8f38">00071</a> <span class="keyword">virtual</span> <a class="code" href="classcms_1_1_message.html" title="Root of all messages.">cms::Message</a>* <a class="code" href="classactivemq_1_1cmsutil_1_1_cached_consumer.html#a0d4d8c2df9bbcaf9e776baf4ab7f8f38" title="Receive a Message, does not wait if there isn&amp;#39;t a new message to read, returns NULL if nothing re...">receiveNoWait</a>() {
<a name="l00072"></a>00072 <span class="keywordflow">return</span> consumer-&gt;receiveNoWait();
<a name="l00073"></a>00073 }
<a name="l00074"></a>00074
<a name="l00075"></a><a class="code" href="classactivemq_1_1cmsutil_1_1_cached_consumer.html#a359cd7b114369aff5a7d50002defbf57">00075</a> <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classactivemq_1_1cmsutil_1_1_cached_consumer.html#a359cd7b114369aff5a7d50002defbf57" title="Sets the MessageListener that this class will send notifs on.">setMessageListener</a>( <a class="code" href="classcms_1_1_message_listener.html" title="A MessageListener object is used to receive asynchronously delivered messages.">cms::MessageListener</a>* listener ) {
<a name="l00076"></a>00076 consumer-&gt;setMessageListener( listener );
<a name="l00077"></a>00077 }
<a name="l00078"></a>00078
<a name="l00079"></a><a class="code" href="classactivemq_1_1cmsutil_1_1_cached_consumer.html#ae75ec0edef1c8202c00d328705f9748c">00079</a> <span class="keyword">virtual</span> <a class="code" href="classcms_1_1_message_listener.html" title="A MessageListener object is used to receive asynchronously delivered messages.">cms::MessageListener</a>* <a class="code" href="classactivemq_1_1cmsutil_1_1_cached_consumer.html#ae75ec0edef1c8202c00d328705f9748c" title="Gets the MessageListener that this class will send mew Message notification events to...">getMessageListener</a>()<span class="keyword"> const </span>{
<a name="l00080"></a>00080 <span class="keywordflow">return</span> consumer-&gt;getMessageListener();
<a name="l00081"></a>00081 }
<a name="l00082"></a>00082
<a name="l00083"></a><a class="code" href="classactivemq_1_1cmsutil_1_1_cached_consumer.html#a23bbcd1a109aedb5aa9e4c38adf75e1d">00083</a> <span class="keyword">virtual</span> std::string <a class="code" href="classactivemq_1_1cmsutil_1_1_cached_consumer.html#a23bbcd1a109aedb5aa9e4c38adf75e1d" title="Gets this message consumer&amp;#39;s message selector expression.">getMessageSelector</a>()<span class="keyword"> const </span>{
<a name="l00084"></a>00084 <span class="keywordflow">return</span> consumer-&gt;getMessageSelector();
<a name="l00085"></a>00085 }
<a name="l00086"></a>00086
<a name="l00087"></a>00087 };
<a name="l00088"></a>00088
<a name="l00089"></a>00089 }}
<a name="l00090"></a>00090
<a name="l00091"></a>00091 <span class="preprocessor">#endif </span><span class="comment">/*ACTIVEMQ_CMSUTIL_CACHEDCONSUMER_H_*/</span>
</pre></div></div>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="_cached_consumer_8h.html">CachedConsumer.h</a> </li>
<li class="footer">Generated on Mon Apr 25 2011 for activemq-cpp-3.4.0 by&#160;
<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>