Google Git
Sign in
apache / ignite-website / 372257fe483ecaf031bfad76800308d2eed57097 / . / releases / 2.11.1 / cppdoc / classignite_1_1JvmOptions.html
blob: 713a1ca7c0a3144f16b656a8e661a706c80b026e [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"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>&nbsp; Apache Ignite C++: ignite::JvmOptions Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectlogo"><img alt="Logo" src="ignite_logo.png"/></td>
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">&nbsp; Apache Ignite C++
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespaceignite.html">ignite</a></li><li class="navelem"><a class="el" href="classignite_1_1JvmOptions.html">JvmOptions</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="classignite_1_1JvmOptions-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">ignite::JvmOptions Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>JVM options.
<a href="classignite_1_1JvmOptions.html#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:ab4891916e4ac952229d0e6e4f4129bc2"><td class="memItemLeft" align="right" valign="top"><a id="ab4891916e4ac952229d0e6e4f4129bc2"></a>
&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classignite_1_1JvmOptions.html#ab4891916e4ac952229d0e6e4f4129bc2">JvmOptions</a> ()</td></tr>
<tr class="memdesc:ab4891916e4ac952229d0e6e4f4129bc2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor. <br /></td></tr>
<tr class="separator:ab4891916e4ac952229d0e6e4f4129bc2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5f15b2d6e521944ee62ed829ce0cf568"><td class="memItemLeft" align="right" valign="top"><a id="a5f15b2d6e521944ee62ed829ce0cf568"></a>
&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classignite_1_1JvmOptions.html#a5f15b2d6e521944ee62ed829ce0cf568">~JvmOptions</a> ()</td></tr>
<tr class="memdesc:a5f15b2d6e521944ee62ed829ce0cf568"><td class="mdescLeft">&#160;</td><td class="mdescRight">Destructor. <br /></td></tr>
<tr class="separator:a5f15b2d6e521944ee62ed829ce0cf568"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af6d62a199c8b85f304959cae75b4005d"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classignite_1_1JvmOptions.html#af6d62a199c8b85f304959cae75b4005d">FromConfiguration</a> (const <a class="el" href="structignite_1_1IgniteConfiguration.html">IgniteConfiguration</a> &amp;cfg, const std::string &amp;home, const std::string &amp;cp)</td></tr>
<tr class="memdesc:af6d62a199c8b85f304959cae75b4005d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Create JVM options from configuration. <a href="#af6d62a199c8b85f304959cae75b4005d">More...</a><br /></td></tr>
<tr class="separator:af6d62a199c8b85f304959cae75b4005d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6744aca5954efe843ead164cbfd507dc"><td class="memItemLeft" align="right" valign="top"><a id="a6744aca5954efe843ead164cbfd507dc"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classignite_1_1JvmOptions.html#a6744aca5954efe843ead164cbfd507dc">Deinit</a> ()</td></tr>
<tr class="memdesc:a6744aca5954efe843ead164cbfd507dc"><td class="mdescLeft">&#160;</td><td class="mdescRight">Deallocates all allocated data. <br /></td></tr>
<tr class="separator:a6744aca5954efe843ead164cbfd507dc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a897086840f79778ff569e1339114994a"><td class="memItemLeft" align="right" valign="top">char **&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classignite_1_1JvmOptions.html#a897086840f79778ff569e1339114994a">GetOpts</a> ()</td></tr>
<tr class="memdesc:a897086840f79778ff569e1339114994a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get built options. <a href="#a897086840f79778ff569e1339114994a">More...</a><br /></td></tr>
<tr class="separator:a897086840f79778ff569e1339114994a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ade5ccee4d24af7eb337cbf9ced80aa7f"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classignite_1_1JvmOptions.html#ade5ccee4d24af7eb337cbf9ced80aa7f">GetSize</a> () const</td></tr>
<tr class="memdesc:ade5ccee4d24af7eb337cbf9ced80aa7f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get options number. <a href="#ade5ccee4d24af7eb337cbf9ced80aa7f">More...</a><br /></td></tr>
<tr class="separator:ade5ccee4d24af7eb337cbf9ced80aa7f"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>JVM options. </p>
<p>Used to build JVM options in a exception-safe way. </p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="af6d62a199c8b85f304959cae75b4005d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af6d62a199c8b85f304959cae75b4005d">&#9670;&nbsp;</a></span>FromConfiguration()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void ignite::JvmOptions::FromConfiguration </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="structignite_1_1IgniteConfiguration.html">IgniteConfiguration</a> &amp;&#160;</td>
<td class="paramname"><em>cfg</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::string &amp;&#160;</td>
<td class="paramname"><em>home</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::string &amp;&#160;</td>
<td class="paramname"><em>cp</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Create JVM options from configuration. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">cfg</td><td>Configuration. </td></tr>
<tr><td class="paramname">home</td><td>Optional GG home. </td></tr>
<tr><td class="paramname">cp</td><td>Classpath. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a897086840f79778ff569e1339114994a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a897086840f79778ff569e1339114994a">&#9670;&nbsp;</a></span>GetOpts()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">char** ignite::JvmOptions::GetOpts </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Get built options. </p>
<dl class="section return"><dt>Returns</dt><dd>Built options </dd></dl>
</div>
</div>
<a id="ade5ccee4d24af7eb337cbf9ced80aa7f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ade5ccee4d24af7eb337cbf9ced80aa7f">&#9670;&nbsp;</a></span>GetSize()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">int ignite::JvmOptions::GetSize </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Get options number. </p>
<dl class="section return"><dt>Returns</dt><dd>Options number. </dd></dl>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>ignition.cpp</li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Mon Dec 20 2021 14:08:59 for &nbsp; Apache Ignite C++ by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.13
</small></address>
</body>
</html>