update protocol.txt for touch commands, stats.

1 files changed, 33 insertions, 0 deletions

diff --git a/doc/protocol.txt b/doc/protocol.txt
index ca80fe1..e2b6b86 100644
--- a/doc/protocol.txt
+++ b/doc/protocol.txt
@@ -315,6 +315,32 @@ guaranteed to decrement its returned length.  The number MAY be
 space-padded at the end, but this is purely an implementation
 optimization, so you also shouldn't rely on that.
 
+Touch
+-----
+
+The "touch" command is used to update the expiration time of an existing item
+without fetching it.
+
+touch <key> <exptime> [noreply]\r\n
+
+- <key> is the key of the item the client wishes the server to delete
+
+- <exptime> is expiration time. Works the same as with the update commands
+  (set/add/etc). This replaces the existing expiration time. If an existing
+  item were to expire in 10 seconds, but then was touched with an
+  expiration time of "20", the item would then expire in 20 seconds.
+
+- "noreply" optional parameter instructs the server to not send the
+  reply.  See the note in Storage commands regarding malformed
+  requests.
+
+The response line to this command can be one of:
+
+- "TOUCHED\r\n" to indicate success
+
+- "NOT_FOUND\r\n" to indicate that the item with this key was not
+  found.
+
 Statistics
 ----------
 
@@ -381,6 +407,8 @@ integers separated by a colon (treat this as a floating point number).
 |                       |         | by the server                             |
 | cmd_get               | 64u     | Cumulative number of retrieval reqs       |
 | cmd_set               | 64u     | Cumulative number of storage reqs         |
+| cmd_flush             | 64u     | Cumulative number of flush reqs           |
+| cmd_touch             | 64u     | Cumulative number of touch reqs           |
 | get_hits              | 64u     | Number of keys that have been requested   |
 |                       |         | and found present                         |
 | get_misses            | 64u     | Number of items that have been requested  |
@@ -396,6 +424,10 @@ integers separated by a colon (treat this as a floating point number).
 | cas_hits              | 64u     | Number of successful CAS reqs.            |
 | cas_badval            | 64u     | Number of CAS reqs for which a key was    |
 |                       |         | found, but the CAS value did not match.   |
+| touch_hits            | 64u     | Numer of keys that have been touched with |
+|                       |         | a new expiration time                     |
+| touch_misses          | 64u     | Numer of items that have been touched and |
+|                       |         | not found                                 |
 | auth_cmds             | 64u     | Number of authentication commands         |
 |                       |         | handled, success or failure.              |
 | auth_errors           | 64u     | Number of failed authentications.         |
@@ -562,6 +594,7 @@ END\r\n
 | cas_hits        | Total number of CAS commands modifying this class.       |
 | cas_badval      | Total number of CAS commands that failed to modify a     |
 |                 | value due to a bad CAS id.                               |
+| touch_hits      | Total number of touches serviced by this class.          |
 | used_chunks     | How many chunks have been allocated to items.            |
 | free_chunks     | Chunks not yet allocated to items, or freed via delete.  |
 | free_chunks_end | Number of free chunks at the end of the last allocated   |