blob: 13684a68b2b9110e65920ca39e701a5d05d9bc8d [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/transport/correlator/FutureResponse.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('_future_response_8h.html','');
</script>
<div id="doc-content">
<div class="header">
<div class="headertitle">
<h1>src/main/activemq/transport/correlator/FutureResponse.h</h1> </div>
</div>
<div class="contents">
<a href="_future_response_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_TRANSPORT_CORRELATOR_FUTURERESPONSE_H_</span>
<a name="l00019"></a>00019 <span class="preprocessor"></span><span class="preprocessor">#define _ACTIVEMQ_TRANSPORT_CORRELATOR_FUTURERESPONSE_H_</span>
<a name="l00020"></a>00020 <span class="preprocessor"></span>
<a name="l00021"></a>00021 <span class="preprocessor">#include &lt;activemq/util/Config.h&gt;</span>
<a name="l00022"></a>00022 <span class="preprocessor">#include &lt;decaf/lang/Pointer.h&gt;</span>
<a name="l00023"></a>00023 <span class="preprocessor">#include &lt;decaf/util/concurrent/Mutex.h&gt;</span>
<a name="l00024"></a>00024 <span class="preprocessor">#include &lt;decaf/util/concurrent/CountDownLatch.h&gt;</span>
<a name="l00025"></a>00025 <span class="preprocessor">#include &lt;activemq/commands/Response.h&gt;</span>
<a name="l00026"></a>00026
<a name="l00027"></a>00027 <span class="preprocessor">#include &lt;activemq/exceptions/ActiveMQException.h&gt;</span>
<a name="l00028"></a>00028
<a name="l00029"></a>00029 <span class="keyword">namespace </span>activemq{
<a name="l00030"></a>00030 <span class="keyword">namespace </span>transport{
<a name="l00031"></a><a class="code" href="namespaceactivemq_1_1transport_1_1correlator.html">00031</a> <span class="keyword">namespace </span>correlator{
<a name="l00032"></a>00032
<a name="l00033"></a>00033 <span class="keyword">using</span> <a class="code" href="classdecaf_1_1lang_1_1_pointer.html" title="Decaf&amp;#39;s implementation of a Smart Pointer that is a template on a Type and is Thread Safe if the ...">decaf::lang::Pointer</a>;
<a name="l00034"></a>00034 <span class="keyword">using</span> <a class="code" href="classactivemq_1_1commands_1_1_response.html">activemq::commands::Response</a>;
<a name="l00035"></a>00035
<a name="l00041"></a><a class="code" href="classactivemq_1_1transport_1_1correlator_1_1_future_response.html">00041</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_1transport_1_1correlator_1_1_future_response.html" title="A container that holds a response object.">FutureResponse</a> {
<a name="l00042"></a>00042 <span class="keyword">private</span>:
<a name="l00043"></a>00043
<a name="l00044"></a>00044 <span class="keyword">mutable</span> <a class="code" href="classdecaf_1_1util_1_1concurrent_1_1_count_down_latch.html">decaf::util::concurrent::CountDownLatch</a> responseLatch;
<a name="l00045"></a>00045 <a class="code" href="classdecaf_1_1lang_1_1_pointer.html" title="Decaf&amp;#39;s implementation of a Smart Pointer that is a template on a Type and is Thread Safe if the ...">Pointer&lt;Response&gt;</a> response;
<a name="l00046"></a>00046
<a name="l00047"></a>00047 <span class="keyword">public</span>:
<a name="l00048"></a>00048
<a name="l00049"></a><a class="code" href="classactivemq_1_1transport_1_1correlator_1_1_future_response.html#a0877138c8fd58ab4ae68a5439e096447">00049</a> <a class="code" href="classactivemq_1_1transport_1_1correlator_1_1_future_response.html#a0877138c8fd58ab4ae68a5439e096447">FutureResponse</a>() : responseLatch( 1 ), response() {}
<a name="l00050"></a>00050
<a name="l00051"></a><a class="code" href="classactivemq_1_1transport_1_1correlator_1_1_future_response.html#a5fdcaa00cab490f4d34d83fe4e249fd0">00051</a> <span class="keyword">virtual</span> <a class="code" href="classactivemq_1_1transport_1_1correlator_1_1_future_response.html#a5fdcaa00cab490f4d34d83fe4e249fd0">~FutureResponse</a>(){}
<a name="l00052"></a>00052
<a name="l00057"></a><a class="code" href="classactivemq_1_1transport_1_1correlator_1_1_future_response.html#a09e1215c94d7caa1eab5a574ae8cee34">00057</a> <span class="keyword">virtual</span> <span class="keyword">const</span> <a class="code" href="classdecaf_1_1lang_1_1_pointer.html" title="Decaf&amp;#39;s implementation of a Smart Pointer that is a template on a Type and is Thread Safe if the ...">Pointer&lt;Response&gt;</a>&amp; <a class="code" href="classactivemq_1_1transport_1_1correlator_1_1_future_response.html#a09e1215c94d7caa1eab5a574ae8cee34" title="Getters for the response property.">getResponse</a>()<span class="keyword"> const </span>{
<a name="l00058"></a>00058 this-&gt;responseLatch.await();
<a name="l00059"></a>00059 <span class="keywordflow">return</span> response;
<a name="l00060"></a>00060 }
<a name="l00061"></a><a class="code" href="classactivemq_1_1transport_1_1correlator_1_1_future_response.html#a277ceeefd2f823f035c498fe3246f42d">00061</a> <span class="keyword">virtual</span> <a class="code" href="classdecaf_1_1lang_1_1_pointer.html" title="Decaf&amp;#39;s implementation of a Smart Pointer that is a template on a Type and is Thread Safe if the ...">Pointer&lt;Response&gt;</a>&amp; <a class="code" href="classactivemq_1_1transport_1_1correlator_1_1_future_response.html#a277ceeefd2f823f035c498fe3246f42d">getResponse</a>() {
<a name="l00062"></a>00062 this-&gt;responseLatch.await();
<a name="l00063"></a>00063 <span class="keywordflow">return</span> response;
<a name="l00064"></a>00064 }
<a name="l00065"></a>00065
<a name="l00071"></a><a class="code" href="classactivemq_1_1transport_1_1correlator_1_1_future_response.html#a4d59814a4e2644c739f36b60e7acb578">00071</a> <span class="keyword">virtual</span> <span class="keyword">const</span> <a class="code" href="classdecaf_1_1lang_1_1_pointer.html" title="Decaf&amp;#39;s implementation of a Smart Pointer that is a template on a Type and is Thread Safe if the ...">Pointer&lt;Response&gt;</a>&amp; <a class="code" href="classactivemq_1_1transport_1_1correlator_1_1_future_response.html#a4d59814a4e2644c739f36b60e7acb578" title="Getters for the response property.">getResponse</a>( <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> timeout )<span class="keyword"> const </span>{
<a name="l00072"></a>00072 this-&gt;responseLatch.await( timeout );
<a name="l00073"></a>00073 <span class="keywordflow">return</span> response;
<a name="l00074"></a>00074 }
<a name="l00075"></a><a class="code" href="classactivemq_1_1transport_1_1correlator_1_1_future_response.html#a62f7b8bc0516f27f774d34afd95a4dcc">00075</a> <span class="keyword">virtual</span> <a class="code" href="classdecaf_1_1lang_1_1_pointer.html" title="Decaf&amp;#39;s implementation of a Smart Pointer that is a template on a Type and is Thread Safe if the ...">Pointer&lt;Response&gt;</a>&amp; <a class="code" href="classactivemq_1_1transport_1_1correlator_1_1_future_response.html#a62f7b8bc0516f27f774d34afd95a4dcc">getResponse</a>( <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> timeout ) {
<a name="l00076"></a>00076 this-&gt;responseLatch.await( timeout );
<a name="l00077"></a>00077 <span class="keywordflow">return</span> response;
<a name="l00078"></a>00078 }
<a name="l00079"></a>00079
<a name="l00084"></a><a class="code" href="classactivemq_1_1transport_1_1correlator_1_1_future_response.html#a878a627e29609faae6d9f12144b91422">00084</a> <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classactivemq_1_1transport_1_1correlator_1_1_future_response.html#a878a627e29609faae6d9f12144b91422" title="Setter for the response property.">setResponse</a>( <span class="keyword">const</span> <a class="code" href="classdecaf_1_1lang_1_1_pointer.html" title="Decaf&amp;#39;s implementation of a Smart Pointer that is a template on a Type and is Thread Safe if the ...">Pointer&lt;Response&gt;</a>&amp; response ) {
<a name="l00085"></a>00085 this-&gt;response = response;
<a name="l00086"></a>00086 this-&gt;responseLatch.countDown();
<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 }}}
<a name="l00092"></a>00092
<a name="l00093"></a>00093 <span class="preprocessor">#endif </span><span class="comment">/*_ACTIVEMQ_TRANSPORT_CORRELATOR_FUTURERESPONSE_H_*/</span>
</pre></div></div>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="_future_response_8h.html">FutureResponse.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>