Page Speed Optimization Libraries  1.4.26.1
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines
Public Member Functions | Public Attributes
net_instaweb::CacheTestBase::Callback Class Reference

#include "cache_test_base.h"

Inheritance diagram for net_instaweb::CacheTestBase::Callback:
net_instaweb::CacheInterface::SynchronousCallback net_instaweb::CacheInterface::Callback

List of all members.

Public Member Functions

 Callback (CacheTestBase *test)
CallbackReset ()
 super.value() is used to get/set the value.
virtual bool ValidateCandidate (const GoogleString &key, CacheInterface::KeyState state)
virtual void Done (CacheInterface::KeyState state)
virtual void Wait ()
void set_invalid_value (const char *v)
StringPiece value_str ()

Public Attributes

bool validate_called_
bool noop_wait_called_
bool value_of_called_when_wait_was_invoked_

Detailed Description

Helper class for calling Get on cache implementations that are blocking in nature (e.g. in-memory LRU or blocking file-system). Also tests the CacheInterface::SynchronousCallback class in the process.


Member Function Documentation

virtual void net_instaweb::CacheTestBase::Callback::Done ( CacheInterface::KeyState  state) [inline, virtual]

This method is called once the cache implementation has found a match that was accepted by ValidateCandidate (in which case state == kAvailable) or it has failed to do so (state == kNotFound).

Implementations are free to invoke cache operations, as all cache locks are guaranteed to be released.

Reimplemented from net_instaweb::CacheInterface::SynchronousCallback.

virtual bool net_instaweb::CacheTestBase::Callback::ValidateCandidate ( const GoogleString key,
CacheInterface::KeyState  state 
) [inline, virtual]

This method exists to let cache clients do application-specific validation of cache results. This is important for 2-level caches, as with distributed setups it's possible that an entry in the L1 is invalid (e.g. an HTTP resource past expiration), while the L2 cache has a valid result.

This method will be invoked for all potential cache results, (with the value filled in into value()). Returning 'false' lets the implementation effectively veto a value as expired or invalid for semantic reasons.

Note that implementations may not invoke any cache operations, as it may be invoked with locks held.

Reimplemented from net_instaweb::CacheInterface::Callback.

virtual void net_instaweb::CacheTestBase::Callback::Wait ( ) [inline, virtual]

The default implementation has an empty Wait implementation. If you override this, be sure also to call set_mutex() from the test subclass constructor or SetUp to protect outstanding_fetches_.


The documentation for this class was generated from the following file:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines