├── LICENSE ├── README.md ├── project.clj ├── src └── expiring_map │ └── core.clj └── test └── expiring_map ├── benchmark.clj └── core_test.clj /LICENSE: -------------------------------------------------------------------------------- 1 | THE ACCOMPANYING PROGRAM IS PROVIDED UNDER THE TERMS OF THIS ECLIPSE PUBLIC 2 | LICENSE ("AGREEMENT"). ANY USE, REPRODUCTION OR DISTRIBUTION OF THE PROGRAM 3 | CONSTITUTES RECIPIENT'S ACCEPTANCE OF THIS AGREEMENT. 4 | 5 | 1. DEFINITIONS 6 | 7 | "Contribution" means: 8 | 9 | a) in the case of the initial Contributor, the initial code and 10 | documentation distributed under this Agreement, and 11 | 12 | b) in the case of each subsequent Contributor: 13 | 14 | i) changes to the Program, and 15 | 16 | ii) additions to the Program; 17 | 18 | where such changes and/or additions to the Program originate from and are 19 | distributed by that particular Contributor. A Contribution 'originates' from 20 | a Contributor if it was added to the Program by such Contributor itself or 21 | anyone acting on such Contributor's behalf. Contributions do not include 22 | additions to the Program which: (i) are separate modules of software 23 | distributed in conjunction with the Program under their own license 24 | agreement, and (ii) are not derivative works of the Program. 25 | 26 | "Contributor" means any person or entity that distributes the Program. 27 | 28 | "Licensed Patents" mean patent claims licensable by a Contributor which are 29 | necessarily infringed by the use or sale of its Contribution alone or when 30 | combined with the Program. 31 | 32 | "Program" means the Contributions distributed in accordance with this 33 | Agreement. 34 | 35 | "Recipient" means anyone who receives the Program under this Agreement, 36 | including all Contributors. 37 | 38 | 2. GRANT OF RIGHTS 39 | 40 | a) Subject to the terms of this Agreement, each Contributor hereby grants 41 | Recipient a non-exclusive, worldwide, royalty-free copyright license to 42 | reproduce, prepare derivative works of, publicly display, publicly perform, 43 | distribute and sublicense the Contribution of such Contributor, if any, and 44 | such derivative works, in source code and object code form. 45 | 46 | b) Subject to the terms of this Agreement, each Contributor hereby grants 47 | Recipient a non-exclusive, worldwide, royalty-free patent license under 48 | Licensed Patents to make, use, sell, offer to sell, import and otherwise 49 | transfer the Contribution of such Contributor, if any, in source code and 50 | object code form. This patent license shall apply to the combination of the 51 | Contribution and the Program if, at the time the Contribution is added by the 52 | Contributor, such addition of the Contribution causes such combination to be 53 | covered by the Licensed Patents. The patent license shall not apply to any 54 | other combinations which include the Contribution. No hardware per se is 55 | licensed hereunder. 56 | 57 | c) Recipient understands that although each Contributor grants the licenses 58 | to its Contributions set forth herein, no assurances are provided by any 59 | Contributor that the Program does not infringe the patent or other 60 | intellectual property rights of any other entity. Each Contributor disclaims 61 | any liability to Recipient for claims brought by any other entity based on 62 | infringement of intellectual property rights or otherwise. As a condition to 63 | exercising the rights and licenses granted hereunder, each Recipient hereby 64 | assumes sole responsibility to secure any other intellectual property rights 65 | needed, if any. For example, if a third party patent license is required to 66 | allow Recipient to distribute the Program, it is Recipient's responsibility 67 | to acquire that license before distributing the Program. 68 | 69 | d) Each Contributor represents that to its knowledge it has sufficient 70 | copyright rights in its Contribution, if any, to grant the copyright license 71 | set forth in this Agreement. 72 | 73 | 3. REQUIREMENTS 74 | 75 | A Contributor may choose to distribute the Program in object code form under 76 | its own license agreement, provided that: 77 | 78 | a) it complies with the terms and conditions of this Agreement; and 79 | 80 | b) its license agreement: 81 | 82 | i) effectively disclaims on behalf of all Contributors all warranties and 83 | conditions, express and implied, including warranties or conditions of title 84 | and non-infringement, and implied warranties or conditions of merchantability 85 | and fitness for a particular purpose; 86 | 87 | ii) effectively excludes on behalf of all Contributors all liability for 88 | damages, including direct, indirect, special, incidental and consequential 89 | damages, such as lost profits; 90 | 91 | iii) states that any provisions which differ from this Agreement are offered 92 | by that Contributor alone and not by any other party; and 93 | 94 | iv) states that source code for the Program is available from such 95 | Contributor, and informs licensees how to obtain it in a reasonable manner on 96 | or through a medium customarily used for software exchange. 97 | 98 | When the Program is made available in source code form: 99 | 100 | a) it must be made available under this Agreement; and 101 | 102 | b) a copy of this Agreement must be included with each copy of the Program. 103 | 104 | Contributors may not remove or alter any copyright notices contained within 105 | the Program. 106 | 107 | Each Contributor must identify itself as the originator of its Contribution, 108 | if any, in a manner that reasonably allows subsequent Recipients to identify 109 | the originator of the Contribution. 110 | 111 | 4. COMMERCIAL DISTRIBUTION 112 | 113 | Commercial distributors of software may accept certain responsibilities with 114 | respect to end users, business partners and the like. While this license is 115 | intended to facilitate the commercial use of the Program, the Contributor who 116 | includes the Program in a commercial product offering should do so in a 117 | manner which does not create potential liability for other Contributors. 118 | Therefore, if a Contributor includes the Program in a commercial product 119 | offering, such Contributor ("Commercial Contributor") hereby agrees to defend 120 | and indemnify every other Contributor ("Indemnified Contributor") against any 121 | losses, damages and costs (collectively "Losses") arising from claims, 122 | lawsuits and other legal actions brought by a third party against the 123 | Indemnified Contributor to the extent caused by the acts or omissions of such 124 | Commercial Contributor in connection with its distribution of the Program in 125 | a commercial product offering. The obligations in this section do not apply 126 | to any claims or Losses relating to any actual or alleged intellectual 127 | property infringement. In order to qualify, an Indemnified Contributor must: 128 | a) promptly notify the Commercial Contributor in writing of such claim, and 129 | b) allow the Commercial Contributor tocontrol, and cooperate with the 130 | Commercial Contributor in, the defense and any related settlement 131 | negotiations. The Indemnified Contributor may participate in any such claim 132 | at its own expense. 133 | 134 | For example, a Contributor might include the Program in a commercial product 135 | offering, Product X. That Contributor is then a Commercial Contributor. If 136 | that Commercial Contributor then makes performance claims, or offers 137 | warranties related to Product X, those performance claims and warranties are 138 | such Commercial Contributor's responsibility alone. Under this section, the 139 | Commercial Contributor would have to defend claims against the other 140 | Contributors related to those performance claims and warranties, and if a 141 | court requires any other Contributor to pay any damages as a result, the 142 | Commercial Contributor must pay those damages. 143 | 144 | 5. NO WARRANTY 145 | 146 | EXCEPT AS EXPRESSLY SET FORTH IN THIS AGREEMENT, THE PROGRAM IS PROVIDED ON 147 | AN "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, EITHER 148 | EXPRESS OR IMPLIED INCLUDING, WITHOUT LIMITATION, ANY WARRANTIES OR 149 | CONDITIONS OF TITLE, NON-INFRINGEMENT, MERCHANTABILITY OR FITNESS FOR A 150 | PARTICULAR PURPOSE. Each Recipient is solely responsible for determining the 151 | appropriateness of using and distributing the Program and assumes all risks 152 | associated with its exercise of rights under this Agreement , including but 153 | not limited to the risks and costs of program errors, compliance with 154 | applicable laws, damage to or loss of data, programs or equipment, and 155 | unavailability or interruption of operations. 156 | 157 | 6. DISCLAIMER OF LIABILITY 158 | 159 | EXCEPT AS EXPRESSLY SET FORTH IN THIS AGREEMENT, NEITHER RECIPIENT NOR ANY 160 | CONTRIBUTORS SHALL HAVE ANY LIABILITY FOR ANY DIRECT, INDIRECT, INCIDENTAL, 161 | SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING WITHOUT LIMITATION 162 | LOST PROFITS), HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 163 | CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 164 | ARISING IN ANY WAY OUT OF THE USE OR DISTRIBUTION OF THE PROGRAM OR THE 165 | EXERCISE OF ANY RIGHTS GRANTED HEREUNDER, EVEN IF ADVISED OF THE POSSIBILITY 166 | OF SUCH DAMAGES. 167 | 168 | 7. GENERAL 169 | 170 | If any provision of this Agreement is invalid or unenforceable under 171 | applicable law, it shall not affect the validity or enforceability of the 172 | remainder of the terms of this Agreement, and without further action by the 173 | parties hereto, such provision shall be reformed to the minimum extent 174 | necessary to make such provision valid and enforceable. 175 | 176 | If Recipient institutes patent litigation against any entity (including a 177 | cross-claim or counterclaim in a lawsuit) alleging that the Program itself 178 | (excluding combinations of the Program with other software or hardware) 179 | infringes such Recipient's patent(s), then such Recipient's rights granted 180 | under Section 2(b) shall terminate as of the date such litigation is filed. 181 | 182 | All Recipient's rights under this Agreement shall terminate if it fails to 183 | comply with any of the material terms or conditions of this Agreement and 184 | does not cure such failure in a reasonable period of time after becoming 185 | aware of such noncompliance. If all Recipient's rights under this Agreement 186 | terminate, Recipient agrees to cease use and distribution of the Program as 187 | soon as reasonably practicable. However, Recipient's obligations under this 188 | Agreement and any licenses granted by Recipient relating to the Program shall 189 | continue and survive. 190 | 191 | Everyone is permitted to copy and distribute copies of this Agreement, but in 192 | order to avoid inconsistency the Agreement is copyrighted and may only be 193 | modified in the following manner. The Agreement Steward reserves the right to 194 | publish new versions (including revisions) of this Agreement from time to 195 | time. No one other than the Agreement Steward has the right to modify this 196 | Agreement. The Eclipse Foundation is the initial Agreement Steward. The 197 | Eclipse Foundation may assign the responsibility to serve as the Agreement 198 | Steward to a suitable separate entity. Each new version of the Agreement will 199 | be given a distinguishing version number. The Program (including 200 | Contributions) may always be distributed subject to the version of the 201 | Agreement under which it was received. In addition, after a new version of 202 | the Agreement is published, Contributor may elect to distribute the Program 203 | (including its Contributions) under the new version. Except as expressly 204 | stated in Sections 2(a) and 2(b) above, Recipient receives no rights or 205 | licenses to the intellectual property of any Contributor under this 206 | Agreement, whether expressly, by implication, estoppel or otherwise. All 207 | rights in the Program not expressly granted under this Agreement are 208 | reserved. 209 | 210 | This Agreement is governed by the laws of the State of New York and the 211 | intellectual property laws of the United States of America. No party to this 212 | Agreement will bring a legal action under this Agreement more than one year 213 | after the cause of action arose. Each party waives its rights to a jury trial 214 | in any resulting litigation. 215 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # expiring-map 2 | 3 | A Clojure wrapper for the [expiringmap](https://github.com/jhalterman/expiringmap). 4 | The expiring-map is a thread-safe mutable map that supports expiry for elements. 5 | 6 | ## Usage 7 | 8 | [![Clojars Project](http://clojars.org/expiring-map/latest-version.svg)](http://clojars.org/expiring-map) 9 | 10 | ### Basic Usage 11 | 12 | The expiry map responds to the standard collection functions such as 13 | `get`, `count`, `keys`, `vals`, and `empty?`. 14 | 15 | In addition, the map provides the following functions for mutating its values: 16 | 17 | * `assoc!` - associates a key value pair with the map 18 | * `dissoc!` - dissociates a key from the map 19 | * `clear!` - removes all key/value pairs from the map 20 | * `reset-expiration!` - resets the expirating timeout for the given key 21 | 22 | ```clojure 23 | (require '[expiring-map.core :as em]) 24 | 25 | (def cache (em/expiring-map 10)) 26 | 27 | (em/assoc! cache :foo "bar") 28 | 29 | (get cache :bar) 30 | (get cache :foo) 31 | (get cache :bar "defualt") 32 | 33 | (count cache) 34 | (vals cache) 35 | (keys cache) 36 | (empty? cache) 37 | 38 | (em/dissoc! cache :foo) 39 | 40 | (em/assoc! cache :foo "foo" :bar "bar") 41 | (em/reset-expiration! cache :foo) 42 | (em/clear! cache) 43 | ``` 44 | 45 | ### Time Units 46 | 47 | The time unit defaults to `:seconds`, the following time units are supported: 48 | 49 | * `:nanoseconds` 50 | * `:microseconds` 51 | * `:milliseconds` 52 | * `:seconds` 53 | * `:minutes` 54 | * `:hours` 55 | * `:day` 56 | 57 | e.g: 58 | 59 | ```clojure 60 | (em/expiring-map 10 {:time-unit :minutes}) 61 | ``` 62 | 63 | ### Expiration Policy 64 | 65 | The expiration policy can either be set to creation time or last access, defaults to 66 | creation time. 67 | 68 | ```clojure 69 | (def cache (em/expiring-map 70 | 10 71 | {:expiration-policy :access 72 | :time-unit :minutes})) 73 | ``` 74 | 75 | ### Listeners 76 | 77 | The map allows setting expiry listeners, a listener must be a function that 78 | accepts the key and the value that expires: 79 | 80 | ```clojure 81 | (def cache (em/expiring-map 82 | 10 83 | {:listeners [(fn [k v] (println "Expired:" k v))]})) 84 | ``` 85 | 86 | ### Criterium Benchmarks 87 | 88 | The benchmarks below test the assoc/dissoc cycle 89 | for the expiring-map, regular atom, and core.cache 90 | atom. 91 | 92 | ### atom 93 | ``` 94 | WARNING: Final GC required 409.9942905040538 % of runtime 95 | Evaluation count : 4756014 in 6 samples of 792669 calls. 96 | Execution time mean : 120.809576 ns 97 | Execution time std-deviation : 2.684070 ns 98 | Execution time lower quantile : 118.923613 ns ( 2.5%) 99 | Execution time upper quantile : 124.374281 ns (97.5%) 100 | Overhead used : 1.988494 ns 101 | ``` 102 | 103 | #### expiring-map 104 | 105 | ``` 106 | WARNING: Final GC required 481.8947027815336 % of runtime 107 | Evaluation count : 1893510 in 6 samples of 315585 calls. 108 | Execution time mean : 322.901037 ns 109 | Execution time std-deviation : 11.538941 ns 110 | Execution time lower quantile : 313.718453 ns ( 2.5%) 111 | Execution time upper quantile : 340.737836 ns (97.5%) 112 | Overhead used : 1.988494 ns 113 | 114 | Found 1 outliers in 6 samples (16.6667 %) 115 | low-severe 1 (16.6667 %) 116 | Variance from outliers : 13.8889 % Variance is moderately inflated by outliers 117 | ``` 118 | 119 | #### core.cache 120 | 121 | ``` 122 | WARNING: Final GC required 398.9148954873636 % of runtime 123 | Evaluation count : 925734 in 6 samples of 154289 calls. 124 | Execution time mean : 645.750787 ns 125 | Execution time std-deviation : 19.287433 ns 126 | Execution time lower quantile : 625.196819 ns ( 2.5%) 127 | Execution time upper quantile : 666.538213 ns (97.5%) 128 | Overhead used : 1.988494 ns 129 | ``` 130 | 131 | ## License 132 | 133 | Copyright © 2015 Dmitri Sotnikov 134 | 135 | Distributed under the [Apache 2.0 license](https://www.apache.org/licenses/LICENSE-2.0.html) 136 | -------------------------------------------------------------------------------- /project.clj: -------------------------------------------------------------------------------- 1 | (defproject expiring-map "0.1.9" 2 | :description "a thread-safe map that expires entries" 3 | :url "https://github.com/yogthos/expiring-map" 4 | :license {:name "Apache 2.0 License" 5 | :url "https://www.apache.org/licenses/LICENSE-2.0.html"} 6 | :dependencies [[org.clojure/clojure "1.8.0"] 7 | [net.jodah/expiringmap "0.5.9"]] 8 | 9 | :test-selectors {:default (complement :benchmark) 10 | :benchmark :benchmark 11 | :all (constantly true)} 12 | 13 | :profiles 14 | {:dev 15 | {:jvm-opts ["-XX:-TieredCompilation"] 16 | :global-vars {*warn-on-reflection* true} 17 | :dependencies [[criterium "0.4.3" :scope "test"] 18 | [org.clojure/core.cache "0.6.4"]]}}) 19 | -------------------------------------------------------------------------------- /src/expiring_map/core.clj: -------------------------------------------------------------------------------- 1 | (ns expiring-map.core 2 | (:refer-clojure :exclude [assoc! dissoc!]) 3 | (:import[net.jodah.expiringmap 4 | ExpirationPolicy 5 | ExpiringMap 6 | ExpiringMap$Builder 7 | ExpirationListener] 8 | java.util.concurrent.TimeUnit)) 9 | 10 | (def ^:private time-units 11 | {:nanoseconds TimeUnit/NANOSECONDS 12 | :microseconds TimeUnit/MICROSECONDS 13 | :milliseconds TimeUnit/MILLISECONDS 14 | :seconds TimeUnit/SECONDS 15 | :minutes TimeUnit/MINUTES 16 | :hours TimeUnit/HOURS 17 | :day TimeUnit/DAYS}) 18 | 19 | (def ^:private expiration-policies 20 | {:access ExpirationPolicy/ACCESSED 21 | :creation ExpirationPolicy/CREATED}) 22 | 23 | (defn- expiration-policy [^ExpiringMap$Builder builder {:keys [expiration-policy]}] 24 | (if-let [policy (expiration-policies expiration-policy)] 25 | (.expirationPolicy builder policy) 26 | builder)) 27 | 28 | (defn- set-timeout [^ExpiringMap$Builder builder timeout {:keys [time-unit]}] 29 | (.expiration builder timeout (clojure.core/get time-units time-unit TimeUnit/SECONDS))) 30 | 31 | (defn- set-max-size [^ExpiringMap$Builder builder {:keys [max-size]}] 32 | (if max-size 33 | (.maxSize builder max-size) 34 | builder)) 35 | 36 | (defn- listeners [^ExpiringMap$Builder builder {:keys [listeners]}] 37 | (reduce 38 | (fn [builder listener] 39 | (.expirationListener 40 | builder 41 | (proxy [ExpirationListener][] 42 | (expired [k v] (listener k v))))) 43 | builder listeners)) 44 | 45 | (defn expiring-map [timeout & [opts]] 46 | (-> (ExpiringMap/builder) 47 | (expiration-policy opts) 48 | (set-max-size opts) 49 | (set-timeout timeout opts) 50 | (listeners opts) 51 | (.build))) 52 | 53 | (defn assoc! 54 | ([^ExpiringMap m k v] 55 | (.put m k v) 56 | m) 57 | ([^ExpiringMap m k v & kvs] 58 | (.put m k v) 59 | (doseq [[k v] (partition 2 kvs)] 60 | (.put m k v)) 61 | m)) 62 | 63 | (defn dissoc! 64 | ([^ExpiringMap m k] (.remove m k) m) 65 | ([^ExpiringMap m k & ks] 66 | (.remove m k) 67 | (doseq [k ks] 68 | (.remove m k)) 69 | m)) 70 | 71 | (defn clear! [^ExpiringMap m] 72 | (.clear m) m) 73 | 74 | (defn reset-expiration! [^ExpiringMap m k] 75 | (.resetExpiration m k) m) 76 | -------------------------------------------------------------------------------- /test/expiring_map/benchmark.clj: -------------------------------------------------------------------------------- 1 | (ns expiring-map.benchmark 2 | (:require [clojure.test :refer :all] 3 | [criterium.core :as criterium] 4 | [clojure.core.cache :refer [ttl-cache-factory]] 5 | [expiring-map.core :as em])) 6 | 7 | (deftest ^:benchmark bench-expiring-map-assoc [] 8 | #_(println "++++ expiring-map assoc!") 9 | #_(let [cache (em/expiring-map 1 {:time-unit :hours}) 10 | value {:bar "baz" :baz [1 2 3 {:foo "bar"}]}] 11 | (criterium/quick-bench (em/assoc! cache :foo value))) 12 | 13 | #_(println "++++ atom assoc") 14 | #_(let [cache (atom {}) 15 | value {:bar "baz" :baz [1 2 3 {:foo "bar"}]}] 16 | (criterium/quick-bench (swap! cache assoc :foo value))) 17 | 18 | (println "++++ expiring-map assoc!/dissoc!") 19 | (let [cache (em/expiring-map 1 {:time-unit :hours}) 20 | value {:bar "baz" :baz [1 2 3 {:foo "bar"}]}] 21 | (criterium/quick-bench 22 | (do 23 | (em/assoc! cache :foo value) 24 | (em/dissoc! cache :foo)))) 25 | 26 | (println "++++ core.cache assoc/dissoc") 27 | (let [cache (atom (ttl-cache-factory {} :ttl (* 1000 1000))) 28 | value {:bar "baz" :baz [1 2 3 {:foo "bar"}]}] 29 | (criterium/quick-bench 30 | (do 31 | (swap! cache assoc :foo value) 32 | (swap! cache dissoc :foo value)))) 33 | 34 | (println "++++ atom assoc/dissoc") 35 | (let [cache (atom {}) 36 | value {:bar "baz" :baz [1 2 3 {:foo "bar"}]}] 37 | (criterium/quick-bench 38 | (do 39 | (swap! cache assoc :foo value) 40 | (swap! cache dissoc :foo))))) 41 | -------------------------------------------------------------------------------- /test/expiring_map/core_test.clj: -------------------------------------------------------------------------------- 1 | (ns expiring-map.core-test 2 | (:require [clojure.test :refer :all] 3 | [expiring-map.core :as em])) 4 | 5 | (deftest assoc!-get-test 6 | (let [m (em/expiring-map 10)] 7 | (em/assoc! m :foo "bar") 8 | (em/assoc! m :bar [:foo :bar 123 "baz" {:foo "bar"}]) 9 | (is (= m {:foo "bar", :bar [:foo :bar 123 "baz" {:foo "bar"}]})) 10 | (is (= "bar" (get m :foo))) 11 | (is (= [:foo :bar 123 "baz" {:foo "bar"}] (get m :bar))) 12 | (is (= "default" (get m :baz "default"))))) 13 | 14 | (deftest max-size-test 15 | (let [m (em/expiring-map 10 {:max-size 1})] 16 | (em/assoc! m :foo "bar") 17 | (em/assoc! m :moo "mar") 18 | (is (= m {:moo "mar"})))) 19 | --------------------------------------------------------------------------------