blob: 39cd19c71c7a574874fffd39e160071faeeb57e0 [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/commands/ActiveMQMapMessage.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('_active_m_q_map_message_8h.html','');
</script>
<div id="doc-content">
<div class="header">
<div class="headertitle">
<h1>src/main/activemq/commands/ActiveMQMapMessage.h</h1> </div>
</div>
<div class="contents">
<a href="_active_m_q_map_message_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_COMMANDS_ACTIVEMQMAPMESSAGE_H_</span>
<a name="l00019"></a>00019 <span class="preprocessor"></span><span class="preprocessor">#define _ACTIVEMQ_COMMANDS_ACTIVEMQMAPMESSAGE_H_</span>
<a name="l00020"></a>00020 <span class="preprocessor"></span>
<a name="l00021"></a>00021 <span class="comment">// Turn off warning message for ignored exception specification</span>
<a name="l00022"></a>00022 <span class="preprocessor">#ifdef _MSC_VER</span>
<a name="l00023"></a>00023 <span class="preprocessor"></span><span class="preprocessor">#pragma warning( disable : 4290 )</span>
<a name="l00024"></a>00024 <span class="preprocessor"></span><span class="preprocessor">#endif</span>
<a name="l00025"></a>00025 <span class="preprocessor"></span>
<a name="l00026"></a>00026 <span class="preprocessor">#include &lt;activemq/util/Config.h&gt;</span>
<a name="l00027"></a>00027 <span class="preprocessor">#include &lt;activemq/commands/ActiveMQMessageTemplate.h&gt;</span>
<a name="l00028"></a>00028 <span class="preprocessor">#include &lt;activemq/util/PrimitiveMap.h&gt;</span>
<a name="l00029"></a>00029 <span class="preprocessor">#include &lt;decaf/lang/exceptions/NullPointerException.h&gt;</span>
<a name="l00030"></a>00030 <span class="preprocessor">#include &lt;cms/MapMessage.h&gt;</span>
<a name="l00031"></a>00031 <span class="preprocessor">#include &lt;vector&gt;</span>
<a name="l00032"></a>00032 <span class="preprocessor">#include &lt;string&gt;</span>
<a name="l00033"></a>00033 <span class="preprocessor">#include &lt;memory&gt;</span>
<a name="l00034"></a>00034
<a name="l00035"></a>00035 <span class="keyword">namespace </span>activemq{
<a name="l00036"></a>00036 <span class="keyword">namespace </span>commands{
<a name="l00037"></a>00037
<a name="l00038"></a><a class="code" href="classactivemq_1_1commands_1_1_active_m_q_map_message.html">00038</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_1commands_1_1_active_m_q_map_message.html">ActiveMQMapMessage</a> :
<a name="l00039"></a>00039 <span class="keyword">public</span> <a class="code" href="classactivemq_1_1commands_1_1_active_m_q_message_template.html">ActiveMQMessageTemplate</a>&lt;cms::MapMessage&gt; {
<a name="l00040"></a>00040
<a name="l00041"></a>00041 <span class="keyword">private</span>:
<a name="l00042"></a>00042
<a name="l00043"></a>00043 <span class="comment">// Map Structure to hold unmarshaled Map Data</span>
<a name="l00044"></a>00044 <span class="keyword">mutable</span> std::auto_ptr&lt;util::PrimitiveMap&gt; map;
<a name="l00045"></a>00045
<a name="l00046"></a>00046 <span class="keyword">public</span>:
<a name="l00047"></a>00047
<a name="l00048"></a><a class="code" href="classactivemq_1_1commands_1_1_active_m_q_map_message.html#add24be4c699aa8fccde75833d14695c3">00048</a> <span class="keyword">const</span> <span class="keyword">static</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> ID_ACTIVEMQMAPMESSAGE = 25;
<a name="l00049"></a>00049
<a name="l00050"></a>00050 <span class="keyword">private</span>:
<a name="l00051"></a>00051
<a name="l00052"></a>00052 <a class="code" href="classactivemq_1_1commands_1_1_active_m_q_map_message.html">ActiveMQMapMessage</a>( <span class="keyword">const</span> <a class="code" href="classactivemq_1_1commands_1_1_active_m_q_map_message.html">ActiveMQMapMessage</a>&amp; );
<a name="l00053"></a>00053 <a class="code" href="classactivemq_1_1commands_1_1_active_m_q_map_message.html">ActiveMQMapMessage</a>&amp; operator= ( <span class="keyword">const</span> <a class="code" href="classactivemq_1_1commands_1_1_active_m_q_map_message.html">ActiveMQMapMessage</a>&amp; );
<a name="l00054"></a>00054
<a name="l00055"></a>00055 <span class="keyword">public</span>:
<a name="l00056"></a>00056
<a name="l00057"></a>00057 <a class="code" href="classactivemq_1_1commands_1_1_active_m_q_map_message.html">ActiveMQMapMessage</a>();
<a name="l00058"></a>00058
<a name="l00059"></a>00059 <span class="keyword">virtual</span> ~<a class="code" href="classactivemq_1_1commands_1_1_active_m_q_map_message.html">ActiveMQMapMessage</a>() throw();
<a name="l00060"></a>00060
<a name="l00061"></a>00061 virtual <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> getDataStructureType() <a class="code" href="zconf_8h.html#a2c212835823e3c54a8ab6d95c652660e">const</a>;
<a name="l00062"></a>00062
<a name="l00063"></a><a class="code" href="classactivemq_1_1commands_1_1_active_m_q_map_message.html#a4d7b0ecb914d669b2ce1788d253f2a59">00063</a> virtual <span class="keywordtype">bool</span> isMarshalAware()<span class="keyword"> const </span>{
<a name="l00064"></a>00064 <span class="keywordflow">return</span> <span class="keyword">true</span>;
<a name="l00065"></a>00065 }
<a name="l00066"></a>00066
<a name="l00067"></a>00067 <span class="keyword">virtual</span> <a class="code" href="classactivemq_1_1commands_1_1_active_m_q_map_message.html">ActiveMQMapMessage</a>* cloneDataStructure() <span class="keyword">const</span>;
<a name="l00068"></a>00068
<a name="l00069"></a>00069 <span class="keyword">virtual</span> <span class="keywordtype">void</span> copyDataStructure( <span class="keyword">const</span> <a class="code" href="classactivemq_1_1commands_1_1_data_structure.html">DataStructure</a>* src );
<a name="l00070"></a>00070
<a name="l00071"></a>00071 <span class="keyword">virtual</span> <span class="keywordtype">void</span> beforeMarshal( <a class="code" href="classactivemq_1_1wireformat_1_1_wire_format.html" title="Provides a mechanism to marshal commands into and out of packets or into and out of streams...">wireformat::WireFormat</a>* wireFormat );
<a name="l00072"></a>00072
<a name="l00073"></a>00073 <span class="keyword">virtual</span> std::string toString() <span class="keyword">const</span>;
<a name="l00074"></a>00074
<a name="l00075"></a>00075 <span class="keyword">virtual</span> <span class="keywordtype">bool</span> equals( <span class="keyword">const</span> <a class="code" href="classactivemq_1_1commands_1_1_data_structure.html">DataStructure</a>* value ) <span class="keyword">const</span>;
<a name="l00076"></a>00076
<a name="l00077"></a>00077 <span class="keyword">virtual</span> <span class="keywordtype">void</span> clearBody() throw( cms::CMSException );
<a name="l00078"></a>00078
<a name="l00079"></a>00079 public: <span class="comment">// CMS Message</span>
<a name="l00080"></a>00080
<a name="l00081"></a><a class="code" href="classactivemq_1_1commands_1_1_active_m_q_map_message.html#aca00b9e7bf393b09ad3c5d60fb1100f6">00081</a> virtual cms::MapMessage* clone()<span class="keyword"> const </span>{
<a name="l00082"></a>00082 <span class="keywordflow">return</span> <span class="keyword">dynamic_cast&lt;</span><a class="code" href="classcms_1_1_map_message.html" title="A MapMessage object is used to send a set of name-value pairs.">cms::MapMessage</a>*<span class="keyword">&gt;</span>( this-&gt;cloneDataStructure() );
<a name="l00083"></a>00083 }
<a name="l00084"></a>00084
<a name="l00085"></a>00085 <span class="keyword">public</span>: <span class="comment">// CMS MapMessage</span>
<a name="l00086"></a>00086
<a name="l00090"></a>00090 <span class="keyword">virtual</span> <span class="keywordtype">bool</span> isEmpty() <span class="keyword">const</span>;
<a name="l00091"></a>00091
<a name="l00095"></a>00095 <span class="keyword">virtual</span> std::vector&lt; std::string &gt; getMapNames() <span class="keyword">const</span>;
<a name="l00096"></a>00096
<a name="l00100"></a>00100 <span class="keyword">virtual</span> <span class="keywordtype">bool</span> itemExists( <span class="keyword">const</span> std::string&amp; name ) <span class="keyword">const</span>;
<a name="l00101"></a>00101
<a name="l00105"></a>00105 <span class="keyword">virtual</span> <span class="keywordtype">bool</span> getBoolean( <span class="keyword">const</span> std::string&amp; name ) <span class="keyword">const</span>;
<a name="l00106"></a>00106
<a name="l00110"></a>00110 <span class="keyword">virtual</span> <span class="keywordtype">void</span> setBoolean( <span class="keyword">const</span> std::string&amp; name, <span class="keywordtype">bool</span> value );
<a name="l00111"></a>00111
<a name="l00115"></a>00115 <span class="keyword">virtual</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> getByte( <span class="keyword">const</span> std::string&amp; name ) <span class="keyword">const</span>;
<a name="l00116"></a>00116
<a name="l00120"></a>00120 <span class="keyword">virtual</span> <span class="keywordtype">void</span> setByte( <span class="keyword">const</span> std::string&amp; name, <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> value );
<a name="l00121"></a>00121
<a name="l00125"></a>00125 <span class="keyword">virtual</span> std::vector&lt;unsigned char&gt; getBytes( <span class="keyword">const</span> std::string&amp; name ) <span class="keyword">const</span>;
<a name="l00126"></a>00126
<a name="l00130"></a>00130 <span class="keyword">virtual</span> <span class="keywordtype">void</span> setBytes( <span class="keyword">const</span> std::string&amp; name, <span class="keyword">const</span> std::vector&lt;unsigned char&gt;&amp; value );
<a name="l00131"></a>00131
<a name="l00135"></a>00135 <span class="keyword">virtual</span> <span class="keywordtype">char</span> getChar( <span class="keyword">const</span> std::string&amp; name ) <span class="keyword">const</span>;
<a name="l00136"></a>00136
<a name="l00140"></a>00140 <span class="keyword">virtual</span> <span class="keywordtype">void</span> setChar( <span class="keyword">const</span> std::string&amp; name, <span class="keywordtype">char</span> value );
<a name="l00141"></a>00141
<a name="l00145"></a>00145 <span class="keyword">virtual</span> <span class="keywordtype">double</span> getDouble( <span class="keyword">const</span> std::string&amp; name ) <span class="keyword">const</span>;
<a name="l00146"></a>00146
<a name="l00150"></a>00150 <span class="keyword">virtual</span> <span class="keywordtype">void</span> setDouble( <span class="keyword">const</span> std::string&amp; name, <span class="keywordtype">double</span> value );
<a name="l00151"></a>00151
<a name="l00155"></a>00155 <span class="keyword">virtual</span> <span class="keywordtype">float</span> getFloat( <span class="keyword">const</span> std::string&amp; name ) <span class="keyword">const</span>;
<a name="l00156"></a>00156
<a name="l00160"></a>00160 <span class="keyword">virtual</span> <span class="keywordtype">void</span> setFloat( <span class="keyword">const</span> std::string&amp; name, <span class="keywordtype">float</span> value );
<a name="l00161"></a>00161
<a name="l00165"></a>00165 <span class="keyword">virtual</span> <span class="keywordtype">int</span> getInt( <span class="keyword">const</span> std::string&amp; name ) <span class="keyword">const</span>;
<a name="l00166"></a>00166
<a name="l00170"></a>00170 <span class="keyword">virtual</span> <span class="keywordtype">void</span> setInt( <span class="keyword">const</span> std::string&amp; name, <span class="keywordtype">int</span> value );
<a name="l00171"></a>00171
<a name="l00175"></a>00175 <span class="keyword">virtual</span> <span class="keywordtype">long</span> <span class="keywordtype">long</span> getLong( <span class="keyword">const</span> std::string&amp; name ) <span class="keyword">const</span>;
<a name="l00176"></a>00176
<a name="l00180"></a>00180 <span class="keyword">virtual</span> <span class="keywordtype">void</span> setLong( <span class="keyword">const</span> std::string&amp; name, <span class="keywordtype">long</span> <span class="keywordtype">long</span> value );
<a name="l00181"></a>00181
<a name="l00185"></a>00185 <span class="keyword">virtual</span> <span class="keywordtype">short</span> getShort( <span class="keyword">const</span> std::string&amp; name ) <span class="keyword">const</span>;
<a name="l00186"></a>00186
<a name="l00190"></a>00190 <span class="keyword">virtual</span> <span class="keywordtype">void</span> setShort( <span class="keyword">const</span> std::string&amp; name, <span class="keywordtype">short</span> value );
<a name="l00191"></a>00191
<a name="l00195"></a>00195 <span class="keyword">virtual</span> std::string getString( <span class="keyword">const</span> std::string&amp; name ) <span class="keyword">const</span>;
<a name="l00196"></a>00196
<a name="l00200"></a>00200 <span class="keyword">virtual</span> <span class="keywordtype">void</span> setString( <span class="keyword">const</span> std::string&amp; name, <span class="keyword">const</span> std::string&amp; value );
<a name="l00201"></a>00201
<a name="l00202"></a>00202 <span class="keyword">protected</span>:
<a name="l00203"></a>00203
<a name="l00212"></a>00212 <a class="code" href="classactivemq_1_1util_1_1_primitive_map.html" title="Map of named primitives.">util::PrimitiveMap</a>&amp; getMap();
<a name="l00213"></a>00213 <span class="keyword">const</span> <a class="code" href="classactivemq_1_1util_1_1_primitive_map.html" title="Map of named primitives.">util::PrimitiveMap</a>&amp; getMap() <span class="keyword">const</span>;
<a name="l00214"></a>00214
<a name="l00220"></a>00220 <span class="keyword">virtual</span> <span class="keywordtype">void</span> checkMapIsUnmarshalled() <span class="keyword">const</span>;
<a name="l00221"></a>00221
<a name="l00222"></a>00222 };
<a name="l00223"></a>00223
<a name="l00224"></a>00224 }}
<a name="l00225"></a>00225
<a name="l00226"></a>00226 <span class="preprocessor">#endif </span><span class="comment">/*_ACTIVEMQ_COMMANDS_ACTIVEMQMAPMESSAGE_H_*/</span>
</pre></div></div>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="_active_m_q_map_message_8h.html">ActiveMQMapMessage.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>