dalli 1.1.4 → 2.7.11

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 4bc4fe873fe9319c9297219b7908d576470551d0e011d1299e54ebc162256a68
+  data.tar.gz: b60393783d05152ad67aa12298f6867127f973fbf07cd2d0dc90ab96b1d7971f
+SHA512:
+  metadata.gz: 1348b528243f253c111ad74e17a0ba20d8d14eb29d4f41e15f60bb2c87505c6d09404217c868f1623bd68f1ad70a644efd09fd1acca0ba2a1d0b6395387967ae
+  data.tar.gz: 108c5477c6399ef838a8df14e4878509ec5f7c22c33d012c19a9deb635901e9251a52c392c080fd6eb65dfb54e8084ee70cf6668a6914fd1336120aabb19b4f9

data/Gemfile

@@ -1,11 +1,15 @@
-source :rubygems
+source 'https://rubygems.org'
 
 gemspec
 
-gem 'rake'
-gem 'em-synchrony', :platforms => :mri_19
-gem 'em-spec', :platforms => :mri_19
+gem 'appraisal'
+gem 'kgio', :platform => :mri
+gem 'rails'
 
 group :test do
+  gem 'minitest'
+  gem 'mocha'
+  gem 'rake'
+  gem 'connection_pool'
   gem 'simplecov'
 end

data/History.md

@@ -1,6 +1,272 @@
 Dalli Changelog
 =====================
 
+2.7.11
+==========
+- DEPRECATION: :dalli_store will be removed in Dalli 3.0.
+  Use Rails' official :mem_cache_store instead.
+  https://guides.rubyonrails.org/caching_with_rails.html
+- Add new `digest_class` option to Dalli::Client [#724]
+- Don't treat NameError as a network error [#728]
+- Handle nested comma separated server strings (sambostock)
+
+2.7.10
+==========
+- Revert frozen string change (schneems)
+- Advertise supports_cached_versioning? in DalliStore (schneems)
+- Better detection of fork support, to allow specs to run under Truffle Ruby (deepj)
+- Update logging for over max size to log as error (aeroastro)
+
+2.7.9
+==========
+- Fix behavior for Rails 5.2+ cache_versioning (GriwMF)
+- Ensure fetch provides the key to the fallback block as an argument (0exp)
+- Assorted performance improvements (schneems)
+
+2.7.8
+==========
+- Rails 5.2 compatibility (pbougie)
+- Fix Session Cache compatibility (pixeltrix)
+
+2.7.7
+==========
+- Support large cache keys on fetch multi (sobrinho)
+- Not found checks no longer trigger the result's equality method (dannyfallon)
+- Use SVG build badges (olleolleolle)
+- Travis updates (junaruga, tiarly, petergoldstein)
+- Update default down_retry_delay (jaredhales)
+- Close kgio socket after IO.select timeouts
+- Documentation updates (tipair)
+- Instrument DalliStore errors with instrument_errors configuration option. (btatnall)
+
+2.7.6
+==========
+- Rails 5.0.0.beta2 compatibility (yui-knk, petergoldstein)
+- Add cas!, a variant of the #cas method that yields to the block whether or not the key already exist (mwpastore)
+- Performance improvements (nateberkopec)
+- Add Ruby 2.3.0 to support matrix (tricknotes)
+
+2.7.5
+==========
+
+- Support rcvbuff and sndbuff byte configuration. (btatnall)
+- Add `:cache_nils` option to support nil values in `DalliStore#fetch` and `Dalli::Client#fetch` (wjordan, #559)
+- Log retryable server errors with 'warn' instead of 'info' (phrinx)
+- Fix timeout issue with Dalli::Client#get_multi_yielder (dspeterson)
+- Escape namespaces with special regexp characters (Steven Peckins)
+- Ensure LocalCache supports the `:raw` option and Entry unwrapping (sj26)
+- Ensure bad ttl values don't cause Dalli::RingError (eagletmt, petergoldstein)
+- Always pass namespaced key to instrumentation API (kaorimatz)
+- Replace use of deprecated TimeoutError with Timeout::Error (eagletmt)
+- Clean up gemspec, and use Bundler for loading (grosser)
+- Dry up local cache testing (grosser)
+
+2.7.4
+==========
+
+- Restore Windows compatibility (dfens, #524)
+
+2.7.3
+==========
+
+- Assorted spec improvements
+- README changes to specify defaults for failover and compress options (keen99, #470)
+- SASL authentication changes to deal with Unicode characters (flypiggy, #477)
+- Call to_i on ttl to accomodate ActiveSupport::Duration (#494)
+- Change to implicit blocks for performance (glaucocustodio, #495)
+- Change to each_key for performance (jastix, #496)
+- Support stats settings - (dterei, #500)
+- Raise DallError if hostname canno be parsed (dannyfallon, #501)
+- Fix instrumentation for falsey values (AlexRiedler, #514)
+- Support UNIX socket configurations (r-stu31, #515)
+
+2.7.2
+==========
+
+- The fix for #423 didn't make it into the released 2.7.1 gem somehow.
+
+2.7.1
+==========
+
+- Rack session will check if servers are up on initialization (arthurnn, #423)
+- Add support for IPv6 addresses in hex form, ie: "[::1]:11211" (dplummer, #428)
+- Add symbol support for namespace (jingkai #431)
+- Support expiration intervals longer than 30 days (leonid-shevtsov #436)
+
+2.7.0
+==========
+
+- BREAKING CHANGE:
+  Dalli::Client#add and #replace now return a truthy value, not boolean true or false.
+- Multithreading support with dalli\_store:
+  Use :pool\_size to create a pool of shared, threadsafe Dalli clients in Rails:
+```ruby
+    config.cache_store = :dalli_store, "cache-1.example.com", "cache-2.example.com", :compress => true, :pool_size => 5, :expires_in => 300
+```
+  This will ensure the Rails.cache singleton does not become a source of contention.
+  **PLEASE NOTE** Rails's :mem\_cache\_store does not support pooling as of
+Rails 4.0.  You must use :dalli\_store.
+
+- Implement `version` for retrieving version of connected servers [dterei, #384]
+- Implement `fetch_multi` for batched read/write [sorentwo, #380]
+- Add more support for safe updates with multiple writers: [philipmw, #395]
+  `require 'dalli/cas/client'` augments Dalli::Client with the following methods:
+  * Get value with CAS:            `[value, cas] = get_cas(key)`
+                                   `get_cas(key) {|value, cas| ...}`
+  * Get multiple values with CAS:  `get_multi_cas(k1, k2, ...) {|value, metadata| cas = metadata[:cas]}`
+  * Set value with CAS:            `new_cas = set_cas(key, value, cas, ttl, options)`
+  * Replace value with CAS:        `replace_cas(key, new_value, cas, ttl, options)`
+  * Delete value with CAS:         `delete_cas(key, cas)`
+- Fix bug with get key with "Not found" value [uzzz, #375]
+
+2.6.4
+=======
+
+- Fix ADD command, aka `write(unless_exist: true)` (pitr, #365)
+- Upgrade test suite from mini\_shoulda to minitest.
+- Even more performance improvements for get\_multi (xaop, #331)
+
+2.6.3
+=======
+
+- Support specific stats by passing `:items` or `:slabs` to `stats` method [bukhamseen]
+- Fix 'can't modify frozen String' errors in `ActiveSupport::Cache::DalliStore` [dblock]
+- Protect against objects with custom equality checking [theron17]
+- Warn if value for key is too large to store [locriani]
+
+2.6.2
+=======
+
+- Properly handle missing RubyInline
+
+2.6.1
+=======
+
+- Add optional native C binary search for ring, add:
+
+gem 'RubyInline'
+
+  to your Gemfile to get a 10% speedup when using many servers.
+  You will see no improvement if you are only using one server.
+
+- More get_multi performance optimization [xaop, #315]
+- Add lambda support for cache namespaces [joshwlewis, #311]
+
+2.6.0
+=======
+
+- read_multi optimization, now checks local_cache [chendo, #306]
+- Re-implement get_multi to be non-blocking [tmm1, #295]
+- Add `dalli` accessor to dalli_store to access the underlying
+Dalli::Client, for things like `get_multi`.
+- Add `Dalli::GzipCompressor`, primarily for compatibility with nginx's HttpMemcachedModule using `memcached_gzip_flag`
+
+2.5.0
+=======
+
+- Don't escape non-ASCII keys, memcached binary protocol doesn't care. [#257]
+- :dalli_store now implements LocalCache [#236]
+- Removed lots of old session_store test code, tests now all run without a default memcached server [#275]
+- Changed Dalli ActiveSupport adapter to always attempt instrumentation [brianmario, #284]
+- Change write operations (add/set/replace) to return false when value is too large to store [brianmario, #283]
+- Allowing different compressors per client [naseem]
+
+2.4.0
+=======
+- Added the ability to swap out the compressed used to [de]compress cache data [brianmario, #276]
+- Fix get\_multi performance issues with lots of memcached servers [tmm1]
+- Throw more specific exceptions [tmm1]
+- Allowing different types of serialization per client [naseem]
+
+2.3.0
+=======
+- Added the ability to swap out the serializer used to [de]serialize cache data [brianmario, #274]
+
+2.2.1
+=======
+
+- Fix issues with ENV-based connections. [#266]
+- Fix problem with SessionStore in Rails 4.0 [#265]
+
+2.2.0
+=======
+
+- Add Rack session with\_lock helper, for Rails 4.0 support [#264]
+- Accept connection string in the form of a URL (e.g., memcached://user:pass@hostname:port) [glenngillen]
+- Add touch operation [#228, uzzz]
+
+2.1.0
+=======
+
+- Add Railtie to auto-configure Dalli when included in Gemfile [#217, steveklabnik]
+
+2.0.5
+=======
+
+- Create proper keys for arrays of objects passed as keys [twinturbo, #211]
+- Handle long key with namespace [#212]
+- Add NODELAY to TCP socket options [#206]
+
+2.0.4
+=======
+
+- Dalli no longer needs to be reset after Unicorn/Passenger fork [#208]
+- Add option to re-raise errors rescued in the session and cache stores. [pitr, #200]
+- DalliStore#fetch called the block if the cached value == false [#205]
+- DalliStore should have accessible options [#195]
+- Add silence and mute support for DalliStore [#207]
+- Tracked down and fixed socket corruption due to Timeout [#146]
+
+2.0.3
+=======
+
+- Allow proper retrieval of stored `false` values [laserlemon, #197]
+- Allow non-ascii and whitespace keys, only the text protocol has those restrictions [#145]
+- Fix DalliStore#delete error-handling [#196]
+
+2.0.2
+=======
+
+- Fix all dalli\_store operations to handle nil options [#190]
+- Increment and decrement with :initial => nil now return nil (lawrencepit, #112)
+
+2.0.1
+=======
+
+- Fix nil option handling in dalli\_store#write [#188]
+
+2.0.0
+=======
+
+- Reimplemented the Rails' dalli\_store to remove use of
+  ActiveSupport::Cache::Entry which added 109 bytes overhead to every
+  value stored, was a performance bottleneck and duplicated a lot of
+  functionality already in Dalli.  One benchmark went from 4.0 sec to 3.0
+  sec with the new dalli\_store. [#173]
+- Added reset\_stats operation [#155]
+- Added support for configuring keepalive on TCP connections to memcached servers (@bianster, #180)
+
+Notes:
+
+  * data stored with dalli\_store 2.x is NOT backwards compatible with 1.x.
+    Upgraders are advised to namespace their keys and roll out the 2.x
+    upgrade slowly so keys do not clash and caches are warmed.
+    `config.cache_store = :dalli_store, :expires_in => 24.hours.to_i, :namespace => 'myapp2'`
+  * data stored with plain Dalli::Client API is unchanged.
+  * removed support for dalli\_store's race\_condition\_ttl option.
+  * removed support for em-synchrony and unix socket connection options.
+  * removed support for Ruby 1.8.6
+  * removed memcache-client compability layer and upgrade documentation.
+
+
+1.1.5
+=======
+
+- Coerce input to incr/decr to integer via #to\_i [#165]
+- Convert test suite to minitest/spec (crigor, #166)
+- Fix encoding issue with keys [#162]
+- Fix double namespacing with Rails and dalli\_store. [#160]
+
 1.1.4
 =======
 
@@ -70,7 +336,7 @@ v1.1.0 was a bad release.  Yanked.
  - Allow browser session cookies (blindsey)
  - Compatibility fixes (mwynholds)
  - Add backwards compatibility module for memcache-client, require 'dalli/memcache-client'.  It makes
-   Dalli more compatible with memcache-client and prints out a warning any time you do something that 
+   Dalli more compatible with memcache-client and prints out a warning any time you do something that
    is no longer supported so you can fix your code.
 
 1.0.1

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2011 Mike Perham
+Copyright (c) Peter M. Goldstein, Mike Perham
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -1,126 +1,158 @@
-Dalli
-=========
+Dalli [![Build Status](https://secure.travis-ci.org/petergoldstein/dalli.svg)](http://travis-ci.org/petergoldstein/dalli)
+=====
 
-Dalli is a high performance pure Ruby client for accessing memcached servers.  It works with memcached 1.4+ only as it uses the newer binary protocol.  It should be considered a replacement for the memcache-client gem.  The API tries to be mostly compatible with memcache-client with the goal being to make it a drop-in replacement for Rails.
+Dalli is a high performance pure Ruby client for accessing memcached servers.  It works with memcached 1.4+ only as it uses the newer binary protocol.  It should be considered a replacement for the memcache-client gem.
 
 The name is a variant of Salvador Dali for his famous painting [The Persistence of Memory](http://en.wikipedia.org/wiki/The_Persistence_of_Memory).
 
 ![Persistence of Memory](http://www.virtualdali.com/assets/paintings/31PersistenceOfMemory.jpg)
 
-Dalli's development is sponsored by [Membase](http://www.membase.com/).  Many thanks to them!
-
-
-Design
-------------
-
-I decided to write Dalli after maintaining memcache-client for the last two years for a few specific reasons:
-
- 0. The code is mostly old and gross.  The bulk of the code is a single 1000 line .rb file.
- 1. It has a lot of options that are infrequently used which complicate the codebase.
- 2. The implementation has no single point to attach monitoring hooks.
- 3. Uses the old text protocol, which hurts raw performance.
-
-So a few notes.  Dalli:
-
- 0. uses the exact same algorithm to choose a server so existing memcached clusters with TBs of data will work identically to memcache-client.
- 1. is approximately 20% faster than memcache-client (which itself was heavily optimized) in Ruby 1.9.2.
- 2. contains explicit "chokepoint" methods which handle all requests; these can be hooked into by monitoring tools (NewRelic, Rack::Bug, etc) to track memcached usage.
- 3. comes with hooks to replace memcache-client in Rails.
- 4. supports SASL for use in managed environments, e.g. Heroku.
- 5. provides proper failover with recovery and adjustable timeouts
- 6. has a backwards-compatibility mode for people migrating from memcache-client (see Upgrade.md).
-
+Dalli's initial development was sponsored by [CouchBase](http://www.couchbase.com/).  Many thanks to them!
 
 Supported Ruby versions and implementations
 ------------------------------------------------
 
-Dalli is geared towards 1.9.2+ but known to work on
+Dalli should work identically on:
+
+ * JRuby 1.6+
+ * Ruby 1.9.3+
+ * Rubinius 2.0
 
- * Ruby 1.9.2
- * Ruby 1.9.3
- * Ruby 1.8.7
- * Rubinius 2.0 Preview
+If you have problems, please enter an issue.
 
 
 Installation and Usage
 ------------------------
 
-Remember, Dalli **requires** memcached 1.4+. You can check the version with `memcached -h`. Please note that memcached that Mac OS X Snow Leopard ships with is 1.2.8 and
-won't work. Install 1.4.x using Homebrew with
+Remember, Dalli **requires** memcached 1.4+. You can check the version with `memcached -h`. Please note that the memcached version that *Mac OS X Snow Leopard* ships with is 1.2.8 and it won't work. Install memcached 1.4.x using Homebrew with
 
     brew install memcached
 
+On Ubuntu you can install it by running:
 
-You can verify your installation using this piece of code:
+    apt-get install memcached
 
-    gem install dalli
+You can verify your installation using this piece of code:
 
-    require 'dalli'
-    dc = Dalli::Client.new('localhost:11211')
-    dc.set('abc', 123)
-    value = dc.get('abc')
+```bash
+gem install dalli
+```
 
-The test suite requires memcached 1.4.3+ with SASL enabled (brew install memcached --enable-sasl ; mv /usr/bin/memcached /usr/bin/memcached.old).  Currently only supports the PLAIN mechanism.
+```ruby
+require 'dalli'
+options = { :namespace => "app_v1", :compress => true }
+dc = Dalli::Client.new('localhost:11211', options)
+dc.set('abc', 123)
+value = dc.get('abc')
+```
 
-Dalli has no runtime dependencies and never will.  You can optionally install the 'kgio' gem to
-give Dalli a 10-20% performance boost.
+The test suite requires memcached 1.4.3+ with SASL enabled (`brew install memcached --enable-sasl ; mv /usr/bin/memcached /usr/bin/memcached.old`).  Currently only supports the PLAIN mechanism.
 
+Dalli has no runtime dependencies.
 
-Usage with Rails 3.x
+Usage with Rails 3.x and 4.x
 ---------------------------
 
 In your Gemfile:
 
-    gem 'dalli'
+```ruby
+gem 'dalli'
+```
 
 In `config/environments/production.rb`:
 
-    config.cache_store = :dalli_store
+```ruby
+config.cache_store = :dalli_store
+```
 
-A more comprehensive example (note that we are setting a reasonable default for maximum cache entry lifetime (one day), enabling compression for large values, and namespacing all entries for this rails app.  Remove the namespace if you have multiple apps which share cached values):
+Here's a more comprehensive example that sets a reasonable default for maximum cache entry lifetime (one day), enables compression for large values and namespaces all entries for this rails app.  Remove the namespace if you have multiple apps which share cached values.
 
-    config.cache_store = :dalli_store, 'cache-1.example.com', 'cache-2.example.com',
-        { :namespace => NAME_OF_RAILS_APP, :expires_in => 1.day, :compression => true }
+```ruby
+config.cache_store = :dalli_store, 'cache-1.example.com', 'cache-2.example.com:11211:2',
+  { :namespace => NAME_OF_RAILS_APP, :expires_in => 1.day, :compress => true }
+```
 
-To use Dalli for Rails session storage, in `config/initializers/session_store.rb`:
+You can specify a port and a weight by appending to the server name. You may wish to increase the weight of a server with more memory configured.  (e.g. to specify port 11211 and a weight of 2, append `:11211:2` ) 
 
-    require 'action_dispatch/middleware/session/dalli_store'
-    Rails.application.config.session_store :dalli_store, :memcache_server => ['host1', 'host2'], :namespace => 'sessions', :key => '_foundation_session', :expire_after => 30.minutes
+If your servers are specified in `ENV["MEMCACHE_SERVERS"]` (e.g. on Heroku when using a third-party hosted addon), simply provide `nil` for the servers:
 
+```ruby
+config.cache_store = :dalli_store, nil, { :namespace => NAME_OF_RAILS_APP, :expires_in => 1.day, :compress => true }
+```
 
-Usage with Rails 2.3.x
-----------------------------
+To use Dalli for Rails session storage that times out after 20 minutes, in `config/initializers/session_store.rb`:
 
-Dalli v1.1+ does not support Rails 2.3.  Please use an earlier version: gem install dalli -v "~> 1.0.4"
+For Rails >= 3.2.4:
 
+```ruby
+Rails.application.config.session_store ActionDispatch::Session::CacheStore, :expire_after => 20.minutes
+```
 
-Usage with Passenger
-------------------------
+For Rails 3.x:
+
+```ruby
+require 'action_dispatch/middleware/session/dalli_store'
+Rails.application.config.session_store :dalli_store, :memcache_server => ['host1', 'host2'], :namespace => 'sessions', :key => '_foundation_session', :expire_after => 20.minutes
+```
+
+Dalli does not support Rails 2.x.
+
+
+Multithreading and Rails
+--------------------------
+
+If you use Puma or another threaded app server, as of Dalli 2.7, you can use a pool
+of Dalli clients with Rails to ensure the `Rails.cache` singleton does not become a
+source of thread contention.  You must add `gem 'connection_pool'` to your Gemfile and
+add :pool\_size to your `dalli_store` config:
+
+```ruby
+config.cache_store = :dalli_store, 'cache-1.example.com', { :pool_size => 5 }
+```
 
-Put this at the bottom of `config/environment.rb`:
+You can then use the Rails cache as normal and Rails.cache will use the pool transparently under the covers, or you can check out a Dalli client directly from the pool:
 
-    if defined?(PhusionPassenger)
-      PhusionPassenger.on_event(:starting_worker_process) do |forked|
-        # Reset Rails's object cache
-        # Only works with DalliStore
-        Rails.cache.reset if forked
+```ruby
+Rails.cache.fetch('foo', :expires_in => 300) do
+  'bar'
+end
 
-        # Reset Rails's session store
-        # If you know a cleaner way to find the session store instance, please let me know
-        ObjectSpace.each_object(ActionDispatch::Session::DalliStore) { |obj| obj.reset }
-      end
-    end
+Rails.cache.dalli.with do |client|
+  # client is a Dalli::Client instance which you can
+  # use ONLY within this block
+end
+```
 
 
 Configuration
 ------------------------
+
+**servers**: An Array of "host:port:weight" where weight allows you to distribute cache unevenly.
+
 Dalli::Client accepts the following options. All times are in seconds.
 
-**expires_in**: Global default for key TTL.  No default.
+**expires_in**: Global default for key TTL.  Default is 0, which means no expiry.
+
+**namespace**: If specified, prepends each key with this value to provide simple namespacing.  Default is nil.
+
+**failover**: Boolean, if true Dalli will failover to another server if the main server for a key is down.  Default is true.
+
+**threadsafe**: Boolean.  If true Dalli ensures that only one thread is using a socket at a given time. Default is true. You can set to false if you are using the Client within a thread-safe connection pool.
+
+**serializer**: The serializer to use for objects being stored (ex. JSON).
+Default is Marshal.
+
+**compress**: Boolean, if true Dalli will gzip-compress values larger than 1K. Default is false.
+
+**compression_min_size**: Minimum value byte size for which to attempt compression. Default is 1K.
+
+**compression_max_size**: Maximum value byte size for which to attempt compression. Default is unlimited.
 
-**failover**: Boolean, if true Dalli will failover to another server if the main server for a key is down.
+**compressor**: The compressor to use for objects being stored.
+Default is zlib, implemented under `Dalli::Compressor`.
+If serving compressed data using nginx's HttpMemcachedModule, set `memcached_gzip_flag 2` and use `Dalli::GzipCompressor`
 
-**compression**: Boolean, if true Dalli will gzip-compress values larger than 1K.
+**keepalive**: Boolean. If true, Dalli will enable keep-alive for socket connections.  Default is true.
 
 **socket_timeout**: Timeout for all socket operations (connect, read, write). Default is 0.5.
 
@@ -128,53 +160,65 @@ Dalli::Client accepts the following options. All times are in seconds.
 
 **socket_failure_delay**: Before retrying a socket operation, the process sleeps for this amount of time. Default is 0.01.  Set to nil for no delay.
 
-**down_retry_delay**: When a server has been marked down due to many failures, the server will be checked again for being alive only after this amount of time. Don't set this value to low, otherwise each request which tries the failed server might hang for the maximum **socket_timeout**. Default is 1 second.
+**down_retry_delay**: When a server has been marked down due to many failures, the server will be checked again for being alive only after this amount of time. Don't set this value too low, otherwise each request which tries the failed server might hang for the maximum **socket_timeout**. Default is 60 seconds.
 
 **value_max_bytes**: The maximum size of a value in memcached.  Defaults to 1MB, this can be increased with memcached's -I parameter.  You must also configure Dalli to allow the larger size here.
 
+**error_when_over_max_size**: Boolean. If true, Dalli will throw a Dalli::ValueOverMaxSize exception when trying to store data larger than **value_max_bytes**. Defaults to false, meaning only a warning is logged.
+
 **username**: The username to use for authenticating this client instance against a SASL-enabled memcached server.  Heroku users should not need to use this normally.
 
 **password**: The password to use for authenticating this client instance against a SASL-enabled memcached server.  Heroku users should not need to use this normally.
 
-**async**: Boolean, if true Dalli will assume its running inside the EventMachine reactor and use EM through the em-synchrony gem.  Currently disables the socket_timeout option. Default is false.
+**sndbuf**: In bytes, set the socket SO_SNDBUF. Defaults to operating system default.
+
+**rcvbuf**: In bytes, set the socket SO_RCVBUF. Defaults to operating system default.
+
+**cache_nils**: Boolean. If true Dalli will not treat cached `nil` values as 'not found' for `#fetch` operations. Default is false.
+
+**raise_errors**: Boolean. When true DalliStore will reraise Dalli:DalliError instead swallowing the error. Default is false.
+
+**instrument_errors**: Boolean. When true DalliStore will send notification of Dalli::DalliError via a 'cache_error.active_support' event. Default is false.
 
 Features and Changes
 ------------------------
 
-Dalli is **NOT** 100% API compatible with memcache-client.  If you have code which uses the MemCache API directly, it will likely need small tweaks.  Method parameters and return values changed slightly.  See Upgrade.md for more detail.
+By default, Dalli is thread-safe. Disable thread-safety at your own peril.
 
-By default, Dalli is thread-safe.  Disable thread-safety at your own peril.
-
-Multi-threaded use will fail if used with EventMachine.
+Dalli does not need anything special in Unicorn/Passenger since 2.0.4.
+It will detect sockets shared with child processes and gracefully reopen the
+socket.
 
 Note that Dalli does not require ActiveSupport or Rails.  You can safely use it in your own Ruby projects.
 
+[View the Client API](http://www.rubydoc.info/github/mperham/dalli/Dalli/Client)
 
 Helping Out
 -------------
 
-If you have a fix you wish to provide, please fork the code, fix in your local project and then send a pull request on github.  Please ensure that you include a test which verifies your fix and update History.md with a one sentence description of your fix so you get credit as a contributor.
+If you have a fix you wish to provide, please fork the code, fix in your local project and then send a pull request on github.  Please ensure that you include a test which verifies your fix and update `History.md` with a one sentence description of your fix so you get credit as a contributor.
 
+We're not accepting new compressors. They are trivial to add in an initializer. See #385 (LZ4), #406 (Snappy)
 
 Thanks
 ------------
 
-Eric Wong - for help using his [kgio](http://unicorn.bogomips.org/kgio/index.html) library.
-
-Brian Mitchell - for his remix-stash project which was helpful when implementing and testing the binary protocol support.
+Mike Perham - for originally authoring the Dalli project and serving as maintainer and primary contributor
 
-[Membase](http://membase.com) - for their project sponsorship
+Eric Wong - for help using his [kgio](http://bogomips.org/kgio/) library.
 
-[Bootspring](http://bootspring.com) is my Ruby and Rails consulting company.  We specialize in Ruby infrastructure, performance and scalability tuning for Rails applications.  If you need help, please [contact us](mailto:info@bootspring.com) today.
+Brian Mitchell - for his remix-stash project which was helpful when implementing and testing the binary protocol support.
 
+[CouchBase](http://couchbase.com) - for their project sponsorship
 
-Author
+Authors
 ----------
 
-Mike Perham, mperham@gmail.com, [mikeperham.com](http://mikeperham.com), [@mperham](http://twitter.com/mperham)  If you like and use this project, please give me a recommendation at [WWR](http://workingwithrails.com/person/10797-mike-perham).  Happy caching!
+* [Peter M. Goldstein](https://github.com/petergoldstein) - current maintainer
+* [Mike Perham](https://github.com/mperham) and contributors
 
 
 Copyright
 -----------
 
-Copyright (c) 2010 Mike Perham. See LICENSE for details.
+Copyright (c) Mike Perham, Peter M. Goldstein. See LICENSE for details.