| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc --> |
| <title>SystemMemberCacheServer (Apache Geode 1.15.1)</title> |
| <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> |
| <script type="text/javascript" src="../../../../script.js"></script> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="SystemMemberCacheServer (Apache Geode 1.15.1)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":38,"i1":38,"i2":38,"i3":38,"i4":38,"i5":38,"i6":38,"i7":38,"i8":38,"i9":38,"i10":38,"i11":38,"i12":38,"i13":38,"i14":38,"i15":38,"i16":38,"i17":38,"i18":38,"i19":38,"i20":38,"i21":38,"i22":38,"i23":38,"i24":38,"i25":38,"i26":38,"i27":38,"i28":38,"i29":38}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"],32:["t6","Deprecated 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="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> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../org/apache/geode/admin/SystemMemberCacheListener.html" title="interface in org.apache.geode.admin"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../org/apache/geode/admin/SystemMemberRegion.html" title="interface in org.apache.geode.admin"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/apache/geode/admin/SystemMemberCacheServer.html" target="_top">Frames</a></li> |
| <li><a href="SystemMemberCacheServer.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../allclasses-noframe.html">All 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: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </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.geode.admin</div> |
| <h2 title="Interface SystemMemberCacheServer" class="title">Interface SystemMemberCacheServer</h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <hr> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> |
| <div class="block"><span class="deprecationComment">as of 7.0 use the <code><a href= |
| "../../../../org/apache/geode/management/package-summary.html">management</a></code> |
| package instead</span></div> |
| </div> |
| <br> |
| <pre><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang">@Deprecated</a> |
| public interface <span class="typeNameLabel">SystemMemberCacheServer</span></pre> |
| <div class="block">Administrative interface that represents a <a href="../../../../org/apache/geode/cache/server/CacheServer.html" title="interface in org.apache.geode.cache.server"><code>CacheServer</code></a> that serves the contents of a system member's cache to clients.</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>GemFire 5.7</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../org/apache/geode/admin/SystemMemberCache.html#addCacheServer--"><code>SystemMemberCache.addCacheServer()</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========== 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"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </span></span><span id="t6" class="tableTab"><span><a href="javascript:show(32);">Deprecated Methods</a></span><span class="tabEnd"> </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="https://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/geode/admin/SystemMemberCacheServer.html#getBindAddress--">getBindAddress</a></span>()</code> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> |
| <div class="block">Returns a string representing the ip address or host name that this server will listen on.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code><a href="https://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/geode/admin/SystemMemberCacheServer.html#getGroups--">getGroups</a></span>()</code> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> |
| <div class="block">Returns the list of server groups that this cache server belongs to.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code><a href="https://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/geode/admin/SystemMemberCacheServer.html#getHostnameForClients--">getHostnameForClients</a></span>()</code> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> |
| <div class="block">Returns a string representing the ip address or host name that server locators will tell |
| clients that this server is listening on.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>long</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/admin/SystemMemberCacheServer.html#getLoadPollInterval--">getLoadPollInterval</a></span>()</code> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> |
| <div class="block">Get the frequency in milliseconds to poll the load probe on this cache server.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code><a href="https://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/geode/admin/SystemMemberCacheServer.html#getLoadProbe--">getLoadProbe</a></span>()</code> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> |
| <div class="block">Get a description of the load probe for this cache server.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/admin/SystemMemberCacheServer.html#getMaxConnections--">getMaxConnections</a></span>()</code> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> |
| <div class="block">Returns the maximum allowed client connections</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/admin/SystemMemberCacheServer.html#getMaximumMessageCount--">getMaximumMessageCount</a></span>()</code> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> |
| <div class="block">Returns the maximum number of messages that can be enqueued in a client-queue.</div> |
| </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/admin/SystemMemberCacheServer.html#getMaximumTimeBetweenPings--">getMaximumTimeBetweenPings</a></span>()</code> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> |
| <div class="block">Returns the maximum amount of time between client pings.</div> |
| </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/admin/SystemMemberCacheServer.html#getMaxThreads--">getMaxThreads</a></span>()</code> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> |
| <div class="block">Returns the maximum number of threads allowed in this server to service client requests.</div> |
| </td> |
| </tr> |
| <tr id="i9" class="rowColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/admin/SystemMemberCacheServer.html#getMessageTimeToLive--">getMessageTimeToLive</a></span>()</code> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> |
| <div class="block">Returns the time (in seconds ) after which a message in the client queue will expire.</div> |
| </td> |
| </tr> |
| <tr id="i10" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/admin/SystemMemberCacheServer.html#getNotifyBySubscription--">getNotifyBySubscription</a></span>()</code> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> |
| <div class="block">Answers whether or not this cache server should notify clients based on key subscription.</div> |
| </td> |
| </tr> |
| <tr id="i11" class="rowColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/admin/SystemMemberCacheServer.html#getPort--">getPort</a></span>()</code> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> |
| <div class="block">Returns the port on which this cache server listens for clients to connect.</div> |
| </td> |
| </tr> |
| <tr id="i12" class="altColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/admin/SystemMemberCacheServer.html#getSocketBufferSize--">getSocketBufferSize</a></span>()</code> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> |
| <div class="block">Returns the configured buffer size of the socket connection for this <code>CacheServer</code>.</div> |
| </td> |
| </tr> |
| <tr id="i13" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/admin/SystemMemberCacheServer.html#isRunning--">isRunning</a></span>()</code> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> |
| <div class="block">Returns whether or not this cache server is running</div> |
| </td> |
| </tr> |
| <tr id="i14" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/admin/SystemMemberCacheServer.html#refresh--">refresh</a></span>()</code> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> |
| <div class="block">Updates the information about this cache server.</div> |
| </td> |
| </tr> |
| <tr id="i15" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/admin/SystemMemberCacheServer.html#setBindAddress-java.lang.String-">setBindAddress</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> address)</code> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> |
| <div class="block">Sets the ip address or host name that this server is to listen on for client connections.</div> |
| </td> |
| </tr> |
| <tr id="i16" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/admin/SystemMemberCacheServer.html#setGroups-java.lang.String:A-">setGroups</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[] groups)</code> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> |
| <div class="block">Sets the list of server groups this cache server will belong to.</div> |
| </td> |
| </tr> |
| <tr id="i17" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/admin/SystemMemberCacheServer.html#setHostnameForClients-java.lang.String-">setHostnameForClients</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name)</code> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> |
| <div class="block">Sets the ip address or host name that this server is to listen on for client connections.</div> |
| </td> |
| </tr> |
| <tr id="i18" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/admin/SystemMemberCacheServer.html#setLoadPollInterval-long-">setLoadPollInterval</a></span>(long loadPollInterval)</code> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> |
| <div class="block">Set the frequency in milliseconds to poll the load probe on this cache server</div> |
| </td> |
| </tr> |
| <tr id="i19" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/admin/SystemMemberCacheServer.html#setLoadProbe-org.apache.geode.cache.server.ServerLoadProbe-">setLoadProbe</a></span>(<a href="../../../../org/apache/geode/cache/server/ServerLoadProbe.html" title="interface in org.apache.geode.cache.server">ServerLoadProbe</a> loadProbe)</code> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> |
| <div class="block">Set the load probe for this cache server.</div> |
| </td> |
| </tr> |
| <tr id="i20" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/admin/SystemMemberCacheServer.html#setMaxConnections-int-">setMaxConnections</a></span>(int maxCons)</code> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> |
| <div class="block">Sets the maximum number of client connections allowed.</div> |
| </td> |
| </tr> |
| <tr id="i21" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/admin/SystemMemberCacheServer.html#setMaximumMessageCount-int-">setMaximumMessageCount</a></span>(int maxMessageCount)</code> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> |
| <div class="block">Sets maximum number of messages that can be enqueued in a client-queue.</div> |
| </td> |
| </tr> |
| <tr id="i22" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/admin/SystemMemberCacheServer.html#setMaximumTimeBetweenPings-int-">setMaximumTimeBetweenPings</a></span>(int maximumTimeBetweenPings)</code> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> |
| <div class="block">Sets the maximum amount of time between client pings.</div> |
| </td> |
| </tr> |
| <tr id="i23" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/admin/SystemMemberCacheServer.html#setMaxThreads-int-">setMaxThreads</a></span>(int maxThreads)</code> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> |
| <div class="block">Sets the maximum number of threads allowed in this server to service client requests.</div> |
| </td> |
| </tr> |
| <tr id="i24" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/admin/SystemMemberCacheServer.html#setMessageTimeToLive-int-">setMessageTimeToLive</a></span>(int messageTimeToLive)</code> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> |
| <div class="block">Sets the time (in seconds) after which a message in the client queue will expire.</div> |
| </td> |
| </tr> |
| <tr id="i25" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/admin/SystemMemberCacheServer.html#setNotifyBySubscription-boolean-">setNotifyBySubscription</a></span>(boolean b)</code> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> |
| <div class="block">Sets whether or not this cache server should notify clients based on key subscription.</div> |
| </td> |
| </tr> |
| <tr id="i26" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/admin/SystemMemberCacheServer.html#setPort-int-">setPort</a></span>(int port)</code> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> |
| <div class="block">Sets the port on which this cache server listens for clients to connect.</div> |
| </td> |
| </tr> |
| <tr id="i27" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/admin/SystemMemberCacheServer.html#setSocketBufferSize-int-">setSocketBufferSize</a></span>(int socketBufferSize)</code> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> |
| <div class="block">Sets the buffer size in bytes of the socket connection for this <code>CacheServer</code>.</div> |
| </td> |
| </tr> |
| <tr id="i28" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/admin/SystemMemberCacheServer.html#start--">start</a></span>()</code> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> |
| <div class="block">Starts this cache server.</div> |
| </td> |
| </tr> |
| <tr id="i29" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/admin/SystemMemberCacheServer.html#stop--">stop</a></span>()</code> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> |
| <div class="block">Stops this cache server.</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="getPort--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getPort</h4> |
| <pre>int getPort()</pre> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> |
| <div class="block">Returns the port on which this cache server listens for clients to connect.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the port on which this cache server listens for clients to connect</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setPort-int-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setPort</h4> |
| <pre>void setPort(int port) |
| throws <a href="../../../../org/apache/geode/admin/AdminException.html" title="class in org.apache.geode.admin">AdminException</a></pre> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> |
| <div class="block">Sets the port on which this cache server listens for clients to connect.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>port</code> - the port on which this cache server listens for clients to connect</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../../org/apache/geode/admin/AdminException.html" title="class in org.apache.geode.admin">AdminException</a></code> - If this cache server is running</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="start--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>start</h4> |
| <pre>void start() |
| throws <a href="../../../../org/apache/geode/admin/AdminException.html" title="class in org.apache.geode.admin">AdminException</a></pre> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> |
| <div class="block">Starts this cache server. Once the server is running, its configuration cannot be changed.</div> |
| <dl> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../../org/apache/geode/admin/AdminException.html" title="class in org.apache.geode.admin">AdminException</a></code> - If an error occurs while starting the cache server</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="isRunning--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isRunning</h4> |
| <pre>boolean isRunning()</pre> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> |
| <div class="block">Returns whether or not this cache server is running</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>whether this cache server is running</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="stop--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>stop</h4> |
| <pre>void stop() |
| throws <a href="../../../../org/apache/geode/admin/AdminException.html" title="class in org.apache.geode.admin">AdminException</a></pre> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> |
| <div class="block">Stops this cache server. Note that the <code>CacheServer</code> can be reconfigured and |
| restarted if desired.</div> |
| <dl> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../../org/apache/geode/admin/AdminException.html" title="class in org.apache.geode.admin">AdminException</a></code> - if an exception is encountered when stopping the cache server</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="refresh--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>refresh</h4> |
| <pre>void refresh()</pre> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> |
| <div class="block">Updates the information about this cache server.</div> |
| </li> |
| </ul> |
| <a name="getBindAddress--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getBindAddress</h4> |
| <pre><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> getBindAddress()</pre> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> |
| <div class="block">Returns a string representing the ip address or host name that this server will listen on.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the ip address or host name that this server is to listen on</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>GemFire 5.7</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setBindAddress-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setBindAddress</h4> |
| <pre>void setBindAddress(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> address) |
| throws <a href="../../../../org/apache/geode/admin/AdminException.html" title="class in org.apache.geode.admin">AdminException</a></pre> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> |
| <div class="block">Sets the ip address or host name that this server is to listen on for client connections. |
| <p> |
| Setting a specific bind address will cause the cache server to always use this address and |
| ignore any address specified by "server-bind-address" or "bind-address" in the |
| <code>gemfire.properties</code> file (see |
| <a href="../../../../org/apache/geode/distributed/DistributedSystem.html" title="class in org.apache.geode.distributed"><code>DistributedSystem</code></a> for a description of these properties). |
| <p> |
| A <code>null</code> value will be treated the same as the default "". |
| <p> |
| The default value does not override the gemfire.properties. If you wish to override the |
| properties and want to have your server bind to all local addresses then use this string |
| <code>"0.0.0.0"</code>.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>address</code> - the ip address or host name that this server is to listen on</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../../org/apache/geode/admin/AdminException.html" title="class in org.apache.geode.admin">AdminException</a></code> - if this cache server is running</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>GemFire 5.7</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getHostnameForClients--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getHostnameForClients</h4> |
| <pre><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> getHostnameForClients()</pre> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> |
| <div class="block">Returns a string representing the ip address or host name that server locators will tell |
| clients that this server is listening on.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the ip address or host name to give to clients so they can connect to this server</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>GemFire 5.7</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setHostnameForClients-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setHostnameForClients</h4> |
| <pre>void setHostnameForClients(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name) |
| throws <a href="../../../../org/apache/geode/admin/AdminException.html" title="class in org.apache.geode.admin">AdminException</a></pre> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> |
| <div class="block">Sets the ip address or host name that this server is to listen on for client connections. |
| <p> |
| Setting a specific hostname-for-clients will cause server locators to use this value when |
| telling clients how to connect to this server. |
| <p> |
| The default value causes the bind-address to be given to clients |
| <p> |
| A <code>null</code> value will be treated the same as the default "".</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>name</code> - the ip address or host name that will be given to clients so they can connect to |
| this server</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../../org/apache/geode/admin/AdminException.html" title="class in org.apache.geode.admin">AdminException</a></code> - if this cache server is running</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>GemFire 5.7</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setNotifyBySubscription-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setNotifyBySubscription</h4> |
| <pre>void setNotifyBySubscription(boolean b) |
| throws <a href="../../../../org/apache/geode/admin/AdminException.html" title="class in org.apache.geode.admin">AdminException</a></pre> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> |
| <div class="block">Sets whether or not this cache server should notify clients based on key subscription. |
| |
| If false, then an update to any key on the server causes an update to be sent to all clients. |
| This update does not push the actual data to the clients. Instead, it causes the client to |
| locally invalidate or destroy the corresponding entry. The next time the client requests the |
| key, it goes to the cache server for the value. |
| |
| If true, then an update to any key on the server causes an update to be sent to only those |
| clients who have registered interest in that key. Other clients are not notified of the change. |
| In addition, the actual value is pushed to the client. The client does not need to request the |
| new value from the cache server.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>b</code> - whether this cache server should notify clients based on key subscription</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../../org/apache/geode/admin/AdminException.html" title="class in org.apache.geode.admin">AdminException</a></code> - if this cache server is running</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>GemFire 5.7</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getNotifyBySubscription--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getNotifyBySubscription</h4> |
| <pre>boolean getNotifyBySubscription()</pre> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> |
| <div class="block">Answers whether or not this cache server should notify clients based on key subscription.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>whether this cache server should notify clients based on key subscription</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>GemFire 5.7</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setSocketBufferSize-int-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setSocketBufferSize</h4> |
| <pre>void setSocketBufferSize(int socketBufferSize) |
| throws <a href="../../../../org/apache/geode/admin/AdminException.html" title="class in org.apache.geode.admin">AdminException</a></pre> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> |
| <div class="block">Sets the buffer size in bytes of the socket connection for this <code>CacheServer</code>. The |
| default is 32768 bytes.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>socketBufferSize</code> - The size in bytes of the socket buffer</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../../org/apache/geode/admin/AdminException.html" title="class in org.apache.geode.admin">AdminException</a></code> - if this cache server is running</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>GemFire 5.7</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getSocketBufferSize--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getSocketBufferSize</h4> |
| <pre>int getSocketBufferSize()</pre> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> |
| <div class="block">Returns the configured buffer size of the socket connection for this <code>CacheServer</code>. |
| The default is 32768 bytes.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the configured buffer size of the socket connection for this <code>CacheServer</code></dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>GemFire 5.7</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setMaximumTimeBetweenPings-int-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setMaximumTimeBetweenPings</h4> |
| <pre>void setMaximumTimeBetweenPings(int maximumTimeBetweenPings) |
| throws <a href="../../../../org/apache/geode/admin/AdminException.html" title="class in org.apache.geode.admin">AdminException</a></pre> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> |
| <div class="block">Sets the maximum amount of time between client pings. This value is used by the |
| <code>ClientHealthMonitor</code> to determine the health of this <code>CacheServer</code>'s |
| clients. The default is 60000 ms.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>maximumTimeBetweenPings</code> - The maximum amount of time between client pings</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../../org/apache/geode/admin/AdminException.html" title="class in org.apache.geode.admin">AdminException</a></code> - if this cache server is running</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>GemFire 5.7</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getMaximumTimeBetweenPings--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getMaximumTimeBetweenPings</h4> |
| <pre>int getMaximumTimeBetweenPings()</pre> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> |
| <div class="block">Returns the maximum amount of time between client pings. This value is used by the |
| <code>ClientHealthMonitor</code> to determine the health of this <code>CacheServer</code>'s |
| clients. The default is 60000 ms.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the maximum amount of time between client pings.</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>GemFire 5.7</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getMaxConnections--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getMaxConnections</h4> |
| <pre>int getMaxConnections()</pre> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> |
| <div class="block">Returns the maximum allowed client connections</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the maximum number of client connections allowed</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>GemFire 5.7</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setMaxConnections-int-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setMaxConnections</h4> |
| <pre>void setMaxConnections(int maxCons) |
| throws <a href="../../../../org/apache/geode/admin/AdminException.html" title="class in org.apache.geode.admin">AdminException</a></pre> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> |
| <div class="block">Sets the maximum number of client connections allowed. When the maximum is reached the server |
| will stop accepting connections.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>maxCons</code> - the maximum number of client connections allowed</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../../org/apache/geode/admin/AdminException.html" title="class in org.apache.geode.admin">AdminException</a></code> - if this cache server is running</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>GemFire 5.7</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getMaxThreads--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getMaxThreads</h4> |
| <pre>int getMaxThreads()</pre> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> |
| <div class="block">Returns the maximum number of threads allowed in this server to service client requests. The |
| default of <code>0</code> causes the server to dedicate a thread for every client connection.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the maximum number of threads allowed in this server to service client requests</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>GemFire 5.7</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setMaxThreads-int-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setMaxThreads</h4> |
| <pre>void setMaxThreads(int maxThreads) |
| throws <a href="../../../../org/apache/geode/admin/AdminException.html" title="class in org.apache.geode.admin">AdminException</a></pre> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> |
| <div class="block">Sets the maximum number of threads allowed in this server to service client requests. The |
| default of <code>0</code> causes the server to dedicate a thread for every client connection.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>maxThreads</code> - the maximum number of threads allowed in this server to service client |
| requests</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../../org/apache/geode/admin/AdminException.html" title="class in org.apache.geode.admin">AdminException</a></code> - if this cache server is running</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>GemFire 5.7</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getMaximumMessageCount--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getMaximumMessageCount</h4> |
| <pre>int getMaximumMessageCount()</pre> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> |
| <div class="block">Returns the maximum number of messages that can be enqueued in a client-queue.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>maximum number of messages that can be enqueued in a client-queue.</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>GemFire 5.7</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setMaximumMessageCount-int-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setMaximumMessageCount</h4> |
| <pre>void setMaximumMessageCount(int maxMessageCount) |
| throws <a href="../../../../org/apache/geode/admin/AdminException.html" title="class in org.apache.geode.admin">AdminException</a></pre> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> |
| <div class="block">Sets maximum number of messages that can be enqueued in a client-queue.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>maxMessageCount</code> - maximum number of messages that can be enqueued in a client-queue.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../../org/apache/geode/admin/AdminException.html" title="class in org.apache.geode.admin">AdminException</a></code> - if this cache server is running</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>GemFire 5.7</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getMessageTimeToLive--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getMessageTimeToLive</h4> |
| <pre>int getMessageTimeToLive()</pre> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> |
| <div class="block">Returns the time (in seconds ) after which a message in the client queue will expire.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the time (in seconds) after which a message in the client queue will expire</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>GemFire 5.7</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setMessageTimeToLive-int-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setMessageTimeToLive</h4> |
| <pre>void setMessageTimeToLive(int messageTimeToLive) |
| throws <a href="../../../../org/apache/geode/admin/AdminException.html" title="class in org.apache.geode.admin">AdminException</a></pre> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> |
| <div class="block">Sets the time (in seconds) after which a message in the client queue will expire.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>messageTimeToLive</code> - the time (in seconds) after which a message in the client queue will |
| expire</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../../org/apache/geode/admin/AdminException.html" title="class in org.apache.geode.admin">AdminException</a></code> - if this cache server is running</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>GemFire 5.7</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setGroups-java.lang.String:A-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setGroups</h4> |
| <pre>void setGroups(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[] groups) |
| throws <a href="../../../../org/apache/geode/admin/AdminException.html" title="class in org.apache.geode.admin">AdminException</a></pre> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> |
| <div class="block">Sets the list of server groups this cache server will belong to. By default cache servers |
| belong to the default global server group which all cache servers always belong to.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>groups</code> - possibly empty array of <code>String</code> where each string is a server groups |
| that this cache server will be a member of.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../../org/apache/geode/admin/AdminException.html" title="class in org.apache.geode.admin">AdminException</a></code> - if this cache server is running</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>GemFire 5.7</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getGroups--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getGroups</h4> |
| <pre><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[] getGroups()</pre> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> |
| <div class="block">Returns the list of server groups that this cache server belongs to.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a possibly empty array of <code>String</code>s where each string is a server group. |
| Modifying this array will not change the server groups that this cache server belongs |
| to.</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>GemFire 5.7</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getLoadProbe--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getLoadProbe</h4> |
| <pre><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> getLoadProbe()</pre> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> |
| <div class="block">Get a description of the load probe for this cache server. <a href="../../../../org/apache/geode/cache/server/ServerLoadProbe.html" title="interface in org.apache.geode.cache.server"><code>ServerLoadProbe</code></a> for details |
| on the load probe.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the load probe used by this cache server.</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>GemFire 5.7</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setLoadProbe-org.apache.geode.cache.server.ServerLoadProbe-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setLoadProbe</h4> |
| <pre>void setLoadProbe(<a href="../../../../org/apache/geode/cache/server/ServerLoadProbe.html" title="interface in org.apache.geode.cache.server">ServerLoadProbe</a> loadProbe) |
| throws <a href="../../../../org/apache/geode/admin/AdminException.html" title="class in org.apache.geode.admin">AdminException</a></pre> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> |
| <div class="block">Set the load probe for this cache server. See <a href="../../../../org/apache/geode/cache/server/ServerLoadProbe.html" title="interface in org.apache.geode.cache.server"><code>ServerLoadProbe</code></a> for details on how to |
| implement a load probe. |
| |
| The load probe should implement DataSerializable if it is used with this interface, because it |
| will be sent to the remote VM.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>loadProbe</code> - the load probe to use for this cache server.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../../org/apache/geode/admin/AdminException.html" title="class in org.apache.geode.admin">AdminException</a></code> - if the cache server is running</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>GemFire 5.7</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getLoadPollInterval--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getLoadPollInterval</h4> |
| <pre>long getLoadPollInterval()</pre> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> |
| <div class="block">Get the frequency in milliseconds to poll the load probe on this cache server.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the frequency in milliseconds that we will poll the load probe.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setLoadPollInterval-long-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>setLoadPollInterval</h4> |
| <pre>void setLoadPollInterval(long loadPollInterval) |
| throws <a href="../../../../org/apache/geode/admin/AdminException.html" title="class in org.apache.geode.admin">AdminException</a></pre> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> |
| <div class="block">Set the frequency in milliseconds to poll the load probe on this cache server</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>loadPollInterval</code> - the frequency in milliseconds to poll the load probe. Must be greater |
| than 0.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../../org/apache/geode/admin/AdminException.html" title="class in org.apache.geode.admin">AdminException</a></code> - if the cache server is running</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="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> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../org/apache/geode/admin/SystemMemberCacheListener.html" title="interface in org.apache.geode.admin"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../org/apache/geode/admin/SystemMemberRegion.html" title="interface in org.apache.geode.admin"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/apache/geode/admin/SystemMemberCacheServer.html" target="_top">Frames</a></li> |
| <li><a href="SystemMemberCacheServer.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../allclasses-noframe.html">All 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: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </body> |
| </html> |