| <!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 (1.8.0_272) on Thu Nov 12 16:27:25 PST 2020 --> |
| <title>GeodeRedisServer (Apache Geode 1.13.1)</title> |
| <meta name="date" content="2020-11-12"> |
| <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="GeodeRedisServer (Apache Geode 1.13.1)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":10,"i1":10,"i2":10,"i3":9,"i4":10,"i5":10}; |
| var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]}; |
| var altColor = "altColor"; |
| var rowColor = "rowColor"; |
| var tableTab = "tableTab"; |
| var activeTableTab = "activeTableTab"; |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a name="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.top.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="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>Next Class</li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/apache/geode/redis/GeodeRedisServer.html" target="_top">Frames</a></li> |
| <li><a href="GeodeRedisServer.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><a href="#constructor.summary">Constr</a> | </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><a href="#constructor.detail">Constr</a> | </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.redis</div> |
| <h2 title="Class GeodeRedisServer" class="title">Class GeodeRedisServer</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.geode.redis.GeodeRedisServer</li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <hr> |
| <br> |
| <pre><a href="../../../../org/apache/geode/annotations/Experimental.html" title="annotation in org.apache.geode.annotations">@Experimental</a> |
| public class <span class="typeNameLabel">GeodeRedisServer</span> |
| extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></pre> |
| <div class="block">The GeodeRedisServer is a server that understands the Redis protocol. As commands are sent to the |
| server, each command is picked up by a thread, interpreted and then executed and a response is |
| sent back to the client. The default connection port is 6379 but that can be altered when run |
| through GFSH or started through the provided static main class. |
| <p> |
| Each Redis data type instance is stored in a separate <a href="../../../../org/apache/geode/cache/Region.html" title="interface in org.apache.geode.cache"><code>Region</code></a> except for the Strings and |
| HyperLogLogs which are collectively stored in one Region respectively. That Region along with a |
| meta data region used internally are protected so the client may not store keys with the name |
| <a href="../../../../org/apache/geode/redis/GeodeRedisServer.html#REDIS_META_DATA_REGION"><code>REDIS_META_DATA_REGION</code></a> or <a href="../../../../org/apache/geode/redis/GeodeRedisServer.html#STRING_REGION"><code>STRING_REGION</code></a>. The |
| default Region type is <a href="../../../../org/apache/geode/cache/RegionShortcut.html#PARTITION"><code>RegionShortcut.PARTITION</code></a> although this can be changed by |
| specifying the SystemProperty <a href="../../../../org/apache/geode/redis/GeodeRedisServer.html#DEFAULT_REGION_SYS_PROP_NAME">"gemfireredis.regiontype"</a> to a type defined by <a href="../../../../org/apache/geode/cache/RegionShortcut.html" title="enum in org.apache.geode.cache"><code>RegionShortcut</code></a>. If the <a href="../../../../org/apache/geode/redis/GeodeRedisServer.html#NUM_THREADS_SYS_PROP_NAME"><code>NUM_THREADS_SYS_PROP_NAME</code></a> system property is set |
| to 0, one thread per client will be created. Otherwise a worker thread pool of specified size is |
| used or a default size of 4 * <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Runtime.html?is-external=true#availableProcessors--" title="class or interface in java.lang"><code>Runtime.availableProcessors()</code></a> if the property is not set. |
| <p> |
| Setting the AUTH password requires setting the property "redis-password" just as "redis-port" |
| would be in xml or through GFSH. |
| <p> |
| The supported commands are as follows: |
| <p> |
| Supported String commands - APPEND, BITCOUNT, BITOP, BITPOS, DECR, DECRBY, GET, GETBIT, GETRANGE, |
| GETSET, INCR, INCRBY, INCRBYFLOAT, MGET, MSET, MSETNX, PSETEX, SET, SETBIT, SETEX, SETNX, STRLEN |
| <p> |
| Supported List commands - LINDEX, LLEN, LPOP, LPUSH, LPUSHX, LRANGE, LREM, LSET, LTRIM, RPOP, |
| RPUSH, RPUSHX |
| <p> |
| Supported Hash commands - HDEL, HEXISTS, HGET, HGETALL, HINCRBY, HINCRBYFLOAT, HKEYS, HMGET, |
| HMSET, HSETNX, HLEN, HSCAN, HSET, HVALS |
| <p> |
| Supported Set commands - SADD, SCARD, SDIFF, SDIFFSTORE, SINTER, SINTERSTORE, SISMEMBER, |
| SMEMBERS, SMOVE, SREM, SPOP, SRANDMEMBER, SCAN, SUNION, SUNIONSTORE |
| <p> |
| Supported SortedSet commands - ZADD, ZCARD, ZCOUNT, ZINCRBY, ZLEXCOUNT, ZRANGE, ZRANGEBYLEX, |
| ZRANGEBYSCORE, ZRANK, ZREM, ZREMRANGEBYLEX, ZREMRANGEBYRANK, ZREMRANGEBYSCORE, ZREVRANGE, |
| ZREVRANGEBYSCORE, ZREVRANK, ZSCAN, ZSCORE |
| <p> |
| Supported HyperLogLog commands - PFADD, PFCOUNT, PFMERGE |
| <p> |
| Supported Keys commands - DEL, DBSIZE, EXISTS, EXPIRE, EXPIREAT, FLUSHDB, FLUSHALL, KEYS, |
| PERSIST, PEXPIRE, PEXPIREAT, PTTL, SCAN, TTL |
| <p> |
| Supported Transaction commands - DISCARD, EXEC, MULTI |
| <p> |
| Supported Server commands - AUTH, ECHO, PING, TIME, QUIT |
| <p> |
| <p> |
| The command executors are not explicitly documented but the functionality can be found at |
| <a href="http://redis.io/commands">Redis Commands</a> |
| <p> |
| Exceptions to the Redis Commands Documents: |
| <p> |
| <ul> |
| <li>Any command that removes keys and returns a count of removed entries will not return a total |
| remove count but rather a count of how many entries have been removed that existed on the local |
| vm, though all entries will be removed</li> |
| <li>Any command that returns a count of newly set members has an unspecified return value. The |
| command will work just as the Redis protocol states but the count will not necessary reflect the |
| number set compared to overridden.</li> |
| <li>Transactions work just as they would on a Redis instance, they are local transaction. |
| Transactions cannot be executed on data that is not local to the executing server, that is on a |
| partitioned region in a different server instance or on a persistent region that does not have |
| transactions enabled. Also, you cannot watch or unwatch keys as all keys within a GemFire |
| transaction are watched by default.</li> |
| </ul></div> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="field.summary"> |
| <!-- --> |
| </a> |
| <h3>Field Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation"> |
| <caption><span>Fields</span><span class="tabEnd"> </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 int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/redis/GeodeRedisServer.html#DEFAULT_REDIS_SERVER_PORT">DEFAULT_REDIS_SERVER_PORT</a></span></code> |
| <div class="block">The default Redis port as specified by their protocol, <code>DEFAULT_REDIS_SERVER_PORT</code></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/redis/GeodeRedisServer.html#DEFAULT_REGION_SYS_PROP_NAME">DEFAULT_REGION_SYS_PROP_NAME</a></span></code> |
| <div class="block">The system property name used to set the default <a href="../../../../org/apache/geode/cache/Region.html" title="interface in org.apache.geode.cache"><code>Region</code></a> creation type.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/geode/cache/RegionShortcut.html" title="enum in org.apache.geode.cache">RegionShortcut</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/redis/GeodeRedisServer.html#DEFAULT_REGION_TYPE">DEFAULT_REGION_TYPE</a></span></code> |
| <div class="block">The actual <a href="../../../../org/apache/geode/cache/RegionShortcut.html" title="enum in org.apache.geode.cache"><code>RegionShortcut</code></a> type specified by the system property <a href="../../../../org/apache/geode/redis/GeodeRedisServer.html#DEFAULT_REGION_SYS_PROP_NAME">"gemfireredis.regiontype"</a>.</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/redis/GeodeRedisServer.html#HASH_REGION">HASH_REGION</a></span></code> |
| <div class="block">TThe field that defines the name of the <a href="../../../../org/apache/geode/cache/Region.html" title="interface in org.apache.geode.cache"><code>Region</code></a> which holds non-named hash.</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/redis/GeodeRedisServer.html#HLL_REGION">HLL_REGION</a></span></code> |
| <div class="block">The field that defines the name of the <a href="../../../../org/apache/geode/cache/Region.html" title="interface in org.apache.geode.cache"><code>Region</code></a> which holds all of the HyperLogLogs.</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/redis/GeodeRedisServer.html#NUM_THREADS_SYS_PROP_NAME">NUM_THREADS_SYS_PROP_NAME</a></span></code> |
| <div class="block">System property name that can be used to set the number of threads to be used by the |
| GeodeRedisServer</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/redis/GeodeRedisServer.html#REDIS_META_DATA_REGION">REDIS_META_DATA_REGION</a></span></code> |
| <div class="block">The field that defines the name of the <a href="../../../../org/apache/geode/cache/Region.html" title="interface in org.apache.geode.cache"><code>Region</code></a> which holds all of the Redis meta data.</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/redis/GeodeRedisServer.html#SET_REGION">SET_REGION</a></span></code> |
| <div class="block">TThe field that defines the name of the <a href="../../../../org/apache/geode/cache/Region.html" title="interface in org.apache.geode.cache"><code>Region</code></a> which holds sets.</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/redis/GeodeRedisServer.html#STRING_REGION">STRING_REGION</a></span></code> |
| <div class="block">The field that defines the name of the <a href="../../../../org/apache/geode/cache/Region.html" title="interface in org.apache.geode.cache"><code>Region</code></a> which holds all of the strings.</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.summary"> |
| <!-- --> |
| </a> |
| <h3>Constructor Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> |
| <caption><span>Constructors</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colOne" scope="col">Constructor and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/redis/GeodeRedisServer.html#GeodeRedisServer-int-">GeodeRedisServer</a></span>(int port)</code> |
| <div class="block">Constructor for <code>GeodeRedisServer</code> that will start the server on the given port and bind |
| to the first non-loopback address</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/redis/GeodeRedisServer.html#GeodeRedisServer-java.lang.String-int-">GeodeRedisServer</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> bindAddress, |
| int port)</code> |
| <div class="block">Constructor for <code>GeodeRedisServer</code> that will start the server and bind to the given |
| address and port</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/redis/GeodeRedisServer.html#GeodeRedisServer-java.lang.String-int-java.lang.String-">GeodeRedisServer</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> bindAddress, |
| int port, |
| <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> logLevel)</code> |
| <div class="block">Constructor for <code>GeodeRedisServer</code> that will start the server and bind to the given |
| address and port.</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="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></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="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete 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>org.apache.geode.redis.internal.KeyRegistrar</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/redis/GeodeRedisServer.html#getKeyRegistrar--">getKeyRegistrar</a></span>()</code> </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>org.apache.geode.redis.internal.RedisLockService</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/redis/GeodeRedisServer.html#getLockService--">getLockService</a></span>()</code> </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>org.apache.geode.redis.internal.RegionProvider</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/redis/GeodeRedisServer.html#getRegionCache--">getRegionCache</a></span>()</code> </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>static void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/redis/GeodeRedisServer.html#main-java.lang.String:A-">main</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>[] args)</code> |
| <div class="block">Static main method that allows the <code>GeodeRedisServer</code> to be started from the command |
| line.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/redis/GeodeRedisServer.html#shutdown--">shutdown</a></span>()</code> |
| <div class="block">Shutdown method for <code>GeodeRedisServer</code>.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/redis/GeodeRedisServer.html#start--">start</a></span>()</code> |
| <div class="block">This is function to call on a <code>GeodeRedisServer</code> instance to start it running</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3> |
| <code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ FIELD DETAIL =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="field.detail"> |
| <!-- --> |
| </a> |
| <h3>Field Detail</h3> |
| <a name="DEFAULT_REDIS_SERVER_PORT"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>DEFAULT_REDIS_SERVER_PORT</h4> |
| <pre>public static final int DEFAULT_REDIS_SERVER_PORT</pre> |
| <div class="block">The default Redis port as specified by their protocol, <code>DEFAULT_REDIS_SERVER_PORT</code></div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../constant-values.html#org.apache.geode.redis.GeodeRedisServer.DEFAULT_REDIS_SERVER_PORT">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="STRING_REGION"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>STRING_REGION</h4> |
| <pre>public 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> STRING_REGION</pre> |
| <div class="block">The field that defines the name of the <a href="../../../../org/apache/geode/cache/Region.html" title="interface in org.apache.geode.cache"><code>Region</code></a> which holds all of the strings. The |
| current value of this field is <code>STRING_REGION</code>.</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../constant-values.html#org.apache.geode.redis.GeodeRedisServer.STRING_REGION">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="HASH_REGION"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>HASH_REGION</h4> |
| <pre>public 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> HASH_REGION</pre> |
| <div class="block">TThe field that defines the name of the <a href="../../../../org/apache/geode/cache/Region.html" title="interface in org.apache.geode.cache"><code>Region</code></a> which holds non-named hash. The current |
| value of this field is "ReDiS_HASH".</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../constant-values.html#org.apache.geode.redis.GeodeRedisServer.HASH_REGION">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="SET_REGION"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>SET_REGION</h4> |
| <pre>public 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> SET_REGION</pre> |
| <div class="block">TThe field that defines the name of the <a href="../../../../org/apache/geode/cache/Region.html" title="interface in org.apache.geode.cache"><code>Region</code></a> which holds sets. The current value of |
| this field is "ReDiS_SET".</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../constant-values.html#org.apache.geode.redis.GeodeRedisServer.SET_REGION">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="HLL_REGION"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>HLL_REGION</h4> |
| <pre>public 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> HLL_REGION</pre> |
| <div class="block">The field that defines the name of the <a href="../../../../org/apache/geode/cache/Region.html" title="interface in org.apache.geode.cache"><code>Region</code></a> which holds all of the HyperLogLogs. The |
| current value of this field is <code>HLL_REGION</code>.</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../constant-values.html#org.apache.geode.redis.GeodeRedisServer.HLL_REGION">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="REDIS_META_DATA_REGION"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>REDIS_META_DATA_REGION</h4> |
| <pre>public 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> REDIS_META_DATA_REGION</pre> |
| <div class="block">The field that defines the name of the <a href="../../../../org/apache/geode/cache/Region.html" title="interface in org.apache.geode.cache"><code>Region</code></a> which holds all of the Redis meta data. |
| The current value of this field is <code>REDIS_META_DATA_REGION</code>.</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../constant-values.html#org.apache.geode.redis.GeodeRedisServer.REDIS_META_DATA_REGION">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="DEFAULT_REGION_SYS_PROP_NAME"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>DEFAULT_REGION_SYS_PROP_NAME</h4> |
| <pre>public 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_REGION_SYS_PROP_NAME</pre> |
| <div class="block">The system property name used to set the default <a href="../../../../org/apache/geode/cache/Region.html" title="interface in org.apache.geode.cache"><code>Region</code></a> creation type. The property |
| name is <code>DEFAULT_REGION_SYS_PROP_NAME</code> and the acceptable values are types defined by |
| <a href="../../../../org/apache/geode/cache/RegionShortcut.html" title="enum in org.apache.geode.cache"><code>RegionShortcut</code></a>, i.e. "PARTITION" would be used for <a href="../../../../org/apache/geode/cache/RegionShortcut.html#PARTITION"><code>RegionShortcut.PARTITION</code></a>.</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../constant-values.html#org.apache.geode.redis.GeodeRedisServer.DEFAULT_REGION_SYS_PROP_NAME">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="NUM_THREADS_SYS_PROP_NAME"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>NUM_THREADS_SYS_PROP_NAME</h4> |
| <pre>public 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> NUM_THREADS_SYS_PROP_NAME</pre> |
| <div class="block">System property name that can be used to set the number of threads to be used by the |
| GeodeRedisServer</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../constant-values.html#org.apache.geode.redis.GeodeRedisServer.NUM_THREADS_SYS_PROP_NAME">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="DEFAULT_REGION_TYPE"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>DEFAULT_REGION_TYPE</h4> |
| <pre>public final <a href="../../../../org/apache/geode/cache/RegionShortcut.html" title="enum in org.apache.geode.cache">RegionShortcut</a> DEFAULT_REGION_TYPE</pre> |
| <div class="block">The actual <a href="../../../../org/apache/geode/cache/RegionShortcut.html" title="enum in org.apache.geode.cache"><code>RegionShortcut</code></a> type specified by the system property <a href="../../../../org/apache/geode/redis/GeodeRedisServer.html#DEFAULT_REGION_SYS_PROP_NAME">"gemfireredis.regiontype"</a>.</div> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a name="GeodeRedisServer-int-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>GeodeRedisServer</h4> |
| <pre>public GeodeRedisServer(int port)</pre> |
| <div class="block">Constructor for <code>GeodeRedisServer</code> that will start the server on the given port and bind |
| to the first non-loopback address</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>port</code> - The port the server will bind to, will use <a href="../../../../org/apache/geode/redis/GeodeRedisServer.html#DEFAULT_REDIS_SERVER_PORT">6379</a> by |
| default</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="GeodeRedisServer-java.lang.String-int-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>GeodeRedisServer</h4> |
| <pre>public GeodeRedisServer(<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> bindAddress, |
| int port)</pre> |
| <div class="block">Constructor for <code>GeodeRedisServer</code> that will start the server and bind to the given |
| address and port</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>bindAddress</code> - The address to which the server will attempt to bind to</dd> |
| <dd><code>port</code> - The port the server will bind to, will use <a href="../../../../org/apache/geode/redis/GeodeRedisServer.html#DEFAULT_REDIS_SERVER_PORT">6379</a> |
| by default if argument is less than or equal to 0</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="GeodeRedisServer-java.lang.String-int-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>GeodeRedisServer</h4> |
| <pre>public GeodeRedisServer(<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> bindAddress, |
| int port, |
| <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> logLevel)</pre> |
| <div class="block">Constructor for <code>GeodeRedisServer</code> that will start the server and bind to the given |
| address and port. Keep in mind that the log level configuration will only be set if a <a href="../../../../org/apache/geode/cache/Cache.html" title="interface in org.apache.geode.cache"><code>Cache</code></a> does not already exist, if one already exists then setting that property will have no |
| effect.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>bindAddress</code> - The address to which the server will attempt to bind to</dd> |
| <dd><code>port</code> - The port the server will bind to, will use <a href="../../../../org/apache/geode/redis/GeodeRedisServer.html#DEFAULT_REDIS_SERVER_PORT">6379</a> |
| by default if argument is less than or equal to 0</dd> |
| <dd><code>logLevel</code> - The logging level to be used by GemFire</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="getKeyRegistrar--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getKeyRegistrar</h4> |
| <pre><a href="../../../../org/apache/geode/annotations/VisibleForTesting.html" title="annotation in org.apache.geode.annotations">@VisibleForTesting</a> |
| public org.apache.geode.redis.internal.KeyRegistrar getKeyRegistrar()</pre> |
| </li> |
| </ul> |
| <a name="start--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>start</h4> |
| <pre>public void start()</pre> |
| <div class="block">This is function to call on a <code>GeodeRedisServer</code> instance to start it running</div> |
| </li> |
| </ul> |
| <a name="getRegionCache--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getRegionCache</h4> |
| <pre><a href="../../../../org/apache/geode/annotations/VisibleForTesting.html" title="annotation in org.apache.geode.annotations">@VisibleForTesting</a> |
| public org.apache.geode.redis.internal.RegionProvider getRegionCache()</pre> |
| </li> |
| </ul> |
| <a name="getLockService--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getLockService</h4> |
| <pre><a href="../../../../org/apache/geode/annotations/VisibleForTesting.html" title="annotation in org.apache.geode.annotations">@VisibleForTesting</a> |
| public org.apache.geode.redis.internal.RedisLockService getLockService()</pre> |
| </li> |
| </ul> |
| <a name="shutdown--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>shutdown</h4> |
| <pre>public void shutdown()</pre> |
| <div class="block">Shutdown method for <code>GeodeRedisServer</code>. This closes the <a href="../../../../org/apache/geode/cache/Cache.html" title="interface in org.apache.geode.cache"><code>Cache</code></a>, interrupts all |
| execution and forcefully closes all connections.</div> |
| </li> |
| </ul> |
| <a name="main-java.lang.String:A-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>main</h4> |
| <pre>public static void main(<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>[] args)</pre> |
| <div class="block">Static main method that allows the <code>GeodeRedisServer</code> to be started from the command |
| line. The supported command line arguments are |
| <p> |
| -port= <br> |
| -bind-address= <br> |
| -log-level=</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>args</code> - Command line args</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>Next Class</li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/apache/geode/redis/GeodeRedisServer.html" target="_top">Frames</a></li> |
| <li><a href="GeodeRedisServer.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><a href="#constructor.summary">Constr</a> | </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><a href="#constructor.detail">Constr</a> | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </body> |
| </html> |
