Page Speed Optimization Libraries  1.13.35.1
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Member Functions | Static Public Member Functions | List of all members
net_instaweb::MockTimeCache Class Reference

See file comment. More...

#include "mock_time_cache.h"

Inheritance diagram for net_instaweb::MockTimeCache:
net_instaweb::CacheInterface

Public Member Functions

 MockTimeCache (Scheduler *scheduler, CacheInterface *cache)
 Note: takes ownership of nothing.
 
virtual void Get (const GoogleString &key, Callback *callback)
 Reimplementations of CacheInterface methods.
 
virtual void Put (const GoogleString &key, const SharedString &value)
 
virtual void Delete (const GoogleString &key)
 
void set_delay_us (int64 delay_us)
 
int64 delay_us () const
 
Schedulerscheduler ()
 
virtual GoogleString Name () const
 
virtual bool IsBlocking () const
 
virtual bool IsHealthy () const
 
virtual void ShutDown ()
 
- Public Member Functions inherited from net_instaweb::CacheInterface
virtual void MultiGet (MultiGetRequest *request)
 
void PutSwappingString (const GoogleString &key, GoogleString *value)
 
virtual CacheInterfaceBackend ()
 
virtual bool MustEncodeKeyInValueOnPut () const
 
virtual void PutWithKeyInValue (const GoogleString &key, const SharedString &key_and_value)
 

Static Public Member Functions

static GoogleString FormatName (StringPiece name)
 
- 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< KeyCallbackMultiGetRequest
 
- 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

See file comment.

Member Function Documentation

virtual bool net_instaweb::MockTimeCache::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::MockTimeCache::IsHealthy ( ) const
inlinevirtual

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::MockTimeCache::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::MockTimeCache::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.

void net_instaweb::MockTimeCache::set_delay_us ( int64  delay_us)
inline

Sets the delay the cache will inject before invoking the callbacks. Note that this only affects the 'Done' callback; 'ValidateCandidate' happens immediately.

virtual void net_instaweb::MockTimeCache::ShutDown ( )
inlinevirtual

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: