blob: c7b6f2cbf0a718ba8a4b3f1d25069b0643392cb7 [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<link rel="canonical" href="https://ignite.apache.org/releases/2.6.0/javadoc/org/apache/ignite/igfs/IgfsIpcEndpointConfiguration.html" />
<META NAME="ROBOTS" CONTENT="NOINDEX">
<!-- Generated by javadoc (1.8.0_77) on Tue Jul 10 11:04:41 UTC 2018 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>IgfsIpcEndpointConfiguration (Ignite 2.6.0)</title>
<meta name="date" content="2018-07-10">
<link rel="stylesheet" type="text/css" href="../../../../javadoc.css" title="Style">
<script type="text/javascript" src="../../../../script.js"></script>
<script>
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
})(window,document,'script','https://www.google-analytics.com/analytics.js','ga');
ga('create', 'UA-61232409-1', 'auto');
ga('send', 'pageview');
</script></head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="IgfsIpcEndpointConfiguration (Ignite 2.6.0)";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/IgfsIpcEndpointConfiguration.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../index-all.html">Index</a></li>
<li><a href="../../../../help-doc.html">Help</a></li>
</ul>
<div class="aboutLanguage">Ignite - In-Memory Data Fabric</div>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../org/apache/ignite/igfs/IgfsInvalidPathException.html" title="class in org.apache.ignite.igfs"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../org/apache/ignite/igfs/IgfsIpcEndpointType.html" title="enum in org.apache.ignite.igfs"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/ignite/igfs/IgfsIpcEndpointConfiguration.html" target="_top">Frames</a></li>
<li><a href="IgfsIpcEndpointConfiguration.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">org.apache.ignite.igfs</div>
<h2 title="Class IgfsIpcEndpointConfiguration" class="title">Class IgfsIpcEndpointConfiguration</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li>
<li>
<ul class="inheritance">
<li>org.apache.ignite.igfs.IgfsIpcEndpointConfiguration</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public class <span class="typeNameLabel">IgfsIpcEndpointConfiguration</span>
extends <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></pre>
<div class="block">IGFS IPC endpoint configuration.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- =========== FIELD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
<caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Field and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/ignite/igfs/IgfsIpcEndpointConfiguration.html#DFLT_HOST">DFLT_HOST</a></span></code>
<div class="block">Default host.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/ignite/igfs/IgfsIpcEndpointConfiguration.html#DFLT_MEM_SIZE">DFLT_MEM_SIZE</a></span></code>
<div class="block">Default shared memory space in bytes.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/ignite/igfs/IgfsIpcEndpointConfiguration.html#DFLT_PORT">DFLT_PORT</a></span></code>
<div class="block">Default port.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/ignite/igfs/IgfsIpcEndpointConfiguration.html#DFLT_THREAD_CNT">DFLT_THREAD_CNT</a></span></code>
<div class="block">Default threads count.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/ignite/igfs/IgfsIpcEndpointConfiguration.html#DFLT_TOKEN_DIR_PATH">DFLT_TOKEN_DIR_PATH</a></span></code>
<div class="block">Default token directory.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <a href="../../../../org/apache/ignite/igfs/IgfsIpcEndpointType.html" title="enum in org.apache.ignite.igfs">IgfsIpcEndpointType</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/ignite/igfs/IgfsIpcEndpointConfiguration.html#DFLT_TYPE">DFLT_TYPE</a></span></code>
<div class="block">Default endpoint type is TCP.</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/apache/ignite/igfs/IgfsIpcEndpointConfiguration.html#IgfsIpcEndpointConfiguration--">IgfsIpcEndpointConfiguration</a></span>()</code>
<div class="block">Default constructor.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/apache/ignite/igfs/IgfsIpcEndpointConfiguration.html#IgfsIpcEndpointConfiguration-org.apache.ignite.igfs.IgfsIpcEndpointConfiguration-">IgfsIpcEndpointConfiguration</a></span>(<a href="../../../../org/apache/ignite/igfs/IgfsIpcEndpointConfiguration.html" title="class in org.apache.ignite.igfs">IgfsIpcEndpointConfiguration</a>&nbsp;cfg)</code>
<div class="block">Copying constructor.</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/ignite/igfs/IgfsIpcEndpointConfiguration.html#getHost--">getHost</a></span>()</code>
<div class="block">Gets the host endpoint is bound to.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/ignite/igfs/IgfsIpcEndpointConfiguration.html#getMemorySize--">getMemorySize</a></span>()</code>
<div class="block">Gets shared memory size in bytes allocated for endpoint communication.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/ignite/igfs/IgfsIpcEndpointConfiguration.html#getPort--">getPort</a></span>()</code>
<div class="block">Gets the port endpoint is bound to.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/ignite/igfs/IgfsIpcEndpointConfiguration.html#getThreadCount--">getThreadCount</a></span>()</code>
<div class="block">Get number of threads used by this endpoint to process incoming requests.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/ignite/igfs/IgfsIpcEndpointConfiguration.html#getTokenDirectoryPath--">getTokenDirectoryPath</a></span>()</code>
<div class="block">Gets directory where shared memory tokens are stored.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code><a href="../../../../org/apache/ignite/igfs/IgfsIpcEndpointType.html" title="enum in org.apache.ignite.igfs">IgfsIpcEndpointType</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/ignite/igfs/IgfsIpcEndpointConfiguration.html#getType--">getType</a></span>()</code>
<div class="block">Gets endpoint type.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code><a href="../../../../org/apache/ignite/igfs/IgfsIpcEndpointConfiguration.html" title="class in org.apache.ignite.igfs">IgfsIpcEndpointConfiguration</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/ignite/igfs/IgfsIpcEndpointConfiguration.html#setHost-java.lang.String-">setHost</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;host)</code>
<div class="block">Sets the host endpoint is bound to.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code><a href="../../../../org/apache/ignite/igfs/IgfsIpcEndpointConfiguration.html" title="class in org.apache.ignite.igfs">IgfsIpcEndpointConfiguration</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/ignite/igfs/IgfsIpcEndpointConfiguration.html#setMemorySize-int-">setMemorySize</a></span>(int&nbsp;memSize)</code>
<div class="block">Sets shared memory size in bytes allocated for endpoint communication.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code><a href="../../../../org/apache/ignite/igfs/IgfsIpcEndpointConfiguration.html" title="class in org.apache.ignite.igfs">IgfsIpcEndpointConfiguration</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/ignite/igfs/IgfsIpcEndpointConfiguration.html#setPort-int-">setPort</a></span>(int&nbsp;port)</code>
<div class="block">Sets the port endpoint is bound to.</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code><a href="../../../../org/apache/ignite/igfs/IgfsIpcEndpointConfiguration.html" title="class in org.apache.ignite.igfs">IgfsIpcEndpointConfiguration</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/ignite/igfs/IgfsIpcEndpointConfiguration.html#setThreadCount-int-">setThreadCount</a></span>(int&nbsp;threadCnt)</code>
<div class="block">Set number of threads used by this endpoint to process incoming requests.</div>
</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code><a href="../../../../org/apache/ignite/igfs/IgfsIpcEndpointConfiguration.html" title="class in org.apache.ignite.igfs">IgfsIpcEndpointConfiguration</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/ignite/igfs/IgfsIpcEndpointConfiguration.html#setTokenDirectoryPath-java.lang.String-">setTokenDirectoryPath</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;tokenDirPath)</code>
<div class="block">Sets directory where shared memory tokens are stored.</div>
</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code><a href="../../../../org/apache/ignite/igfs/IgfsIpcEndpointConfiguration.html" title="class in org.apache.ignite.igfs">IgfsIpcEndpointConfiguration</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/ignite/igfs/IgfsIpcEndpointConfiguration.html#setType-org.apache.ignite.igfs.IgfsIpcEndpointType-">setType</a></span>(<a href="../../../../org/apache/ignite/igfs/IgfsIpcEndpointType.html" title="enum in org.apache.ignite.igfs">IgfsIpcEndpointType</a>&nbsp;type)</code>
<div class="block">Sets endpoint type.</div>
</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/ignite/igfs/IgfsIpcEndpointConfiguration.html#toString--">toString</a></span>()</code></td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
<code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ FIELD DETAIL =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.detail">
<!-- -->
</a>
<h3>Field Detail</h3>
<a name="DFLT_TYPE">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>DFLT_TYPE</h4>
<pre>public static&nbsp;<a href="../../../../org/apache/ignite/igfs/IgfsIpcEndpointType.html" title="enum in org.apache.ignite.igfs">IgfsIpcEndpointType</a> DFLT_TYPE</pre>
<div class="block">Default endpoint type is TCP.</div>
</li>
</ul>
<a name="DFLT_HOST">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>DFLT_HOST</h4>
<pre>public static&nbsp;<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> DFLT_HOST</pre>
<div class="block">Default host.</div>
</li>
</ul>
<a name="DFLT_PORT">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>DFLT_PORT</h4>
<pre>public static&nbsp;int DFLT_PORT</pre>
<div class="block">Default port.</div>
</li>
</ul>
<a name="DFLT_MEM_SIZE">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>DFLT_MEM_SIZE</h4>
<pre>public static final&nbsp;int DFLT_MEM_SIZE</pre>
<div class="block">Default shared memory space in bytes.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../constant-values.html#org.apache.ignite.igfs.IgfsIpcEndpointConfiguration.DFLT_MEM_SIZE">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="DFLT_TOKEN_DIR_PATH">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>DFLT_TOKEN_DIR_PATH</h4>
<pre>public static final&nbsp;<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> DFLT_TOKEN_DIR_PATH</pre>
<div class="block">Default token directory. Note that this path is relative to <code>IGNITE_HOME/work</code> folder
if <code>IGNITE_HOME</code> system or environment variable specified, otherwise it is relative to
<code>work</code> folder under system <code>java.io.tmpdir</code> folder.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../org/apache/ignite/configuration/IgniteConfiguration.html#getWorkDirectory--"><code>IgniteConfiguration.getWorkDirectory()</code></a>,
<a href="../../../../constant-values.html#org.apache.ignite.igfs.IgfsIpcEndpointConfiguration.DFLT_TOKEN_DIR_PATH">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="DFLT_THREAD_CNT">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>DFLT_THREAD_CNT</h4>
<pre>public static final&nbsp;int DFLT_THREAD_CNT</pre>
<div class="block">Default threads count.</div>
</li>
</ul>
</li>
</ul>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="IgfsIpcEndpointConfiguration--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>IgfsIpcEndpointConfiguration</h4>
<pre>public&nbsp;IgfsIpcEndpointConfiguration()</pre>
<div class="block">Default constructor.</div>
</li>
</ul>
<a name="IgfsIpcEndpointConfiguration-org.apache.ignite.igfs.IgfsIpcEndpointConfiguration-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>IgfsIpcEndpointConfiguration</h4>
<pre>public&nbsp;IgfsIpcEndpointConfiguration(<a href="../../../../org/apache/ignite/igfs/IgfsIpcEndpointConfiguration.html" title="class in org.apache.ignite.igfs">IgfsIpcEndpointConfiguration</a>&nbsp;cfg)</pre>
<div class="block">Copying constructor.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>cfg</code> - Configuration to copy.</dd>
</dl>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="getType--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getType</h4>
<pre>public&nbsp;<a href="../../../../org/apache/ignite/igfs/IgfsIpcEndpointType.html" title="enum in org.apache.ignite.igfs">IgfsIpcEndpointType</a>&nbsp;getType()</pre>
<div class="block">Gets endpoint type. There are two endpoints types: <code>SHMEM</code> working over shared memory, and <code>TCP</code>
working over sockets.
<p>
Shared memory is recommended approach for Linux-based systems. For Windows TCP is the only available option.
<p>
Defaults to <a href="../../../../org/apache/ignite/igfs/IgfsIpcEndpointConfiguration.html#DFLT_TYPE"><code>DFLT_TYPE</code></a>.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Endpoint type.</dd>
</dl>
</li>
</ul>
<a name="setType-org.apache.ignite.igfs.IgfsIpcEndpointType-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setType</h4>
<pre>public&nbsp;<a href="../../../../org/apache/ignite/igfs/IgfsIpcEndpointConfiguration.html" title="class in org.apache.ignite.igfs">IgfsIpcEndpointConfiguration</a>&nbsp;setType(<a href="../../../../org/apache/ignite/igfs/IgfsIpcEndpointType.html" title="enum in org.apache.ignite.igfs">IgfsIpcEndpointType</a>&nbsp;type)</pre>
<div class="block">Sets endpoint type. There are two endpoints types: <a href="../../../../org/apache/ignite/igfs/IgfsIpcEndpointType.html#SHMEM"><code>IgfsIpcEndpointType.SHMEM</code></a> working over shared memory,
and <a href="../../../../org/apache/ignite/igfs/IgfsIpcEndpointType.html#TCP"><code>IgfsIpcEndpointType.TCP</code></a> working over sockets.
<p>
Shared memory is recommended approach for Linux-based systems. For Windows TCP is the only available option.
<p>
Defaults to <a href="../../../../org/apache/ignite/igfs/IgfsIpcEndpointConfiguration.html#DFLT_TYPE"><code>DFLT_TYPE</code></a>.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>type</code> - Endpoint type.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd><code>this</code> for chaining.</dd>
</dl>
</li>
</ul>
<a name="getHost--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getHost</h4>
<pre>public&nbsp;<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;getHost()</pre>
<div class="block">Gets the host endpoint is bound to.
<p>
For <a href="../../../../org/apache/ignite/igfs/IgfsIpcEndpointType.html#TCP"><code>IgfsIpcEndpointType.TCP</code></a> endpoint this is the network interface server socket is bound to.
<p>
For <a href="../../../../org/apache/ignite/igfs/IgfsIpcEndpointType.html#SHMEM"><code>IgfsIpcEndpointType.SHMEM</code></a> endpoint socket connection is needed only to perform an initial handshake.
All further communication is performed over shared memory. Therefore, for <code>SHMEM</code> this value is ignored
and socket will be always bound to <a href="../../../../org/apache/ignite/igfs/IgfsIpcEndpointConfiguration.html#DFLT_HOST"><code>DFLT_HOST</code></a>.
<p>
Defaults to <a href="../../../../org/apache/ignite/igfs/IgfsIpcEndpointConfiguration.html#DFLT_HOST"><code>DFLT_HOST</code></a>.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Host.</dd>
</dl>
</li>
</ul>
<a name="setHost-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setHost</h4>
<pre>public&nbsp;<a href="../../../../org/apache/ignite/igfs/IgfsIpcEndpointConfiguration.html" title="class in org.apache.ignite.igfs">IgfsIpcEndpointConfiguration</a>&nbsp;setHost(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;host)</pre>
<div class="block">Sets the host endpoint is bound to.
<p>
For <a href="../../../../org/apache/ignite/igfs/IgfsIpcEndpointType.html#TCP"><code>IgfsIpcEndpointType.TCP</code></a> endpoint this is the network interface server socket is bound to.
<p>
For <a href="../../../../org/apache/ignite/igfs/IgfsIpcEndpointType.html#SHMEM"><code>IgfsIpcEndpointType.SHMEM</code></a> endpoint socket connection is needed only to perform an initial handshake.
All further communication is performed over shared memory. Therefore, for <code>SHMEM</code> this value is ignored
and socket will be always bound to <a href="../../../../org/apache/ignite/igfs/IgfsIpcEndpointConfiguration.html#DFLT_HOST"><code>DFLT_HOST</code></a>.
<p>
Defaults to <a href="../../../../org/apache/ignite/igfs/IgfsIpcEndpointConfiguration.html#DFLT_HOST"><code>DFLT_HOST</code></a>.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>host</code> - Host.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd><code>this</code> for chaining.</dd>
</dl>
</li>
</ul>
<a name="getPort--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getPort</h4>
<pre>public&nbsp;int&nbsp;getPort()</pre>
<div class="block">Gets the port endpoint is bound to.
<p>
For <a href="../../../../org/apache/ignite/igfs/IgfsIpcEndpointType.html#TCP"><code>IgfsIpcEndpointType.TCP</code></a> endpoint this is the port server socket is bound to.
<p>
For <a href="../../../../org/apache/ignite/igfs/IgfsIpcEndpointType.html#SHMEM"><code>IgfsIpcEndpointType.SHMEM</code></a> endpoint socket connection is needed only to perform an initial handshake.
All further communication is performed over shared memory.
<p>
Defaults to <a href="../../../../org/apache/ignite/igfs/IgfsIpcEndpointConfiguration.html#DFLT_PORT"><code>DFLT_PORT</code></a>.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Port.</dd>
</dl>
</li>
</ul>
<a name="setPort-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setPort</h4>
<pre>public&nbsp;<a href="../../../../org/apache/ignite/igfs/IgfsIpcEndpointConfiguration.html" title="class in org.apache.ignite.igfs">IgfsIpcEndpointConfiguration</a>&nbsp;setPort(int&nbsp;port)</pre>
<div class="block">Sets the port endpoint is bound to.
<p>
For <a href="../../../../org/apache/ignite/igfs/IgfsIpcEndpointType.html#TCP"><code>IgfsIpcEndpointType.TCP</code></a> endpoint this is the port server socket is bound to.
<p>
For <a href="../../../../org/apache/ignite/igfs/IgfsIpcEndpointType.html#SHMEM"><code>IgfsIpcEndpointType.SHMEM</code></a> endpoint socket connection is needed only to perform an initial handshake.
All further communication is performed over shared memory.
<p>
Defaults to <a href="../../../../org/apache/ignite/igfs/IgfsIpcEndpointConfiguration.html#DFLT_PORT"><code>DFLT_PORT</code></a>.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>port</code> - Port.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd><code>this</code> for chaining.</dd>
</dl>
</li>
</ul>
<a name="getMemorySize--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getMemorySize</h4>
<pre>public&nbsp;int&nbsp;getMemorySize()</pre>
<div class="block">Gets shared memory size in bytes allocated for endpoint communication.
<p>
Ignored for <a href="../../../../org/apache/ignite/igfs/IgfsIpcEndpointType.html#TCP"><code>IgfsIpcEndpointType.TCP</code></a> endpoint.
<p>
Defaults to <a href="../../../../org/apache/ignite/igfs/IgfsIpcEndpointConfiguration.html#DFLT_MEM_SIZE"><code>DFLT_MEM_SIZE</code></a>.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Shared memory size.</dd>
</dl>
</li>
</ul>
<a name="setMemorySize-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setMemorySize</h4>
<pre>public&nbsp;<a href="../../../../org/apache/ignite/igfs/IgfsIpcEndpointConfiguration.html" title="class in org.apache.ignite.igfs">IgfsIpcEndpointConfiguration</a>&nbsp;setMemorySize(int&nbsp;memSize)</pre>
<div class="block">Sets shared memory size in bytes allocated for endpoint communication.
<p>
Ignored for <a href="../../../../org/apache/ignite/igfs/IgfsIpcEndpointType.html#TCP"><code>IgfsIpcEndpointType.TCP</code></a> endpoint.
<p>
Defaults to <a href="../../../../org/apache/ignite/igfs/IgfsIpcEndpointConfiguration.html#DFLT_MEM_SIZE"><code>DFLT_MEM_SIZE</code></a>.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>memSize</code> - Shared memory size.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd><code>this</code> for chaining.</dd>
</dl>
</li>
</ul>
<a name="getTokenDirectoryPath--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getTokenDirectoryPath</h4>
<pre>public&nbsp;<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;getTokenDirectoryPath()</pre>
<div class="block">Gets directory where shared memory tokens are stored.
<p>
Note that this path is relative to <code>IGNITE_HOME/work</code> folder if <code>IGNITE_HOME</code> system or environment
variable specified, otherwise it is relative to <code>work</code> folder under system <code>java.io.tmpdir</code> folder.
<p>
Ignored for <a href="../../../../org/apache/ignite/igfs/IgfsIpcEndpointType.html#TCP"><code>IgfsIpcEndpointType.TCP</code></a> endpoint.
<p>
Defaults to <a href="../../../../org/apache/ignite/igfs/IgfsIpcEndpointConfiguration.html#DFLT_TOKEN_DIR_PATH"><code>DFLT_TOKEN_DIR_PATH</code></a>.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Directory where shared memory tokens are stored.</dd>
</dl>
</li>
</ul>
<a name="setTokenDirectoryPath-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setTokenDirectoryPath</h4>
<pre>public&nbsp;<a href="../../../../org/apache/ignite/igfs/IgfsIpcEndpointConfiguration.html" title="class in org.apache.ignite.igfs">IgfsIpcEndpointConfiguration</a>&nbsp;setTokenDirectoryPath(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;tokenDirPath)</pre>
<div class="block">Sets directory where shared memory tokens are stored.
<p>
Note that this path is relative to <code>IGNITE_HOME/work</code> folder if <code>IGNITE_HOME</code> system or environment
variable specified, otherwise it is relative to <code>work</code> folder under system <code>java.io.tmpdir</code> folder.
<p>
Ignored for <a href="../../../../org/apache/ignite/igfs/IgfsIpcEndpointType.html#TCP"><code>IgfsIpcEndpointType.TCP</code></a> endpoint.
<p>
Defaults to <a href="../../../../org/apache/ignite/igfs/IgfsIpcEndpointConfiguration.html#DFLT_TOKEN_DIR_PATH"><code>DFLT_TOKEN_DIR_PATH</code></a>.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>tokenDirPath</code> - Directory where shared memory tokens are stored.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd><code>this</code> for chaining.</dd>
</dl>
</li>
</ul>
<a name="getThreadCount--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getThreadCount</h4>
<pre>public&nbsp;int&nbsp;getThreadCount()</pre>
<div class="block">Get number of threads used by this endpoint to process incoming requests.
<p>
Defaults to <a href="../../../../org/apache/ignite/igfs/IgfsIpcEndpointConfiguration.html#DFLT_THREAD_CNT"><code>DFLT_THREAD_CNT</code></a>.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Number of threads used by this endpoint to process incoming requests.</dd>
</dl>
</li>
</ul>
<a name="setThreadCount-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setThreadCount</h4>
<pre>public&nbsp;<a href="../../../../org/apache/ignite/igfs/IgfsIpcEndpointConfiguration.html" title="class in org.apache.ignite.igfs">IgfsIpcEndpointConfiguration</a>&nbsp;setThreadCount(int&nbsp;threadCnt)</pre>
<div class="block">Set number of threads used by this endpoint to process incoming requests.
<p>
See <a href="../../../../org/apache/ignite/igfs/IgfsIpcEndpointConfiguration.html#getThreadCount--"><code>getThreadCount()</code></a> for more information.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>threadCnt</code> - Number of threads used by this endpoint to process incoming requests.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd><code>this</code> for chaining.</dd>
</dl>
</li>
</ul>
<a name="toString--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>toString</h4>
<pre>public&nbsp;<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;toString()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a></code>&nbsp;in class&nbsp;<code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></dd>
</dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/IgfsIpcEndpointConfiguration.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../index-all.html">Index</a></li>
<li><a href="../../../../help-doc.html">Help</a></li>
</ul>
<div class="aboutLanguage">Ignite - In-Memory Data Fabric</div>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../org/apache/ignite/igfs/IgfsInvalidPathException.html" title="class in org.apache.ignite.igfs"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../org/apache/ignite/igfs/IgfsIpcEndpointType.html" title="enum in org.apache.ignite.igfs"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/ignite/igfs/IgfsIpcEndpointConfiguration.html" target="_top">Frames</a></li>
<li><a href="IgfsIpcEndpointConfiguration.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small><table width="100%" border="0" cellspacing=0 cellpadding=0 style="padding: 5px"> <tr> <td> <table style="padding-left: 0; margin: 0"> <tbody style="padding: 0; margin: 0"> <tr style="padding: 0; margin: 0"> <td> <a target=_blank href="https://ignite.apache.org"><nobr>2018 Copyright &#169; Apache Software Foundation</nobr></a> </td> </tr> </tbody> </table> </td> <td width="100%" align="right" valign="center"> <a href="https://twitter.com/ApacheIgnite" class="twitter-follow-button" data-show-count="false" data-size="large">Follow @ApacheIgnite</a> </td> </tr> <tr> <td colspan="2" valign="top" align="left"> <table style="padding-left: 0; margin: 0"> <tbody style="padding: 0; margin: 0"> <tr style="padding: 0; margin: 0"> <td> <b>Ignite Fabric</b> </td> <td>:&nbsp;&nbsp; ver. <strong>2.6.0</strong> </td> </tr> <tr style="padding: 0; margin: 0"> <td> <b>Release Date</b> </td> <td>:&nbsp;&nbsp; July 10 2018 </td> </tr> </tbody> </table> </td> </tr> </table></small></p>
</body>
</html>