Adding blurb about file transfer cleanup request
@@ -83,6 +83,8 @@ and it is followed by the ``hash`` for content-addressable messages.
+-------------------------------+------------------------------------------------------------------------------+
| `Import Request`_ | { `channel_id`, import, `path` } |
+-------------------------------+------------------------------------------------------------------------------+
+| `Cleanup Request`_ | { `channel_id`, cleanup, `hash` } |
++-------------------------------+------------------------------------------------------------------------------+
| `File Chunk`_ | { `channel_id`, `hash`, `chunk_index`, `data` } |
+-------------------------------+------------------------------------------------------------------------------+
| `Acknowledge (ACK)`_ | { `channel_id`, `hash`, true, `num_chunks` } |
@@ -224,6 +226,23 @@ and the error message.
``{ channel_id, false, error_message }``
+Cleanup Request
+~~~~~~~~~~~~~~~
+
+This message is sent to request that some portion of the temporary storage directory be deleted.
+
+If the ``hash`` parameter is specified, then the storage sub-directory associated with that ID will
+be deleted.
+
+If the ``hash`` parameter is omitted, then the entire temporary storage directory will be deleted.
+
+By default, the temporary directory associated with a particular file will be automatically deleted
+upon the successful completion of its transfer.
+The cleanup request is useful when a file transfer fails for some reason and the user wishes to start
+the transfer over from scratch.
+
+ ``{ `channel_id`, cleanup, `hash` }``
+
Common Protocol Usages
----------------------
