coldbox.system.cache.store.IObjectStore
Copyright Since 2005 ColdBox Framework by Luis Majano and Ortus Solutions, Corp www.ortussolutions.com --- The main interface for CacheBox object storages. A store is a physical counterpart to a cache, in which objects are kept, indexed and monitored.
Method Summary | |
---|---|
any
|
clear(any objectKey)
Clears an object from the storage. |
void
|
clearAll()
Clear all the elements in the store. |
void
|
expireObject(any objectKey)
Expire an object. |
void
|
flush()
Flush the store to a permanent storage. |
any
|
get(any objectKey)
Get an object from the store with metadata tracking. |
any
|
getIndexer()
Get the store's pool metadata indexer structure. |
any
|
getKeys()
Get all the store's object keys array. |
any
|
getQuiet(any objectKey)
Get an object from cache with no metadata tracking. |
any
|
getSize()
Get the size of the store. |
any
|
isExpired(any objectKey)
Expire check. |
any
|
lookup(any objectKey)
Check if an object is in the store. |
void
|
reap()
Reap the storage. |
void
|
set(any objectKey, any object, [any timeout], [any lastAccessTimeout], [any extras])
Sets an object in the storage. |
Method Detail |
---|
Clears an object from the storage
objectKey
- The object key to clearClear all the elements in the store
Expire an object
objectKey
- The key to expireFlush the store to a permanent storage
Get an object from the store with metadata tracking
objectKey
- The key to retrieveGet the store's pool metadata indexer structure
Get all the store's object keys array
Get an object from cache with no metadata tracking
objectKey
- The key to retrieveGet the size of the store
Expire check
objectKey
- The key to checkCheck if an object is in the store
objectKey
- The key to lookupReap the storage
Sets an object in the storage
objectKey
- The object keyobject
- The object to savetimeout
- Timeout in minuteslastAccessTimeout
- Idle Timeout in minutesextras
- A map of extra name-value pairs to store alongside the object