/wheels/cache/storage/AbstractStorage.cfc

 1<cfinterface>
 2
 3	<cffunction name="isAvailable" access="public" description="Method to determine if the cache can be used" output="false" returntype="boolean" />
 4
 5	<cffunction name="set" access="public" description="Add a specified key and value to the storage mechanism." output="false" returntype="void">
 6		<cfargument name="key" type="string" required="true">
 7		<cfargument name="value" type="any" required="true">
 8	</cffunction>
 9
10	<cffunction name="get" access="public" description="Get a specified key from the storage mechanism." output="false" returntype="any">
11		<cfargument name="key" type="string" required="true">
12	</cffunction>
13	
14	<cffunction name="evict" access="public" description="Decides what items to remove from the cache using the supplied strategy object." output="false" returntype="numeric">
15		<cfargument name="keys" type="array" required="false">
16		<cfargument name="strategy" type="any" required="true">
17		<cfargument name="currentTime" type="date" required="true">
18	</cffunction>
19
20	<cffunction name="delete" access="public" description="Deletes a specified key from the storage mechanism." output="false" returntype="void">
21		<cfargument name="key" type="string" required="true">
22	</cffunction>
23	
24	<cffunction name="count" access="public" description="Return the number of items in the cache." output="false" returntype="numeric" />
25	
26	<cffunction name="flush" access="public" description="Destroys everything in the cache." output="false" returntype="void" />
27
28</cfinterface>