diff --git a/reference/wincache/functions/wincache-fcache-fileinfo.xml b/reference/wincache/functions/wincache-fcache-fileinfo.xml index 56774de1a7..cc987ec25f 100644 --- a/reference/wincache/functions/wincache-fcache-fileinfo.xml +++ b/reference/wincache/functions/wincache-fcache-fileinfo.xml @@ -11,12 +11,28 @@ &reftitle.description; arraywincache_fcache_fileinfo - + boolsummaryonlyfalse Retrieves information about file cache content and its usage. + + &reftitle.parameters; + + + + summaryonly + + + Controls whether the returned array will contain information about individual cache entries + along with the file cache summary. + + + + + + &reftitle.returnvalues; @@ -140,6 +156,7 @@ Array wincache_refresh_if_changed wincache_ucache_meminfo wincache_ucache_info + wincache_scache_info diff --git a/reference/wincache/functions/wincache-fcache-meminfo.xml b/reference/wincache/functions/wincache-fcache-meminfo.xml index 236ce90390..d344ca0ef4 100644 --- a/reference/wincache/functions/wincache-fcache-meminfo.xml +++ b/reference/wincache/functions/wincache-fcache-meminfo.xml @@ -98,6 +98,7 @@ Array wincache_refresh_if_changed wincache_ucache_meminfo wincache_ucache_info + wincache_scache_info diff --git a/reference/wincache/functions/wincache-ocache-fileinfo.xml b/reference/wincache/functions/wincache-ocache-fileinfo.xml index ee2e0e7223..ca38e2030d 100644 --- a/reference/wincache/functions/wincache-ocache-fileinfo.xml +++ b/reference/wincache/functions/wincache-ocache-fileinfo.xml @@ -11,12 +11,28 @@ &reftitle.description; arraywincache_ocache_fileinfo - + boolsummaryonlyfalse Retrieves information about opcode cache content and its usage. + + &reftitle.parameters; + + + + summaryonly + + + Controls whether the returned array will contain information about individual cache entries + along with the opcode cache summary. + + + + + + &reftitle.returnvalues; @@ -153,6 +169,7 @@ Array wincache_refresh_if_changed wincache_ucache_meminfo wincache_ucache_info + wincache_scache_info diff --git a/reference/wincache/functions/wincache-ocache-meminfo.xml b/reference/wincache/functions/wincache-ocache-meminfo.xml index e64be23afe..d4cc1c3218 100644 --- a/reference/wincache/functions/wincache-ocache-meminfo.xml +++ b/reference/wincache/functions/wincache-ocache-meminfo.xml @@ -98,6 +98,7 @@ Array wincache_refresh_if_changed wincache_ucache_meminfo wincache_ucache_info + wincache_scache_info diff --git a/reference/wincache/functions/wincache-rplist-fileinfo.xml b/reference/wincache/functions/wincache-rplist-fileinfo.xml index 8566762c5e..37d21f148f 100644 --- a/reference/wincache/functions/wincache-rplist-fileinfo.xml +++ b/reference/wincache/functions/wincache-rplist-fileinfo.xml @@ -103,6 +103,7 @@ Array wincache_refresh_if_changed wincache_ucache_meminfo wincache_ucache_info + wincache_scache_info diff --git a/reference/wincache/functions/wincache-rplist-meminfo.xml b/reference/wincache/functions/wincache-rplist-meminfo.xml index 0cc1ed841f..90369031f0 100644 --- a/reference/wincache/functions/wincache-rplist-meminfo.xml +++ b/reference/wincache/functions/wincache-rplist-meminfo.xml @@ -98,6 +98,7 @@ Array wincache_refresh_if_changed wincache_ucache_meminfo wincache_ucache_info + wincache_scache_info diff --git a/reference/wincache/functions/wincache-scache-info.xml b/reference/wincache/functions/wincache-scache-info.xml new file mode 100644 index 0000000000..a0614a1c80 --- /dev/null +++ b/reference/wincache/functions/wincache-scache-info.xml @@ -0,0 +1,197 @@ + + + + + wincache_scache_info + + Retrieves information about files cached in the session cache + + + + &reftitle.description; + + arraywincache_scache_info + boolsummaryonlyfalse + + + Retrieves information about session cache content and its usage. + + + + &reftitle.parameters; + + + + summaryonly + + + Controls whether the returned array will contain information about individual cache entries + along with the session cache summary. + + + + + + + + &reftitle.returnvalues; + + Array of meta data about session cache &return.falseforfailure; + + + The array returned by this function contains the following elements: + + + + total_cache_uptime - total time in seconds that the session cache has been active + + + + + total_item_count - total number of elements that are currently in the session cache + + + + + is_local_cache - true is the cache metadata is for a local cache instance, + false if the metadata is for the global cache + + + + + total_hit_count - number of times the data has been served from the cache + + + + + total_miss_count - number of times the data has not been found in the cache + + + + + scache_entries - an array that contains the information about all the cached items: + + + + key_name - name of the key which is used to store the data + + + + + value_type - type of value stored by the key + + + + + use_time - time in seconds since the file has been accessed in the opcode cache + + + + + last_check - time in seconds since the file has been checked for modifications + + + + + ttl_seconds - time remaining for the data to live in the cache, 0 meaning infinite + + + + + age_seconds - time elapsed from the time data has been added in the cache + + + + + hitcount - number of times data has been served from the cache + + + + + + + + + + &reftitle.examples; + + + A <function>wincache_scache_info</function> example + + + + + +]]> + + &example.outputs; + + 17357 + [total_file_count] => 121 + [total_hit_count] => 36562 + [total_miss_count] => 201 + [scache_entries] => Array + ( + [1] => Array + ( + [file_name] => c:\inetpub\wwwroot\checkcache.php + [add_time] => 17356 + [use_time] => 7 + [last_check] => 10 + [hit_count] => 454 + [function_count] => 0 + [class_count] => 1 + ) + [2] => Array (...iterates for each cached file) + ) +) +]]> + + + + + + + &reftitle.seealso; + + + wincache_fcache_fileinfo + wincache_fcache_meminfo + wincache_ocache_meminfo + wincache_rplist_fileinfo + wincache_rplist_meminfo + wincache_refresh_if_changed + wincache_ucache_meminfo + wincache_ucache_info + + + + + + + diff --git a/reference/wincache/functions/wincache-ucache-info.xml b/reference/wincache/functions/wincache-ucache-info.xml index 162203aa39..a2505d690f 100644 --- a/reference/wincache/functions/wincache-ucache-info.xml +++ b/reference/wincache/functions/wincache-ucache-info.xml @@ -10,13 +10,40 @@ &reftitle.description; - boolwincache_ucache_info - + arraywincache_ucache_info + boolsummaryonlyfalse + stringkey Retrieves information about data stored in the user cache. + + &reftitle.parameters; + + + + summaryonly + + + Controls whether the returned array will contain information about individual cache entries + along with the user cache summary. + + + + + key + + + The key of an entry in the user cache. If specified then the returned array will contain information + only about that cache entry. If not specified and summaryonly is set to + false then the returned array will contain information about all entries in the cache. + + + + + + &reftitle.returnvalues; @@ -156,6 +183,7 @@ Array wincache_rplist_fileinfo wincache_refresh_if_changed wincache_ucache_meminfo + wincache_scache_info diff --git a/reference/wincache/functions/wincache_lock.xml b/reference/wincache/functions/wincache_lock.xml index ede4a39285..290b684087 100644 --- a/reference/wincache/functions/wincache_lock.xml +++ b/reference/wincache/functions/wincache_lock.xml @@ -4,7 +4,7 @@ wincache_lock - Gets an exclusive lock on a given key + Acquires an exclusive lock on a given key @@ -76,7 +76,7 @@ fclose($fp); &reftitle.seealso; - wincache_ucache_unlock + wincache_unlock wincache_ucache_set wincache_ucache_get wincache_ucache_delete diff --git a/reference/wincache/functions/wincache_ucache_meminfo.xml b/reference/wincache/functions/wincache_ucache_meminfo.xml index 4c25dcb156..41d43f4b79 100644 --- a/reference/wincache/functions/wincache_ucache_meminfo.xml +++ b/reference/wincache/functions/wincache_ucache_meminfo.xml @@ -97,6 +97,7 @@ Array wincache_rplist_meminfo wincache_refresh_if_changed wincache_ucache_info + wincache_scache_info diff --git a/reference/wincache/functions/wincache_unlock.xml b/reference/wincache/functions/wincache_unlock.xml index eff631e021..4d9b1fb4d5 100644 --- a/reference/wincache/functions/wincache_unlock.xml +++ b/reference/wincache/functions/wincache_unlock.xml @@ -4,7 +4,7 @@ wincache_unlock - Removes an exclusive lock on a given key + Releases an exclusive lock on a given key @@ -14,7 +14,7 @@ stringkey - Removes an exclusive lock that was obtained on a given key by using wincache_lock. + Releases an exclusive lock that was obtained on a given key by using wincache_lock. If any other process was blocked waiting for the lock on this key, that process will be able to obtain the lock. @@ -57,7 +57,7 @@ - wincache_ucache_lock + wincache_lock wincache_ucache_set wincache_ucache_get wincache_ucache_delete diff --git a/reference/wincache/ini.xml b/reference/wincache/ini.xml index b3c830b1c1..d77e99929a 100644 --- a/reference/wincache/ini.xml +++ b/reference/wincache/ini.xml @@ -344,14 +344,15 @@ wincache.ignorelist = "index.php|misc.php|admin.php" wincache.namesalt - boolean + string Defines a string that will be used when naming the extension specific objects that are stored in shared memory. This is used to avoid conflicts that may be caused if other applications within - an IIS worker process tries to access shared memory. + an IIS worker process tries to access shared memory. The length of + the namesalt string cannot exceed 8 characters.