net_instaweb::ThreadsafeCache Class Reference

#include "threadsafe_cache.h"

Inheritance diagram for net_instaweb::ThreadsafeCache:

Public Member Functions
	ThreadsafeCache (CacheInterface *cache, AbstractMutex *mutex)
	Does not takes ownership of cache. Takes ownership of mutex.
virtual void	Get (const GoogleString &key, Callback *callback)
virtual void	Put (const GoogleString &key, const SharedString &value) LOCKS_EXCLUDED(mutex_)
virtual void	Delete (const GoogleString &key) LOCKS_EXCLUDED(mutex_)
virtual CacheInterface *	Backend ()
virtual bool	IsBlocking () const
virtual bool	IsHealthy () const LOCKS_EXCLUDED(mutex_)
virtual void	ShutDown () LOCKS_EXCLUDED(mutex_)
virtual GoogleString	Name () const
Public Member Functions inherited from net_instaweb::CacheInterface
virtual void	MultiGet (MultiGetRequest *request)
void	PutSwappingString (const GoogleString &key, GoogleString *value)
virtual bool	MustEncodeKeyInValueOnPut () const
virtual void	PutWithKeyInValue (const GoogleString &key, const SharedString &key_and_value)

Static Public Member Functions
static GoogleString	FormatName (StringPiece cache)
Static Public Member Functions inherited from net_instaweb::CacheInterface
static const char *	KeyStateName (KeyState state)

Additional Inherited Members
Public Types inherited from net_instaweb::CacheInterface
enum	KeyState {   kAvailable = 0, kNotFound = 1, kOverload = 2, kNetworkError = 3,   kTimeout = 4 }
typedef std::vector< KeyCallback >	MultiGetRequest
Protected Member Functions inherited from net_instaweb::CacheInterface
void	ValidateAndReportResult (const GoogleString &key, KeyState state, Callback *callback)
	Invokes callback->ValidateCandidate() and callback->Done() as appropriate.
void	ReportMultiGetNotFound (MultiGetRequest *request)

Detailed Description

Composes a cache with a Mutex to form a threadsafe cache. Note that cache callbacks will be run in a thread that is dependent on the cache implementation. This wrapper class just guarantees the thread safety of the cache itself, not the callbacks.

WARNING: THIS IMPLEMENTATION HOLDS A LOCK ACROSS THE VALIDATOR.

Todo:

TODO(jmarantz): redesign the interface between this class and the cache it protects.

Member Function Documentation

virtual CacheInterface* net_instaweb::ThreadsafeCache::Backend ( )

inlinevirtual

If this cache is merely a wrapper around a backend that actually does all the work, returns that backend cache object. Otherwise just returns 'this'. Used for testing.

Reimplemented from net_instaweb::CacheInterface.

virtual void net_instaweb::ThreadsafeCache::Get ( const GoogleString &  key, Callback *  callback  )

virtual

Initiates a cache fetch, calling callback->ValidateCandidate() and then callback->Done(state) when done.

Note: implementations should normally invoke the callback via ValidateAndReportResult, which will combine ValidateCandidate() and Done() together properly.

Implements net_instaweb::CacheInterface.

virtual bool net_instaweb::ThreadsafeCache::IsBlocking ( ) const

inlinevirtual

Returns true if this cache is guaranteed to call its callbacks before returning from Get and MultiGet.

Implements net_instaweb::CacheInterface.

virtual bool net_instaweb::ThreadsafeCache::IsHealthy ( ) const

virtual

IsHealthy() is a rough estimation of whether cache is available for any operations. If it's false, caller may reasonably expect that making calls right now is useless as they will fail or have high latency. If it's true, operations should succeed, but some still may fail occasionally. The primary goal is to avoid sending commands to 'unhealthy' caches, e.g. if cache is under heavy load, we do not want to send even more requests.

Memory and file-based caches can simply return 'true'. It should be safe to call this frequently – the implementation shouldn't do much more that check a bool flag under mutex.

Implements net_instaweb::CacheInterface.

virtual GoogleString net_instaweb::ThreadsafeCache::Name ( ) const

inlinevirtual

The name of this CacheInterface – used for logging and debugging.

It is strongly recommended that you provide a static GoogleString FormatName(...) method for use in formatting the Name() return, and in testing, e.g. in third_party/pagespeed/system/system_caches_test.cc.

Implements net_instaweb::CacheInterface.

virtual void net_instaweb::ThreadsafeCache::Put ( const GoogleString &  key, const SharedString &  value  )

virtual

Puts a value into the cache. The value that is passed in is not modified, but the SharedString is passed by non-const pointer because its reference count is bumped.

Implements net_instaweb::CacheInterface.

virtual void net_instaweb::ThreadsafeCache::ShutDown ( )

virtual

Stops all cache activity. Further Put/Delete calls will be dropped, and MultiGet/Get will call the callback with kNotFound immediately. Note there is no Enable(); once the cache is stopped it is stopped forever. This function is intended for use during process shutdown.

Implements net_instaweb::CacheInterface.

---

The documentation for this class was generated from the following file:

• pagespeed/kernel/cache/threadsafe_cache.h