Recent changes to Usage

WikiPage Usage modified by Hitesh Amritlal Viseria

Hitesh Amritlal Viseria — Mon, 30 Apr 2012 15:19:58 -0000

--- v3 
+++ v4 
@@ -1,36 +1,52 @@
-Performance Benchmarks
-======================
-
-All the performance benchmarks done in various configuration and regression testing, have delivered consistent results.
-
-NitroCache scales with O(c) as number of threads increase. The fetch time remains constant irrespective of thread load. The put time increases linearly with threads, the performance and graph curve for put is similar to ehCache.
-
---------------------------------------------------------
-
-Performance Testing
-====================
-System configuration
---------------------
-System Type: x64-based PC
-Processor: Intel(R) Core(TM) i5 CPU 650@3.20GHz, 3333 Mhz, 2 Core(s), 4 Logical Processor(s)
-OS: Windows 7
-
-
-Test Setup
------------
-Threads = 1,2,5,10,15,25,50
-Cache Sizes = 100,200,500,1000,5000,25000,50000
-Number of get operations per test = ~4000000
-Ratio of put v/s get: 20 get operations per put operation
-
-Test Data
----------
-A random set 2000 key-value pairs. Refer to dataRand.csv
-
-Use cases
----------
-1. EHCache (LRU mode), In-memory mode only
-2. cache4j, In-memory mode only
-3. NitroCache - FIFO mode
-4. NitroCache - LRU mode
-
+NitroCache implements java.util.Map interface, which makes it extremely easy to use and pluggable. 
+
+
+Creation
+---------
+~~~~~~~~~~~~~~~~~~~~~~~
+NitroCache _cache = null;
+// Every call to NitroCache.getInstance will create new cache. Its not singleton
+_cache = NitroCache.getInstance(5000, CacheEviction.FIFO); 
+~~~~~~~~~~~~~~~~~~~~~~~
+
+Inserting value
+---------------------------------------------------------
+~~~~~~~~~~~~~~~~~~~~~
+_cache.put("1000","hello world");
+System.out.println(_cache.get("1000");
+~~~~~~~~~~~~~~~~~~~~~
+
+Removing key
+---------------------------------------------------------
+~~~~~~~~~~~~~~~~~~~~~~
+_cache.remove("1000");
+~~~~~~~~~~~~~~~~~~~~~~
+
+
+Method list
+------------------------------------------
+Method|Description|
+------|-----------|
+clear()|Clears the cache. Internally creates a new cache|
+containsKey(Object)|Returns true if key present|
+containsValue(Object)|Not Supported|
+entrySet()|Return an entrySet based on current entries*|
+get(Object)|Return value if key is present|
+isEmpty()|Return true if Cache size > 0*|
+keySet()|Return set of keys from the cache*|
+put(K, V)|Add key/value to cache|
+putAll(Map)|In a loop add all key/values|
+remove(Object)|Remove the key if present|
+shutdown()|Stop and clear underlying cache|
+size()|Return size of cache*|
+values()|Return all values from cache*|
+
+ - Methods marked with "*" create a secondary map and use it for operation. The in-flight entries may/may not show-up as this method does not add any lock on the cache, thus avoiding performance hit
+
+Eviction Modes
+---------------
+Mode|Description|Suggested Usage|
+----|-----------|---------------|
+FIFO|Standard First-in-first-out algorithm. put(key,null) will remove the entry and compacts cache. Adding same key/value again moves the entry to end.|Frequent removal and re-entry of key/values|
+FIFO_V2|Optimized for speed FIFO. put(key,null) removes entry but does not immediately compact cache. Adding same key/value again does not change order of entry in FIFO queue|Less frequent removal/replace of values for keys. High throughput.|
+LRU| Standard Least Recently Used algorithm|If LRU provides more hits|

WikiPage Performance modified by Hitesh Amritlal Viseria

Hitesh Amritlal Viseria — Mon, 30 Apr 2012 14:52:57 -0000

WikiPage Home modified by Hitesh Amritlal Viseria

Hitesh Amritlal Viseria — Mon, 23 Apr 2012 07:49:13 -0000

--- v1 
+++ v2 
@@ -1,27 +1,36 @@
+Performance Benchmarks
+======================
+
+All the performance benchmarks done in various configuration and regression testing, have delivered consistent results.
+
+NitroCache scales with O(c) as number of threads increase. The fetch time remains constant irrespective of thread load. The put time increases linearly with threads, the performance and graph curve for put is similar to ehCache.
+
+--------------------------------------------------------
+
 Performance Testing
 ====================
 System configuration
 --------------------
 System Type: x64-based PC
 Processor: Intel(R) Core(TM) i5 CPU 650@3.20GHz, 3333 Mhz, 2 Core(s), 4 Logical Processor(s)
 OS: Windows 7
 
 
 Test Setup
 -----------
 Threads = 1,2,5,10,15,25,50
 Cache Sizes = 100,200,500,1000,5000,25000,50000
 Number of get operations per test = ~4000000
 Ratio of put v/s get: 20 get operations per put operation
 
 Test Data
 ---------
 A random set 2000 key-value pairs. Refer to dataRand.csv
 
 Use cases
 ---------
-1. EHCache (LRU mode)
-2. cache4j
+1. EHCache (LRU mode), In-memory mode only
+2. cache4j, In-memory mode only
 3. NitroCache - FIFO mode
 4. NitroCache - LRU mode

WikiPage Home modified by Hitesh Amritlal Viseria

Hitesh Amritlal Viseria — Mon, 23 Apr 2012 07:33:05 -0000

Performance Testing ==================== System configuration -------------------- System Type: x64-based PC Processor: Intel(R) Core(TM) i5 CPU 650@3.20GHz, 3333 Mhz, 2 Core(s), 4 Logical Processor(s) OS: Windows 7 Test Setup ----------- Threads = 1,2,5,10,15,25,50 Cache Sizes = 100,200,500,1000,5000,25000,50000 Number of get operations per test = ~4000000 Ratio of put v/s get: 20 get operations per put operation Test Data --------- A random set 2000 key-value pairs. Refer to dataRand.csv Use cases --------- 1. EHCache (LRU mode) 2. cache4j 3. NitroCache - FIFO mode 4. NitroCache - LRU mode