Public Member Functions | List of all members
Store::Controlled Class Referenceabstract

#include <Controlled.h>

Inheritance diagram for Store::Controlled:
Inheritance graph
[legend]
Collaboration diagram for Store::Controlled:
Collaboration graph
[legend]

Public Member Functions

virtual StoreEntry * get (const cache_key *)=0
 
virtual void reference (StoreEntry &e)=0
 somebody needs this entry (many cache replacement policies need to know) More...
 
virtual bool dereference (StoreEntry &e)=0
 
virtual void updateHeaders (StoreEntry *)
 make stored metadata and HTTP headers the same as in the given entry More...
 
virtual bool anchorToCache (StoreEntry &)
 
virtual bool updateAnchored (StoreEntry &)
 
virtual void create ()=0
 create system resources needed for this store to operate in the future More...
 
virtual void init ()=0
 
virtual uint64_t maxSize () const =0
 
virtual uint64_t minSize () const =0
 the minimum size the store will shrink to via normal housekeeping More...
 
virtual uint64_t currentSize () const =0
 current size More...
 
virtual uint64_t currentCount () const =0
 the total number of objects stored right now More...
 
virtual int64_t maxObjectSize () const =0
 the maximum size of a storable object; -1 if unlimited More...
 
virtual void getStats (StoreInfoStats &stats) const =0
 collect statistics More...
 
virtual void stat (StoreEntry &e) const =0
 
virtual void evictCached (StoreEntry &e)=0
 
virtual void evictIfFound (const cache_key *)=0
 
virtual int callback ()
 called once every main loop iteration; TODO: Move to UFS code. More...
 
virtual void maintain ()=0
 perform regular periodic maintenance; TODO: move to UFSSwapDir::Maintain More...
 
virtual void sync ()
 prepare for shutdown More...
 

Detailed Description

Storage controlled by a Controller. This API is shared among Disks, Disk, Memory caches and Transients.

Definition at line 18 of file Controlled.h.

Member Function Documentation

◆ anchorToCache()

virtual bool Store::Controlled::anchorToCache ( StoreEntry &  )
inlinevirtual

tie StoreEntry to this storage if this storage has a matching entry

Return values
trueif this storage has a matching entry

Reimplemented in Rock::SwapDir, MemStore, and Store::Disks.

Definition at line 39 of file Controlled.h.

Referenced by Store::Disks::anchorToCache().

◆ callback()

virtual int Store::Storage::callback ( )
inlinevirtualinherited

Reimplemented in Fs::Ufs::UFSSwapDir, Store::Disks, and Store::Controller.

Definition at line 72 of file Storage.h.

◆ create()

virtual void Store::Storage::create ( )
pure virtualinherited

Implemented in Transients, Rock::SwapDir, MemStore, Fs::Ufs::UFSSwapDir, Store::Disk, Store::Controller, and Store::Disks.

◆ currentCount()

virtual uint64_t Store::Storage::currentCount ( ) const
pure virtualinherited

Implemented in Fs::Ufs::UFSSwapDir, Transients, MemStore, Rock::SwapDir, Store::Controller, Store::Disks, and TestSwapDir.

◆ currentSize()

virtual uint64_t Store::Storage::currentSize ( ) const
pure virtualinherited

Implemented in Fs::Ufs::UFSSwapDir, Transients, MemStore, Rock::SwapDir, Store::Controller, Store::Disks, and TestSwapDir.

◆ dereference()

virtual bool Store::Controlled::dereference ( StoreEntry &  e)
pure virtual

somebody no longer needs this entry (usually after calling reference()) return false iff the idle entry should be destroyed

Implemented in Rock::SwapDir, Transients, MemStore, Store::Disk, Store::Disks, and Fs::Ufs::UFSSwapDir.

◆ evictCached()

virtual void Store::Storage::evictCached ( StoreEntry &  e)
pure virtualinherited

Prevent new get() calls from returning the matching entry. If the matching entry is unused, it may be removed from the store now. The store entry is matched using either e attachment info or e.key.

Implemented in Transients, MemStore, Fs::Ufs::UFSSwapDir, Rock::SwapDir, Store::Disks, Store::Controller, and TestSwapDir.

Referenced by Store::Disks::evictCached().

◆ evictIfFound()

virtual void Store::Storage::evictIfFound ( const cache_key *  )
pure virtualinherited

An evictCached() equivalent for callers that did not get() a StoreEntry. Callers with StoreEntry objects must use evictCached() instead.

Implemented in Transients, MemStore, Fs::Ufs::UFSSwapDir, Rock::SwapDir, Store::Disks, Store::Controller, and TestSwapDir.

◆ get()

virtual StoreEntry* Store::Controlled::get ( const cache_key *  )
pure virtual
Returns
a possibly unlocked/unregistered stored entry with key (or nil) The returned entry might not match the caller's Store ID or method. The caller must abandon()/release() the entry or register it with Root(). This method must not trigger slow I/O operations (e.g., disk swap in).

Implemented in Rock::SwapDir, Transients, MemStore, Store::Disk, and Store::Disks.

◆ getStats()

virtual void Store::Storage::getStats ( StoreInfoStats &  stats) const
pure virtualinherited

Implemented in Transients, MemStore, Store::Disk, Store::Controller, and Store::Disks.

◆ init()

virtual void Store::Storage::init ( )
pure virtualinherited

Start preparing the store for use. To check readiness, callers should use readable() and writable() methods.

Implemented in Rock::SwapDir, Transients, MemStore, Fs::Ufs::UFSSwapDir, TestSwapDir, Store::Controller, and Store::Disks.

◆ maintain()

virtual void Store::Storage::maintain ( )
pure virtualinherited

Implemented in Rock::SwapDir, Transients, MemStore, Store::Disk, Fs::Ufs::UFSSwapDir, Store::Controller, and Store::Disks.

◆ maxObjectSize()

virtual int64_t Store::Storage::maxObjectSize ( ) const
pure virtualinherited

Implemented in Transients, MemStore, Store::Disk, Store::Controller, and Store::Disks.

◆ maxSize()

virtual uint64_t Store::Storage::maxSize ( ) const
pure virtualinherited

The maximum size the store will support in normal use. Inaccuracy is permitted, but may throw estimates for memory etc out of whack.

Implemented in Transients, MemStore, Store::Disk, Store::Controller, Store::Disks, and TestSwapDir.

◆ minSize()

virtual uint64_t Store::Storage::minSize ( ) const
pure virtualinherited

Implemented in Transients, MemStore, Store::Disk, Store::Controller, and Store::Disks.

◆ reference()

virtual void Store::Controlled::reference ( StoreEntry &  e)
pure virtual

Implemented in Rock::SwapDir, Transients, MemStore, Store::Disk, Fs::Ufs::UFSSwapDir, and Store::Disks.

◆ stat()

virtual void Store::Storage::stat ( StoreEntry &  e) const
pure virtualinherited

Output stats to the provided store entry. TODO: make these calls asynchronous

Implemented in Transients, MemStore, Store::Disk, Store::Controller, Store::Disks, and TestSwapDir.

◆ sync()

virtual void Store::Storage::sync ( )
inlinevirtualinherited

Reimplemented in Fs::Ufs::UFSSwapDir, Store::Controller, and Store::Disks.

Definition at line 78 of file Storage.h.

◆ updateAnchored()

virtual bool Store::Controlled::updateAnchored ( StoreEntry &  )
inlinevirtual

Update a local Transients entry with fresh info from this cache (if any). Return true iff the cache supports Transients entries and the given local Transients entry is now in sync with this storage.

Reimplemented in Rock::SwapDir, MemStore, and Store::Disks.

Definition at line 44 of file Controlled.h.

Referenced by Store::Disks::updateAnchored().

◆ updateHeaders()

virtual void Store::Controlled::updateHeaders ( StoreEntry *  )
inlinevirtual

Reimplemented in Rock::SwapDir, MemStore, and Store::Disks.

Definition at line 35 of file Controlled.h.

Referenced by Store::Disks::updateHeaders().

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

 

Introduction

Documentation

Support

Miscellaneous