X-Git-Url: http://git.nikiroo.be/?p=jvcard.git;a=blobdiff_plain;f=src%2Fbe%2Fnikiroo%2Fjvcard%2Fremote%2Fpackage-info.java;h=4c39be6d8afd2e81c73fec0c1cbb2ee508870ad8;hp=5cb9de128394e7f078f5b245724e2c8e3ecccc75;hb=e4444b0bc462544629d9e7e7ab62b96a4d9cab10;hpb=02b341aa6dcd14dc311f6ea218e199f20e242f36
diff --git a/src/be/nikiroo/jvcard/remote/package-info.java b/src/be/nikiroo/jvcard/remote/package-info.java
index 5cb9de1..4c39be6 100644
--- a/src/be/nikiroo/jvcard/remote/package-info.java
+++ b/src/be/nikiroo/jvcard/remote/package-info.java
@@ -1,5 +1,45 @@
/**
- * TODO: describe protocol here.
+ * jVCard remote uses a simple plain text protocol to
+ * transfer/retrieve/delete information from/to the server.
+ *
+ *
+ *
+ * The protocol is based around lines of text and blocks of
+ * lines. The client sends commands while the server only
+ * answers with text data.
+ *
+ *
+ *
+ * Some definitions:
+ *
+ * - A line is the text between two new-line characters (\n).
+ *
- A block is all the lines between two end-of-block
+ * lines.
+ *
- An end-of-block line is a special line
+ * containing only a dot (.).
+ *
- A command is block whose first line
+ * contains the command in upper case text and an optional text
+ * argument, optionally followed by a second block of "input" data
+ *
+ *
+ *
+ *
+ * Upon connection, the first thing that happen is that the server sends
+ * a VERSION command (a block whose first line is
+ * VERSION 1, possibly followed by some help text
+ * lines).
+ *
+ *
+ *
+ * The client MUST answer with another VERSION command.
+ *
+ *
+ *
+ * From that time on, the client is allowed to send commands
+ * as described by {@link be.nikiroo.jvcard.remote.Command}.
+ * If the client doesn't follow the rules in
+ * {@link be.nikiroo.jvcard.remote.Command}, the server will close
+ * the connection.
*
* @author niki
*/