Changeset 321e7f6 in git

Timestamp:

2006-05-20T01:53:24Z (14 years ago)

Author:

Xuefer <xuefer@…>

Branches:

1.0, 1.1, 1.2, 1.3, 3.0, 3.1, 3.2, master, trunk

Children:

aab6656

Parents:

93e9226

Message:

update proto description

git-svn-id: ​svn://svn.lighttpd.net/xcache/trunk@9 c26eb9a1-5813-0410-bd6c-c2e55f420ca7

File:

• xcache.c (modified) (18 diffs)

xcache.c

@@ -1152 +1152 @@
 }
 /* }}} */
-/* {{{ proto array xcache_count(int type) */
+/* {{{ proto int xcache_count(int type)
+   Return count of cache on specified cache type */
 PHP_FUNCTION(xcache_count)
 {
@@ -1158 +1159 @@
 }
 /* }}} */
-/* {{{ proto array xcache_info(int type, int id) */
+/* {{{ proto array xcache_info(int type, int id)
+   Get cache info by id on specified cache type */
 PHP_FUNCTION(xcache_info)
 {
@@ -1164 +1166 @@
 }
 /* }}} */
-/* {{{ proto array xcache_list(int type, int id) */
+/* {{{ proto array xcache_list(int type, int id)
+   Get cache entries list by id on specified cache type */
 PHP_FUNCTION(xcache_list)
 {
@@ -1170 +1173 @@
 }
 /* }}} */
-/* {{{ proto array xcache_clear_cache(int type, int id) */
+/* {{{ proto array xcache_clear_cache(int type, int id)
+   Clear cache by id on specified cache type */
 PHP_FUNCTION(xcache_clear_cache)
 {
@@ -1212 +1216 @@
 /* }}} */
 #define TIME_MAX (sizeof(time_t) == sizeof(long) ? LONG_MAX : INT_MAX)
-/* {{{ proto mixed xcache_get(string name) */
+/* {{{ proto mixed xcache_get(string name)
+   Get cached data by specified name */
 PHP_FUNCTION(xcache_get)
 {
@@ -1242 +1247 @@
 }
 /* }}} */
-/* {{{ proto bool  xcache_set(string name, mixed value [, int ttl]) */
+/* {{{ proto bool  xcache_set(string name, mixed value [, int ttl])
+   Store data to cache by specified name */
 PHP_FUNCTION(xcache_set)
 {
@@ -1268 +1274 @@
 }
 /* }}} */
-/* {{{ proto mixed xcache_isset(string name) */
+/* {{{ proto bool  xcache_isset(string name)
+   Check if an entry exists in cache by specified name */
 PHP_FUNCTION(xcache_isset)
 {
@@ -1298 +1305 @@
 }
 /* }}} */
-/* {{{ proto bool  xcache_unset(string name) */
+/* {{{ proto bool  xcache_unset(string name)
+   Unset existing data in cache by specified name */
 PHP_FUNCTION(xcache_unset)
 {
@@ -1398 +1406 @@
 }
 /* }}} */
-/* {{{ proto int xcache_inc(string name [, int value [, int ttl]]) */
+/* {{{ proto int xcache_inc(string name [, int value [, int ttl]])
+   Increase an int counter in cache by specified name, create it if not exists */
 PHP_FUNCTION(xcache_inc)
 {
@@ -1404 +1413 @@
 }
 /* }}} */
-/* {{{ proto int xcache_dec(string name [, int value [, int ttl]]) */
+/* {{{ proto int xcache_dec(string name [, int value [, int ttl]])
+   Decrease an int counter in cache by specified name, create it if not exists */
 PHP_FUNCTION(xcache_dec)
 {
@@ -1410 +1420 @@
 }
 /* }}} */
-/* {{{ proto string xcache_asm(string filename) */
+/* {{{ proto string xcache_asm(string filename)
+ */
 #ifdef HAVE_XCACHE_ASSEMBLER
 PHP_FUNCTION(xcache_asm)
@@ -1418 +1429 @@
 /* }}} */
 #ifdef HAVE_XCACHE_DISASSEMBLER
-/* {{{ proto string xcache_dasm_file(string filename) */
+/* {{{ proto array  xcache_dasm_file(string filename)
+   Disassemble file into opcode array by filename */
 PHP_FUNCTION(xcache_dasm_file)
 {
@@ -1432 +1444 @@
 }
 /* }}} */
-/* {{{ proto string xcache_dasm_string(string code) */
+/* {{{ proto array  xcache_dasm_string(string code)
+   Disassemble php code into opcode array */
 PHP_FUNCTION(xcache_dasm_string)
 {
@@ -1444 +1457 @@
 /* }}} */
 #endif
-/* {{{ proto string xcache_encode(string filename) */
+/* {{{ proto string xcache_encode(string filename)
+   Encode php file into XCache opcode encoded format */
 #ifdef HAVE_XCACHE_ENCODER
 PHP_FUNCTION(xcache_encode)
@@ -1451 +1465 @@
 #endif
 /* }}} */
-/* {{{ proto bool xcache_decode(string filename) */
+/* {{{ proto bool xcache_decode_file(string filename)
+   Decode(load) opcode from XCache encoded format file */
 #ifdef HAVE_XCACHE_DECODER
-PHP_FUNCTION(xcache_decode)
+PHP_FUNCTION(xcache_decode_file)
+{
+}
+#endif
+/* }}} */
+/* {{{ proto bool xcache_decode_string(string data)
+   Decode(load) opcode from XCache encoded format data */
+#ifdef HAVE_XCACHE_DECODER
+PHP_FUNCTION(xcache_decode_string)
 {
 }
@@ -1560 +1583 @@
 PHP_FUNCTION(xcache_coredump)
 {
-    raise(SIGSEGV);
+    if (xc_test) {
+        raise(SIGSEGV);
+    }
+    else {
+        php_error_docref(NULL TSRMLS_CC, E_WARNING, "xcache.test must be enabled to test xcache_coredump()");
+    }
 }
 /* }}} */
@@ -1594 +1622 @@
 #endif
 #ifdef HAVE_XCACHE_DECODER
-    PHP_FE(xcache_decode,            NULL)
+    PHP_FE(xcache_decode_file,       NULL)
+    PHP_FE(xcache_decode_string,     NULL)
 #endif
 #ifdef HAVE_XCACHE_COVERAGE
@@ -1623 +1652 @@
     if (original_sigsegv_handler == xcache_sigsegv_handler) {
         signal(SIGSEGV, original_sigsegv_handler);
-    } else {
+    }
+    else {
         signal(SIGSEGV, SIG_DFL);
     }