| <!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: activemq::commands::KeepAliveInfo 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('classactivemq_1_1commands_1_1_keep_alive_info.html',''); |
| </script> |
| <div id="doc-content"> |
| <div class="header"> |
| <div class="summary"> |
| <a href="#pub-methods">Public Member Functions</a> | |
| <a href="#pub-static-attribs">Static Public Attributes</a> </div> |
| <div class="headertitle"> |
| <h1>activemq::commands::KeepAliveInfo Class Reference</h1> </div> |
| </div> |
| <div class="contents"> |
| <!-- doxytag: class="activemq::commands::KeepAliveInfo" --><!-- doxytag: inherits="activemq::commands::BaseCommand" --> |
| <p><code>#include <<a class="el" href="_keep_alive_info_8h_source.html">src/main/activemq/commands/KeepAliveInfo.h</a>></code></p> |
| <div class="dynheader"> |
| Inheritance diagram for activemq::commands::KeepAliveInfo:</div> |
| <div class="dyncontent"> |
| <div class="center"><img src="classactivemq_1_1commands_1_1_keep_alive_info__inherit__graph.png" border="0" usemap="#activemq_1_1commands_1_1_keep_alive_info_inherit__map" alt="Inheritance graph"/></div> |
| <map name="activemq_1_1commands_1_1_keep_alive_info_inherit__map" id="activemq_1_1commands_1_1_keep_alive_info_inherit__map"> |
| <area shape="rect" id="node2" href="classactivemq_1_1commands_1_1_base_command.html" title="activemq::commands::BaseCommand" alt="" coords="21,315,301,344"/><area shape="rect" id="node4" href="classactivemq_1_1commands_1_1_command.html" title="activemq::commands::Command" alt="" coords="39,237,284,267"/><area shape="rect" id="node6" href="classactivemq_1_1commands_1_1_base_data_structure.html" title="activemq::commands::BaseDataStructure" alt="" coords="5,160,317,189"/><area shape="rect" id="node8" href="classactivemq_1_1commands_1_1_data_structure.html" title="activemq::commands::DataStructure" alt="" coords="23,83,300,112"/><area shape="rect" id="node10" href="classactivemq_1_1wireformat_1_1_marshal_aware.html" title="activemq::wireformat::MarshalAware" alt="" coords="25,5,297,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"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classactivemq_1_1commands_1_1_keep_alive_info.html#a70da276cdf365aca0981a3f48cc65a6d">KeepAliveInfo</a> ()</td></tr> |
| <tr><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classactivemq_1_1commands_1_1_keep_alive_info.html#ad850e0238778d32666f5ca8ebf95ac59">~KeepAliveInfo</a> ()</td></tr> |
| <tr><td class="memItemLeft" align="right" valign="top">virtual unsigned char </td><td class="memItemRight" valign="bottom"><a class="el" href="classactivemq_1_1commands_1_1_keep_alive_info.html#af52631fb36c4f36420afca1c9ce7eeac">getDataStructureType</a> () const </td></tr> |
| <tr><td class="mdescLeft"> </td><td class="mdescRight">Get the <a class="el" href="classactivemq_1_1commands_1_1_data_structure.html">DataStructure</a> Type as defined in CommandTypes.h. <a href="#af52631fb36c4f36420afca1c9ce7eeac"></a><br/></td></tr> |
| <tr><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classactivemq_1_1commands_1_1_keep_alive_info.html">KeepAliveInfo</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classactivemq_1_1commands_1_1_keep_alive_info.html#a790b6bf6ab4619e701eca3cb5294add5">cloneDataStructure</a> () const </td></tr> |
| <tr><td class="mdescLeft"> </td><td class="mdescRight">Clone this obbject and return a new instance that the caller now owns, this will be an exact copy of this one. <a href="#a790b6bf6ab4619e701eca3cb5294add5"></a><br/></td></tr> |
| <tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classactivemq_1_1commands_1_1_keep_alive_info.html#a165285b0b69403f7e6b89d9b3ba395a4">copyDataStructure</a> (const <a class="el" href="classactivemq_1_1commands_1_1_data_structure.html">DataStructure</a> *src)</td></tr> |
| <tr><td class="mdescLeft"> </td><td class="mdescRight">Copy the contents of the passed object into this objects members, overwriting any existing data. <a href="#a165285b0b69403f7e6b89d9b3ba395a4"></a><br/></td></tr> |
| <tr><td class="memItemLeft" align="right" valign="top">virtual std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classactivemq_1_1commands_1_1_keep_alive_info.html#a11e19610a787673e0b52e9ac65d28676">toString</a> () const </td></tr> |
| <tr><td class="mdescLeft"> </td><td class="mdescRight">Returns a string containing the information for this <a class="el" href="classactivemq_1_1commands_1_1_data_structure.html">DataStructure</a> such as its type and value of its elements. <a href="#a11e19610a787673e0b52e9ac65d28676"></a><br/></td></tr> |
| <tr><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classactivemq_1_1commands_1_1_keep_alive_info.html#a6080dacb2b8c31965990e13c7aee23c5">equals</a> (const <a class="el" href="classactivemq_1_1commands_1_1_data_structure.html">DataStructure</a> *value) const </td></tr> |
| <tr><td class="mdescLeft"> </td><td class="mdescRight">Compares the <a class="el" href="classactivemq_1_1commands_1_1_data_structure.html">DataStructure</a> passed in to this one, and returns if they are equivalent. <a href="#a6080dacb2b8c31965990e13c7aee23c5"></a><br/></td></tr> |
| <tr><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classactivemq_1_1commands_1_1_keep_alive_info.html#a0187eb6f606d8076bc9926dc613d6ae9">isKeepAliveInfo</a> () const </td></tr> |
| <tr><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classdecaf_1_1lang_1_1_pointer.html">Pointer</a>< <a class="el" href="classactivemq_1_1commands_1_1_command.html">Command</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classactivemq_1_1commands_1_1_keep_alive_info.html#a955f20d9df5de09d4060f726a2005648">visit</a> (<a class="el" href="classactivemq_1_1state_1_1_command_visitor.html">activemq::state::CommandVisitor</a> *visitor)</td></tr> |
| <tr><td class="mdescLeft"> </td><td class="mdescRight">Allows a Visitor to visit this command and return a response to the command based on the command type being visited. <a href="#a955f20d9df5de09d4060f726a2005648"></a><br/></td></tr> |
| <tr><td colspan="2"><h2><a name="pub-static-attribs"></a> |
| Static Public Attributes</h2></td></tr> |
| <tr><td class="memItemLeft" align="right" valign="top">static const unsigned char </td><td class="memItemRight" valign="bottom"><a class="el" href="classactivemq_1_1commands_1_1_keep_alive_info.html#aacdd9fd83577917e018863616f4fa6b2">ID_KEEPALIVEINFO</a> = 10</td></tr> |
| </table> |
| <hr/><h2>Constructor & Destructor Documentation</h2> |
| <a class="anchor" id="a70da276cdf365aca0981a3f48cc65a6d"></a><!-- doxytag: member="activemq::commands::KeepAliveInfo::KeepAliveInfo" ref="a70da276cdf365aca0981a3f48cc65a6d" args="()" --> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">activemq::commands::KeepAliveInfo::KeepAliveInfo </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div> |
| <div class="memdoc"> |
| |
| </div> |
| </div> |
| <a class="anchor" id="ad850e0238778d32666f5ca8ebf95ac59"></a><!-- doxytag: member="activemq::commands::KeepAliveInfo::~KeepAliveInfo" ref="ad850e0238778d32666f5ca8ebf95ac59" args="()" --> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">virtual activemq::commands::KeepAliveInfo::~KeepAliveInfo </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td><code> [virtual]</code></td> |
| </tr> |
| </table> |
| </div> |
| <div class="memdoc"> |
| |
| </div> |
| </div> |
| <hr/><h2>Member Function Documentation</h2> |
| <a class="anchor" id="a790b6bf6ab4619e701eca3cb5294add5"></a><!-- doxytag: member="activemq::commands::KeepAliveInfo::cloneDataStructure" ref="a790b6bf6ab4619e701eca3cb5294add5" args="() const " --> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">virtual <a class="el" href="classactivemq_1_1commands_1_1_keep_alive_info.html">KeepAliveInfo</a>* activemq::commands::KeepAliveInfo::cloneDataStructure </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td> const<code> [virtual]</code></td> |
| </tr> |
| </table> |
| </div> |
| <div class="memdoc"> |
| |
| <p>Clone this obbject and return a new instance that the caller now owns, this will be an exact copy of this one. </p> |
| <dl class="return"><dt><b>Returns:</b></dt><dd>new copy of this object. </dd></dl> |
| |
| <p>Implements <a class="el" href="classactivemq_1_1commands_1_1_data_structure.html#affc93e43d4561e483007723a9492027c">activemq::commands::DataStructure</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a165285b0b69403f7e6b89d9b3ba395a4"></a><!-- doxytag: member="activemq::commands::KeepAliveInfo::copyDataStructure" ref="a165285b0b69403f7e6b89d9b3ba395a4" args="(const DataStructure *src)" --> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">virtual void activemq::commands::KeepAliveInfo::copyDataStructure </td> |
| <td>(</td> |
| <td class="paramtype">const <a class="el" href="classactivemq_1_1commands_1_1_data_structure.html">DataStructure</a> * </td> |
| <td class="paramname"><em>src</em></td><td>)</td> |
| <td><code> [virtual]</code></td> |
| </tr> |
| </table> |
| </div> |
| <div class="memdoc"> |
| |
| <p>Copy the contents of the passed object into this objects members, overwriting any existing data. </p> |
| <dl class="return"><dt><b>Returns:</b></dt><dd>src - Source Object </dd></dl> |
| |
| <p>Reimplemented from <a class="el" href="classactivemq_1_1commands_1_1_base_command.html#af90ce7c13f771c71123ca6fc2468c7bd">activemq::commands::BaseCommand</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a6080dacb2b8c31965990e13c7aee23c5"></a><!-- doxytag: member="activemq::commands::KeepAliveInfo::equals" ref="a6080dacb2b8c31965990e13c7aee23c5" args="(const DataStructure *value) const " --> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">virtual bool activemq::commands::KeepAliveInfo::equals </td> |
| <td>(</td> |
| <td class="paramtype">const <a class="el" href="classactivemq_1_1commands_1_1_data_structure.html">DataStructure</a> * </td> |
| <td class="paramname"><em>value</em></td><td>)</td> |
| <td> const<code> [virtual]</code></td> |
| </tr> |
| </table> |
| </div> |
| <div class="memdoc"> |
| |
| <p>Compares the <a class="el" href="classactivemq_1_1commands_1_1_data_structure.html">DataStructure</a> passed in to this one, and returns if they are equivalent. </p> |
| <p>Equivalent here means that they are of the same type, and that each element of the objects are the same. </p> |
| <dl class="return"><dt><b>Returns:</b></dt><dd>true if DataStructure's are Equal. </dd></dl> |
| |
| <p>Reimplemented from <a class="el" href="classactivemq_1_1commands_1_1_base_command.html#ab96dc9deb2b85b6f9d16131a4ca439de">activemq::commands::BaseCommand</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="af52631fb36c4f36420afca1c9ce7eeac"></a><!-- doxytag: member="activemq::commands::KeepAliveInfo::getDataStructureType" ref="af52631fb36c4f36420afca1c9ce7eeac" args="() const " --> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">virtual unsigned char activemq::commands::KeepAliveInfo::getDataStructureType </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td> const<code> [virtual]</code></td> |
| </tr> |
| </table> |
| </div> |
| <div class="memdoc"> |
| |
| <p>Get the <a class="el" href="classactivemq_1_1commands_1_1_data_structure.html">DataStructure</a> Type as defined in CommandTypes.h. </p> |
| <dl class="return"><dt><b>Returns:</b></dt><dd>The type of the data structure </dd></dl> |
| |
| <p>Implements <a class="el" href="classactivemq_1_1commands_1_1_data_structure.html#a8f5ef11cb8ca5bb17266cf3bd70a1c71">activemq::commands::DataStructure</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a0187eb6f606d8076bc9926dc613d6ae9"></a><!-- doxytag: member="activemq::commands::KeepAliveInfo::isKeepAliveInfo" ref="a0187eb6f606d8076bc9926dc613d6ae9" args="() const " --> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">virtual bool activemq::commands::KeepAliveInfo::isKeepAliveInfo </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td> const<code> [inline, virtual]</code></td> |
| </tr> |
| </table> |
| </div> |
| <div class="memdoc"> |
| <dl class="return"><dt><b>Returns:</b></dt><dd>an answer of true to the <a class="el" href="classactivemq_1_1commands_1_1_keep_alive_info.html#a0187eb6f606d8076bc9926dc613d6ae9">isKeepAliveInfo()</a> query. </dd></dl> |
| |
| <p>Reimplemented from <a class="el" href="classactivemq_1_1commands_1_1_base_command.html#a5c710b7cce500c0dbc1d057dbb1a2b77">activemq::commands::BaseCommand</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a11e19610a787673e0b52e9ac65d28676"></a><!-- doxytag: member="activemq::commands::KeepAliveInfo::toString" ref="a11e19610a787673e0b52e9ac65d28676" args="() const " --> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">virtual std::string activemq::commands::KeepAliveInfo::toString </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td> const<code> [virtual]</code></td> |
| </tr> |
| </table> |
| </div> |
| <div class="memdoc"> |
| |
| <p>Returns a string containing the information for this <a class="el" href="classactivemq_1_1commands_1_1_data_structure.html">DataStructure</a> such as its type and value of its elements. </p> |
| <dl class="return"><dt><b>Returns:</b></dt><dd>formatted string useful for debugging. </dd></dl> |
| |
| <p>Reimplemented from <a class="el" href="classactivemq_1_1commands_1_1_base_command.html#ad5dfa2a9f0e7ab2896c3d22b08456484">activemq::commands::BaseCommand</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a955f20d9df5de09d4060f726a2005648"></a><!-- doxytag: member="activemq::commands::KeepAliveInfo::visit" ref="a955f20d9df5de09d4060f726a2005648" args="(activemq::state::CommandVisitor *visitor)" --> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">virtual <a class="el" href="classdecaf_1_1lang_1_1_pointer.html">Pointer</a><<a class="el" href="classactivemq_1_1commands_1_1_command.html">Command</a>> activemq::commands::KeepAliveInfo::visit </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="classactivemq_1_1state_1_1_command_visitor.html">activemq::state::CommandVisitor</a> * </td> |
| <td class="paramname"><em>visitor</em></td><td>)</td> |
| <td><code> [virtual]</code></td> |
| </tr> |
| </table> |
| </div> |
| <div class="memdoc"> |
| |
| <p>Allows a Visitor to visit this command and return a response to the command based on the command type being visited. </p> |
| <p>The command will call the proper processXXX method in the visitor.</p> |
| <dl class="return"><dt><b>Returns:</b></dt><dd>a <a class="el" href="classactivemq_1_1commands_1_1_response.html">Response</a> to the visitor being called or NULL if no response. </dd></dl> |
| |
| <p>Implements <a class="el" href="classactivemq_1_1commands_1_1_command.html#a973a872bcacf958883e041cb7caeff2c">activemq::commands::Command</a>.</p> |
| |
| </div> |
| </div> |
| <hr/><h2>Field Documentation</h2> |
| <a class="anchor" id="aacdd9fd83577917e018863616f4fa6b2"></a><!-- doxytag: member="activemq::commands::KeepAliveInfo::ID_KEEPALIVEINFO" ref="aacdd9fd83577917e018863616f4fa6b2" args="" --> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">const unsigned char <a class="el" href="classactivemq_1_1commands_1_1_keep_alive_info.html#aacdd9fd83577917e018863616f4fa6b2">activemq::commands::KeepAliveInfo::ID_KEEPALIVEINFO</a> = 10<code> [static]</code></td> |
| </tr> |
| </table> |
| </div> |
| <div class="memdoc"> |
| |
| </div> |
| </div> |
| <hr/>The documentation for this class was generated from the following file:<ul> |
| <li>src/main/activemq/commands/<a class="el" href="_keep_alive_info_8h_source.html">KeepAliveInfo.h</a></li> |
| </ul> |
| </div> |
| </div> |
| <div id="nav-path" class="navpath"> |
| <ul> |
| <li class="navelem"><a class="el" href="namespaceactivemq.html">activemq</a> </li> |
| <li class="navelem"><a class="el" href="namespaceactivemq_1_1commands.html">commands</a> </li> |
| <li class="navelem"><a class="el" href="classactivemq_1_1commands_1_1_keep_alive_info.html">KeepAliveInfo</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> |
