| <!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>CacheServer (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="CacheServer (Apache Geode 1.15.1)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":38,"i6":6,"i7":6,"i8":6,"i9":6,"i10":6,"i11":6,"i12":6,"i13":6,"i14":6,"i15":38,"i16":6,"i17":6,"i18":6,"i19":6,"i20":6,"i21":6,"i22":38,"i23":6,"i24":6,"i25":6,"i26":6,"i27":6,"i28":6,"i29":6,"i30":6,"i31":38,"i32":6,"i33":6,"i34":6,"i35":6,"i36":6,"i37":6}; |
| 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>Prev Class</li> |
| <li><a href="../../../../../org/apache/geode/cache/server/ClientSubscriptionConfig.html" title="interface in org.apache.geode.cache.server"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/geode/cache/server/CacheServer.html" target="_top">Frames</a></li> |
| <li><a href="CacheServer.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><a href="#field.summary">Field</a> | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li><a href="#field.detail">Field</a> | </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.cache.server</div> |
| <h2 title="Interface CacheServer" class="title">Interface CacheServer</h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <hr> |
| <br> |
| <pre>public interface <span class="typeNameLabel">CacheServer</span></pre> |
| <div class="block">A cache server that serves the contents of a <code>Cache</code> to client VMs in another |
| distributed system via a socket. A cache server is used in conjunction with a client <a href="../../../../../org/apache/geode/cache/client/Pool.html" title="interface in org.apache.geode.cache.client"><code>Pool</code></a> |
| to connect two regions that reside in different distributed systems.</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/cache/Cache.html#addCacheServer--"><code>Cache.addCacheServer()</code></a>, |
| <a href="../../../../../org/apache/geode/cache/Cache.html#getCacheServers--"><code>Cache.getCacheServers()</code></a></dd> |
| </dl> |
| </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"> </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="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/cache/server/CacheServer.html#DEFAULT_BIND_ADDRESS">DEFAULT_BIND_ADDRESS</a></span></code> |
| <div class="block">The default ip address or host name that the cache server's socket will listen on for client |
| connections.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static <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/cache/server/CacheServer.html#DEFAULT_GROUPS">DEFAULT_GROUPS</a></span></code> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> |
| <div class="block"><span class="deprecationComment">as of 7.0 use the groups gemfire property</span></div> |
| </div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static <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/cache/server/CacheServer.html#DEFAULT_HOSTNAME_FOR_CLIENTS">DEFAULT_HOSTNAME_FOR_CLIENTS</a></span></code> |
| <div class="block">The default ip address or host name that will be given to clients as the host this cache server |
| is listening on.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static long</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/geode/cache/server/CacheServer.html#DEFAULT_LOAD_POLL_INTERVAL">DEFAULT_LOAD_POLL_INTERVAL</a></span></code> |
| <div class="block">The default frequency at which to poll the load probe for the load on this cache server.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static <a href="../../../../../org/apache/geode/cache/server/ServerLoadProbe.html" title="interface in org.apache.geode.cache.server">ServerLoadProbe</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/geode/cache/server/CacheServer.html#DEFAULT_LOAD_PROBE">DEFAULT_LOAD_PROBE</a></span></code> |
| <div class="block">The default load balancing probe.</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/geode/cache/server/CacheServer.html#DEFAULT_MAX_CONNECTIONS">DEFAULT_MAX_CONNECTIONS</a></span></code> |
| <div class="block">The default number of sockets accepted by a CacheServer.</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/geode/cache/server/CacheServer.html#DEFAULT_MAX_THREADS">DEFAULT_MAX_THREADS</a></span></code> |
| <div class="block">The default limit to the maximum number of cache server threads that can be created to service |
| client requests.</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/geode/cache/server/CacheServer.html#DEFAULT_MAXIMUM_MESSAGE_COUNT">DEFAULT_MAXIMUM_MESSAGE_COUNT</a></span></code> |
| <div class="block">The default maximum number of messages that can be enqueued in a client-queue.</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/geode/cache/server/CacheServer.html#DEFAULT_MAXIMUM_TIME_BETWEEN_PINGS">DEFAULT_MAXIMUM_TIME_BETWEEN_PINGS</a></span></code> |
| <div class="block">The default maximum amount of time between client pings.</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/geode/cache/server/CacheServer.html#DEFAULT_MESSAGE_TIME_TO_LIVE">DEFAULT_MESSAGE_TIME_TO_LIVE</a></span></code> |
| <div class="block">The default time (in seconds ) after which a message in the client queue will expire.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/geode/cache/server/CacheServer.html#DEFAULT_NOTIFY_BY_SUBSCRIPTION">DEFAULT_NOTIFY_BY_SUBSCRIPTION</a></span></code> |
| <div class="block">The default notify-by-subscription value which tells the <Code>CacheServer</code> whether or |
| not to notify clients based on key subscription.</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/geode/cache/server/CacheServer.html#DEFAULT_PORT">DEFAULT_PORT</a></span></code> |
| <div class="block">The default port on which a <Code>CacheServer</code> is configured to serve.</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/geode/cache/server/CacheServer.html#DEFAULT_SOCKET_BUFFER_SIZE">DEFAULT_SOCKET_BUFFER_SIZE</a></span></code> |
| <div class="block">The default socket buffer size for socket buffers from the cache server to the client.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/geode/cache/server/CacheServer.html#DEFAULT_TCP_NO_DELAY">DEFAULT_TCP_NO_DELAY</a></span></code> |
| <div class="block">The default setting for outgoing tcp/ip connections.</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"> </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/util/Set.html?is-external=true" title="class or interface in java.util">Set</a><<a href="../../../../../org/apache/geode/cache/ClientSession.html" title="interface in org.apache.geode.cache">ClientSession</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/geode/cache/server/CacheServer.html#getAllClientSessions--">getAllClientSessions</a></span>()</code> |
| <div class="block">Returns a set of all <code>ClientSession</code>s</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/cache/server/CacheServer.html#getBindAddress--">getBindAddress</a></span>()</code> |
| <div class="block">Returns a string representing the ip address or host name that this cache server will listen |
| on.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/geode/cache/ClientSession.html" title="interface in org.apache.geode.cache">ClientSession</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/geode/cache/server/CacheServer.html#getClientSession-org.apache.geode.distributed.DistributedMember-">getClientSession</a></span>(<a href="../../../../../org/apache/geode/distributed/DistributedMember.html" title="interface in org.apache.geode.distributed">DistributedMember</a> member)</code> |
| <div class="block">Returns the <code>ClientSession</code> associated with the <code>DistributedMember</code></div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/geode/cache/ClientSession.html" title="interface in org.apache.geode.cache">ClientSession</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/geode/cache/server/CacheServer.html#getClientSession-java.lang.String-">getClientSession</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> durableClientId)</code> |
| <div class="block">Returns the <code>ClientSession</code> associated with the durable client id</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/geode/cache/server/ClientSubscriptionConfig.html" title="interface in org.apache.geode.cache.server">ClientSubscriptionConfig</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/geode/cache/server/CacheServer.html#getClientSubscriptionConfig--">getClientSubscriptionConfig</a></span>()</code> |
| <div class="block">Get the ClientSubscriptionConfig for this cache server.</div> |
| </td> |
| </tr> |
| <tr id="i5" 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/cache/server/CacheServer.html#getGroups--">getGroups</a></span>()</code> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> |
| <div class="block"><span class="deprecationComment">as of 7.0 use the groups gemfire property</span></div> |
| </div> |
| </td> |
| </tr> |
| <tr id="i6" 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/cache/server/CacheServer.html#getHostnameForClients--">getHostnameForClients</a></span>()</code> |
| <div class="block">Returns a string representing the ip address or host name that server locators will tell |
| clients that this cache server is listening on.</div> |
| </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a><<a href="../../../../../org/apache/geode/cache/InterestRegistrationListener.html" title="interface in org.apache.geode.cache">InterestRegistrationListener</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/geode/cache/server/CacheServer.html#getInterestRegistrationListeners--">getInterestRegistrationListeners</a></span>()</code> |
| <div class="block">Returns a read-only set of <code>InterestRegistrationListener</code>s registered with this |
| notifier.</div> |
| </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code>long</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/geode/cache/server/CacheServer.html#getLoadPollInterval--">getLoadPollInterval</a></span>()</code> |
| <div class="block">Get the frequency in milliseconds to poll the load probe on this cache server.</div> |
| </td> |
| </tr> |
| <tr id="i9" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/geode/cache/server/ServerLoadProbe.html" title="interface in org.apache.geode.cache.server">ServerLoadProbe</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/geode/cache/server/CacheServer.html#getLoadProbe--">getLoadProbe</a></span>()</code> |
| <div class="block">Get the load probe for this cache server.</div> |
| </td> |
| </tr> |
| <tr id="i10" class="altColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/geode/cache/server/CacheServer.html#getMaxConnections--">getMaxConnections</a></span>()</code> |
| <div class="block">Returns the maximum allowed client connections</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/cache/server/CacheServer.html#getMaximumMessageCount--">getMaximumMessageCount</a></span>()</code> |
| <div class="block">Returns the maximum number of messages that can be enqueued in a client-queue.</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/cache/server/CacheServer.html#getMaximumTimeBetweenPings--">getMaximumTimeBetweenPings</a></span>()</code> |
| <div class="block">Returns the maximum amount of time between client pings.</div> |
| </td> |
| </tr> |
| <tr id="i13" class="rowColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/geode/cache/server/CacheServer.html#getMaxThreads--">getMaxThreads</a></span>()</code> |
| <div class="block">Returns the maximum number of threads allowed in this cache server to service client requests.</div> |
| </td> |
| </tr> |
| <tr id="i14" class="altColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/geode/cache/server/CacheServer.html#getMessageTimeToLive--">getMessageTimeToLive</a></span>()</code> |
| <div class="block">Returns the time (in seconds ) after which a message in the client queue will expire.</div> |
| </td> |
| </tr> |
| <tr id="i15" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/geode/cache/server/CacheServer.html#getNotifyBySubscription--">getNotifyBySubscription</a></span>()</code> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> |
| <div class="block"><span class="deprecationComment">as of 6.0.1. This method is no more in use, by default notifyBySubscription |
| attribute is set to true.</span></div> |
| </div> |
| </td> |
| </tr> |
| <tr id="i16" class="altColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/geode/cache/server/CacheServer.html#getPort--">getPort</a></span>()</code> |
| <div class="block">Returns the port on which this cache server listens for clients.</div> |
| </td> |
| </tr> |
| <tr id="i17" class="rowColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/geode/cache/server/CacheServer.html#getSocketBufferSize--">getSocketBufferSize</a></span>()</code> |
| <div class="block">Returns the configured buffer size of the socket connection for this <code>CacheServer</code>.</div> |
| </td> |
| </tr> |
| <tr id="i18" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/geode/cache/server/CacheServer.html#getTcpNoDelay--">getTcpNoDelay</a></span>()</code> |
| <div class="block">Get the outgoing connection tcp-no-delay setting.</div> |
| </td> |
| </tr> |
| <tr id="i19" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/geode/cache/server/CacheServer.html#isRunning--">isRunning</a></span>()</code> |
| <div class="block">Returns whether this cache server is running</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/cache/server/CacheServer.html#registerInterestRegistrationListener-org.apache.geode.cache.InterestRegistrationListener-">registerInterestRegistrationListener</a></span>(<a href="../../../../../org/apache/geode/cache/InterestRegistrationListener.html" title="interface in org.apache.geode.cache">InterestRegistrationListener</a> listener)</code> |
| <div class="block">Registers a new <code>InterestRegistrationListener</code> with the set of |
| <code>InterestRegistrationListener</code>s.</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/cache/server/CacheServer.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">Sets the ip address or host name that this cache server is to listen on for client connections.</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/cache/server/CacheServer.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 class="block"><span class="deprecationComment">as of 7.0 use the groups gemfire property</span></div> |
| </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/cache/server/CacheServer.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">Sets the ip address or host name that this cache server is to listen on for client connections.</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/cache/server/CacheServer.html#setLoadPollInterval-long-">setLoadPollInterval</a></span>(long loadPollInterval)</code> |
| <div class="block">Set the frequency in milliseconds to poll the load probe on this cache server</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/cache/server/CacheServer.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">Set the load probe for this cache server.</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/cache/server/CacheServer.html#setMaxConnections-int-">setMaxConnections</a></span>(int maxCons)</code> |
| <div class="block">Sets the maximum number of client connections allowed.</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/cache/server/CacheServer.html#setMaximumMessageCount-int-">setMaximumMessageCount</a></span>(int maxMessageCount)</code> |
| <div class="block">Sets maximum number of messages that can be enqueued in a client-queue.</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/cache/server/CacheServer.html#setMaximumTimeBetweenPings-int-">setMaximumTimeBetweenPings</a></span>(int maximumTimeBetweenPings)</code> |
| <div class="block">Sets the maximum amount of time between client pings.</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/cache/server/CacheServer.html#setMaxThreads-int-">setMaxThreads</a></span>(int maxThreads)</code> |
| <div class="block">Sets the maximum number of threads allowed in this cache server to service client requests.</div> |
| </td> |
| </tr> |
| <tr id="i30" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/geode/cache/server/CacheServer.html#setMessageTimeToLive-int-">setMessageTimeToLive</a></span>(int messageTimeToLive)</code> |
| <div class="block">Sets the time (in seconds ) after which a message in the client queue will expire.</div> |
| </td> |
| </tr> |
| <tr id="i31" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/geode/cache/server/CacheServer.html#setNotifyBySubscription-boolean-">setNotifyBySubscription</a></span>(boolean b)</code> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> |
| <div class="block"><span class="deprecationComment">as of 6.0.1. This method is no longer in use, by default notifyBySubscription |
| attribute is set to true.</span></div> |
| </div> |
| </td> |
| </tr> |
| <tr id="i32" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/geode/cache/server/CacheServer.html#setPort-int-">setPort</a></span>(int port)</code> |
| <div class="block">Sets the port on which this cache server listens for clients.</div> |
| </td> |
| </tr> |
| <tr id="i33" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/geode/cache/server/CacheServer.html#setSocketBufferSize-int-">setSocketBufferSize</a></span>(int socketBufferSize)</code> |
| <div class="block">Sets the buffer size in bytes of the socket connection for this <code>CacheServer</code>.</div> |
| </td> |
| </tr> |
| <tr id="i34" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/geode/cache/server/CacheServer.html#setTcpNoDelay-boolean-">setTcpNoDelay</a></span>(boolean noDelay)</code> |
| <div class="block">Configures the tcpNoDelay setting of sockets used to send messages to clients.</div> |
| </td> |
| </tr> |
| <tr id="i35" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/geode/cache/server/CacheServer.html#start--">start</a></span>()</code> |
| <div class="block">Starts this cache server.</div> |
| </td> |
| </tr> |
| <tr id="i36" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/geode/cache/server/CacheServer.html#stop--">stop</a></span>()</code> |
| <div class="block">Stops this cache server.</div> |
| </td> |
| </tr> |
| <tr id="i37" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/geode/cache/server/CacheServer.html#unregisterInterestRegistrationListener-org.apache.geode.cache.InterestRegistrationListener-">unregisterInterestRegistrationListener</a></span>(<a href="../../../../../org/apache/geode/cache/InterestRegistrationListener.html" title="interface in org.apache.geode.cache">InterestRegistrationListener</a> listener)</code> |
| <div class="block">Unregisters an existing <code>InterestRegistrationListener</code> from the set of |
| <code>InterestRegistrationListener</code>s.</div> |
| </td> |
| </tr> |
| </table> |
| </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="DEFAULT_PORT"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>DEFAULT_PORT</h4> |
| <pre>static final int DEFAULT_PORT</pre> |
| <div class="block">The default port on which a <Code>CacheServer</code> is configured to serve.</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../constant-values.html#org.apache.geode.cache.server.CacheServer.DEFAULT_PORT">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="DEFAULT_MAX_CONNECTIONS"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>DEFAULT_MAX_CONNECTIONS</h4> |
| <pre>static final int DEFAULT_MAX_CONNECTIONS</pre> |
| <div class="block">The default number of sockets accepted by a CacheServer. When the maximum is reached the cache |
| server will stop accepting new connections. Current value: 800</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="../../../../../constant-values.html#org.apache.geode.cache.server.CacheServer.DEFAULT_MAX_CONNECTIONS">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="DEFAULT_MAX_THREADS"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>DEFAULT_MAX_THREADS</h4> |
| <pre>static final int DEFAULT_MAX_THREADS</pre> |
| <div class="block">The default limit to the maximum number of cache server threads that can be created to service |
| client requests. Once this number of threads exist then connections must share the same thread |
| to service their request. A selector is used to detect client connection requests and dispatch |
| them to the thread pool. The default of <code>0</code> causes a thread to be bound to every |
| connection and to be dedicated to detecting client requests on that connection. A selector is |
| not used in this default mode. Current value: 0</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="../../../../../constant-values.html#org.apache.geode.cache.server.CacheServer.DEFAULT_MAX_THREADS">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="DEFAULT_NOTIFY_BY_SUBSCRIPTION"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>DEFAULT_NOTIFY_BY_SUBSCRIPTION</h4> |
| <pre>static final boolean DEFAULT_NOTIFY_BY_SUBSCRIPTION</pre> |
| <div class="block">The default notify-by-subscription value which tells the <Code>CacheServer</code> whether or |
| not to notify clients based on key subscription.</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../constant-values.html#org.apache.geode.cache.server.CacheServer.DEFAULT_NOTIFY_BY_SUBSCRIPTION">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="DEFAULT_SOCKET_BUFFER_SIZE"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>DEFAULT_SOCKET_BUFFER_SIZE</h4> |
| <pre>static final int DEFAULT_SOCKET_BUFFER_SIZE</pre> |
| <div class="block">The default socket buffer size for socket buffers from the cache server to the client.</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../constant-values.html#org.apache.geode.cache.server.CacheServer.DEFAULT_SOCKET_BUFFER_SIZE">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="DEFAULT_MAXIMUM_TIME_BETWEEN_PINGS"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>DEFAULT_MAXIMUM_TIME_BETWEEN_PINGS</h4> |
| <pre>static final int DEFAULT_MAXIMUM_TIME_BETWEEN_PINGS</pre> |
| <div class="block">The default 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.</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../constant-values.html#org.apache.geode.cache.server.CacheServer.DEFAULT_MAXIMUM_TIME_BETWEEN_PINGS">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="DEFAULT_MAXIMUM_MESSAGE_COUNT"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>DEFAULT_MAXIMUM_MESSAGE_COUNT</h4> |
| <pre>static final int DEFAULT_MAXIMUM_MESSAGE_COUNT</pre> |
| <div class="block">The default maximum number of messages that can be enqueued in a client-queue.</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../constant-values.html#org.apache.geode.cache.server.CacheServer.DEFAULT_MAXIMUM_MESSAGE_COUNT">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="DEFAULT_MESSAGE_TIME_TO_LIVE"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>DEFAULT_MESSAGE_TIME_TO_LIVE</h4> |
| <pre>static final int DEFAULT_MESSAGE_TIME_TO_LIVE</pre> |
| <div class="block">The default time (in seconds ) after which a message in the client queue will expire.</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../constant-values.html#org.apache.geode.cache.server.CacheServer.DEFAULT_MESSAGE_TIME_TO_LIVE">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="DEFAULT_GROUPS"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>DEFAULT_GROUPS</h4> |
| <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> |
| <a href="../../../../../org/apache/geode/annotations/Immutable.html" title="annotation in org.apache.geode.annotations">@Immutable</a> |
| static final <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>[] DEFAULT_GROUPS</pre> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> <span class="deprecationComment">as of 7.0 use the groups gemfire property</span></div> |
| <div class="block">The default list of server groups a cache server belongs to. The current default is an empty |
| list.</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>GemFire 5.7</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="DEFAULT_LOAD_PROBE"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>DEFAULT_LOAD_PROBE</h4> |
| <pre><a href="../../../../../org/apache/geode/annotations/Immutable.html" title="annotation in org.apache.geode.annotations">@Immutable</a> |
| static final <a href="../../../../../org/apache/geode/cache/server/ServerLoadProbe.html" title="interface in org.apache.geode.cache.server">ServerLoadProbe</a> DEFAULT_LOAD_PROBE</pre> |
| <div class="block">The default load balancing probe. The default load balancing probe reports the connections |
| counts of this cache server.</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>GemFire 5.7</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="DEFAULT_LOAD_POLL_INTERVAL"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>DEFAULT_LOAD_POLL_INTERVAL</h4> |
| <pre>static final long DEFAULT_LOAD_POLL_INTERVAL</pre> |
| <div class="block">The default frequency at which to poll the load probe for the load on this cache server. |
| Defaults to 5000 (5 seconds).</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="../../../../../constant-values.html#org.apache.geode.cache.server.CacheServer.DEFAULT_LOAD_POLL_INTERVAL">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="DEFAULT_BIND_ADDRESS"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>DEFAULT_BIND_ADDRESS</h4> |
| <pre>static final <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> DEFAULT_BIND_ADDRESS</pre> |
| <div class="block">The default ip address or host name that the cache server's socket will listen on for client |
| connections. The current default is an empty string.</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="../../../../../constant-values.html#org.apache.geode.cache.server.CacheServer.DEFAULT_BIND_ADDRESS">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="DEFAULT_HOSTNAME_FOR_CLIENTS"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>DEFAULT_HOSTNAME_FOR_CLIENTS</h4> |
| <pre>static final <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> DEFAULT_HOSTNAME_FOR_CLIENTS</pre> |
| <div class="block">The default ip address or host name that will be given to clients as the host this cache server |
| is listening on. The current default is an empty string.</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="../../../../../constant-values.html#org.apache.geode.cache.server.CacheServer.DEFAULT_HOSTNAME_FOR_CLIENTS">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="DEFAULT_TCP_NO_DELAY"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>DEFAULT_TCP_NO_DELAY</h4> |
| <pre>static final boolean DEFAULT_TCP_NO_DELAY</pre> |
| <div class="block">The default setting for outgoing tcp/ip connections. By default the product enables tcpNoDelay.</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../constant-values.html#org.apache.geode.cache.server.CacheServer.DEFAULT_TCP_NO_DELAY">Constant Field Values</a></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="getPort--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getPort</h4> |
| <pre>int getPort()</pre> |
| <div class="block">Returns the port on which this cache server listens for clients.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the port on which this cache server listens for clients</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setPort-int-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setPort</h4> |
| <pre>void setPort(int port)</pre> |
| <div class="block">Sets the port on which this cache server listens for clients.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>port</code> - the port on which this cache server listens for clients</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalStateException.html?is-external=true" title="class or interface in java.lang">IllegalStateException</a></code> - If this cache server is running</dd> |
| </dl> |
| </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">Returns a string representing the ip address or host name that this cache server will listen |
| on.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the ip address or host name that this cache server is to listen on</dd> |
| <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/cache/server/CacheServer.html#DEFAULT_BIND_ADDRESS"><code>DEFAULT_BIND_ADDRESS</code></a></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)</pre> |
| <div class="block">Sets the ip address or host name that this cache 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> |
| The value <code>""</code> does not override the <code>gemfire.properties</code>. It will cause |
| the local machine's default address to be listened on if the properties file does not specify |
| and address. If you wish to override the properties and want to have your cache server bind to |
| all local addresses then use this bind address <code>"0.0.0.0"</code>. |
| <p> |
| A <code>null</code> value will be treated the same as the default <code>""</code>.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>address</code> - the ip address or host name that this cache server is to listen on</dd> |
| <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/cache/server/CacheServer.html#DEFAULT_BIND_ADDRESS"><code>DEFAULT_BIND_ADDRESS</code></a></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">Returns a string representing the ip address or host name that server locators will tell |
| clients that this cache 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 cache server</dd> |
| <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/cache/server/CacheServer.html#DEFAULT_HOSTNAME_FOR_CLIENTS"><code>DEFAULT_HOSTNAME_FOR_CLIENTS</code></a></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)</pre> |
| <div class="block">Sets the ip address or host name that this cache 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 cache server. This is useful in the case where the cache |
| server may refer to itself with one hostname, but the clients need to use a different hostname |
| to find the cache server. |
| <p> |
| The value <code>""</code> causes the <code>bind-address</code> to be given to clients. |
| <p> |
| A <code>null</code> value will be treated the same as the default <code>""</code>.</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 cache server</dd> |
| <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/cache/server/CacheServer.html#DEFAULT_HOSTNAME_FOR_CLIENTS"><code>DEFAULT_HOSTNAME_FOR_CLIENTS</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setNotifyBySubscription-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setNotifyBySubscription</h4> |
| <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> |
| void setNotifyBySubscription(boolean b)</pre> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> <span class="deprecationComment">as of 6.0.1. This method is no longer in use, by default notifyBySubscription |
| attribute is set to true.</span></div> |
| <div class="block">Sets whether this cache server should notify clients based on key subscription. |
| |
| If false, then an update to any key on the cache 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 cache 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="simpleTagLabel">Since:</span></dt> |
| <dd>GemFire 4.2</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getNotifyBySubscription--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getNotifyBySubscription</h4> |
| <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> |
| boolean getNotifyBySubscription()</pre> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> <span class="deprecationComment">as of 6.0.1. This method is no more in use, by default notifyBySubscription |
| attribute is set to true.</span></div> |
| <div class="block">Answers whether 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 4.2</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setSocketBufferSize-int-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setSocketBufferSize</h4> |
| <pre>void setSocketBufferSize(int socketBufferSize)</pre> |
| <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="simpleTagLabel">Since:</span></dt> |
| <dd>GemFire 4.2.1</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getSocketBufferSize--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getSocketBufferSize</h4> |
| <pre>int getSocketBufferSize()</pre> |
| <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 4.2.1</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setMaximumTimeBetweenPings-int-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setMaximumTimeBetweenPings</h4> |
| <pre>void setMaximumTimeBetweenPings(int maximumTimeBetweenPings)</pre> |
| <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="simpleTagLabel">Since:</span></dt> |
| <dd>GemFire 4.2.3</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getMaximumTimeBetweenPings--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getMaximumTimeBetweenPings</h4> |
| <pre>int getMaximumTimeBetweenPings()</pre> |
| <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 4.2.3</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="start--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>start</h4> |
| <pre>void start() |
| throws <a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre> |
| <div class="block">Starts this cache server. Once the cache server is running, its configuration cannot be |
| changed.</div> |
| <dl> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</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">Returns whether 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()</pre> |
| <div class="block">Stops this cache server. Note that the <code>CacheServer</code> can be reconfigured and |
| restarted if desired.</div> |
| </li> |
| </ul> |
| <a name="getMaxConnections--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getMaxConnections</h4> |
| <pre>int getMaxConnections()</pre> |
| <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> |
| </dl> |
| </li> |
| </ul> |
| <a name="setMaxConnections-int-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setMaxConnections</h4> |
| <pre>void setMaxConnections(int maxCons)</pre> |
| <div class="block">Sets the maximum number of client connections allowed. When the maximum is reached the cache |
| 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="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../org/apache/geode/cache/server/CacheServer.html#DEFAULT_MAX_CONNECTIONS"><code>DEFAULT_MAX_CONNECTIONS</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getMaxThreads--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getMaxThreads</h4> |
| <pre>int getMaxThreads()</pre> |
| <div class="block">Returns the maximum number of threads allowed in this cache server to service client requests. |
| The default of <code>0</code> causes the cache 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 cache server to service client requests</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>GemFire 5.1</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setMaxThreads-int-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setMaxThreads</h4> |
| <pre>void setMaxThreads(int maxThreads)</pre> |
| <div class="block">Sets the maximum number of threads allowed in this cache server to service client requests. The |
| default of <code>0</code> causes the cache 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 cache server to service client |
| requests</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>GemFire 5.1</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../org/apache/geode/cache/server/CacheServer.html#DEFAULT_MAX_THREADS"><code>DEFAULT_MAX_THREADS</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getMaximumMessageCount--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getMaximumMessageCount</h4> |
| <pre>int getMaximumMessageCount()</pre> |
| <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>the maximum number of messages that can be enqueued in a client-queue</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setMaximumMessageCount-int-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setMaximumMessageCount</h4> |
| <pre>void setMaximumMessageCount(int maxMessageCount)</pre> |
| <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> - the maximum number of messages that can be enqueued in a client-queue</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../org/apache/geode/cache/server/CacheServer.html#DEFAULT_MAXIMUM_MESSAGE_COUNT"><code>DEFAULT_MAXIMUM_MESSAGE_COUNT</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getMessageTimeToLive--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getMessageTimeToLive</h4> |
| <pre>int getMessageTimeToLive()</pre> |
| <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> |
| </dl> |
| </li> |
| </ul> |
| <a name="setMessageTimeToLive-int-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setMessageTimeToLive</h4> |
| <pre>void setMessageTimeToLive(int messageTimeToLive)</pre> |
| <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="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../org/apache/geode/cache/server/CacheServer.html#DEFAULT_MESSAGE_TIME_TO_LIVE"><code>DEFAULT_MESSAGE_TIME_TO_LIVE</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setGroups-java.lang.String:A-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setGroups</h4> |
| <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> |
| 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)</pre> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> <span class="deprecationComment">as of 7.0 use the groups gemfire property</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="simpleTagLabel">Since:</span></dt> |
| <dd>GemFire 5.7</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../org/apache/geode/cache/server/CacheServer.html#DEFAULT_GROUPS"><code>DEFAULT_GROUPS</code></a></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/Deprecated.html?is-external=true" title="class or interface in java.lang">@Deprecated</a> |
| <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> <span class="deprecationComment">as of 7.0 use the groups gemfire property</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="../../../../../org/apache/geode/cache/server/ServerLoadProbe.html" title="interface in org.apache.geode.cache.server">ServerLoadProbe</a> getLoadProbe()</pre> |
| <div class="block">Get 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 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)</pre> |
| <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.</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="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">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="blockList"> |
| <li class="blockList"> |
| <h4>setLoadPollInterval</h4> |
| <pre>void setLoadPollInterval(long loadPollInterval)</pre> |
| <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> |
| </dl> |
| </li> |
| </ul> |
| <a name="getTcpNoDelay--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getTcpNoDelay</h4> |
| <pre>boolean getTcpNoDelay()</pre> |
| <div class="block">Get the outgoing connection tcp-no-delay setting. If it is set to true (the default) this cache |
| server is configured to enable tcp-no-delay on outgoing tcp/ip sockets. If it is set to false |
| this cache server is configured to disable tcp-no-delay on outgoing sockets.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the tcp-no-delay setting</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setTcpNoDelay-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setTcpNoDelay</h4> |
| <pre>void setTcpNoDelay(boolean noDelay)</pre> |
| <div class="block">Configures the tcpNoDelay setting of sockets used to send messages to clients. TcpNoDelay is |
| enabled by default.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>noDelay</code> - if false, sets tcp-no-delay to false on out-going connections</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getClientSubscriptionConfig--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getClientSubscriptionConfig</h4> |
| <pre><a href="../../../../../org/apache/geode/cache/server/ClientSubscriptionConfig.html" title="interface in org.apache.geode.cache.server">ClientSubscriptionConfig</a> getClientSubscriptionConfig()</pre> |
| <div class="block">Get the ClientSubscriptionConfig for this cache server. See <a href="../../../../../org/apache/geode/cache/server/ClientSubscriptionConfig.html" title="interface in org.apache.geode.cache.server"><code>ClientSubscriptionConfig</code></a> |
| for details on the client subscription configuration.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the ClientSubscriptionConfig for this cache server</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>GemFire 5.7</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getClientSession-org.apache.geode.distributed.DistributedMember-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getClientSession</h4> |
| <pre><a href="../../../../../org/apache/geode/cache/ClientSession.html" title="interface in org.apache.geode.cache">ClientSession</a> getClientSession(<a href="../../../../../org/apache/geode/distributed/DistributedMember.html" title="interface in org.apache.geode.distributed">DistributedMember</a> member)</pre> |
| <div class="block">Returns the <code>ClientSession</code> associated with the <code>DistributedMember</code></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>member</code> - a <code>DistributedMember</code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the <code>ClientSession</code> associated with the <code>DistributedMember</code></dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>GemFire 6.0</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getClientSession-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getClientSession</h4> |
| <pre><a href="../../../../../org/apache/geode/cache/ClientSession.html" title="interface in org.apache.geode.cache">ClientSession</a> getClientSession(<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> durableClientId)</pre> |
| <div class="block">Returns the <code>ClientSession</code> associated with the durable client id</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>durableClientId</code> - a durable client id</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the <code>ClientSession</code> associated with the durable</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>GemFire 6.0</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getAllClientSessions--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getAllClientSessions</h4> |
| <pre><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a><<a href="../../../../../org/apache/geode/cache/ClientSession.html" title="interface in org.apache.geode.cache">ClientSession</a>> getAllClientSessions()</pre> |
| <div class="block">Returns a set of all <code>ClientSession</code>s</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a set of all <code>ClientSession</code>s</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>GemFire 6.0</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="registerInterestRegistrationListener-org.apache.geode.cache.InterestRegistrationListener-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>registerInterestRegistrationListener</h4> |
| <pre>void registerInterestRegistrationListener(<a href="../../../../../org/apache/geode/cache/InterestRegistrationListener.html" title="interface in org.apache.geode.cache">InterestRegistrationListener</a> listener)</pre> |
| <div class="block">Registers a new <code>InterestRegistrationListener</code> with the set of |
| <code>InterestRegistrationListener</code>s.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>listener</code> - The <code>InterestRegistrationListener</code> to register</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>GemFire 6.0</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="unregisterInterestRegistrationListener-org.apache.geode.cache.InterestRegistrationListener-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>unregisterInterestRegistrationListener</h4> |
| <pre>void unregisterInterestRegistrationListener(<a href="../../../../../org/apache/geode/cache/InterestRegistrationListener.html" title="interface in org.apache.geode.cache">InterestRegistrationListener</a> listener)</pre> |
| <div class="block">Unregisters an existing <code>InterestRegistrationListener</code> from the set of |
| <code>InterestRegistrationListener</code>s.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>listener</code> - The <code>InterestRegistrationListener</code> to unregister</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>GemFire 6.0</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getInterestRegistrationListeners--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>getInterestRegistrationListeners</h4> |
| <pre><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a><<a href="../../../../../org/apache/geode/cache/InterestRegistrationListener.html" title="interface in org.apache.geode.cache">InterestRegistrationListener</a>> getInterestRegistrationListeners()</pre> |
| <div class="block">Returns a read-only set of <code>InterestRegistrationListener</code>s registered with this |
| notifier.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a read-only set of <code>InterestRegistrationListener</code>s registered with this |
| notifier</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>GemFire 6.0</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>Prev Class</li> |
| <li><a href="../../../../../org/apache/geode/cache/server/ClientSubscriptionConfig.html" title="interface in org.apache.geode.cache.server"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/geode/cache/server/CacheServer.html" target="_top">Frames</a></li> |
| <li><a href="CacheServer.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><a href="#field.summary">Field</a> | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li><a href="#field.detail">Field</a> | </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> |