From 9f941fa67ac92968899c7b97d8fd21a4ec0546af Mon Sep 17 00:00:00 2001 From: ajanata Date: Sat, 29 Dec 2012 14:27:13 -0800 Subject: [PATCH] still very incomplete --- API.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) create mode 100644 API.md diff --git a/API.md b/API.md new file mode 100644 index 0000000..79b5f5d --- /dev/null +++ b/API.md @@ -0,0 +1,12 @@ +Work-in-progress API documentation. + +# Definitions +**AJAX_URL**: URL to the client action servlet. +**LONGPOLL_URL**: URL to the long-poll servlet. +**Constants**: Any references to "constants" would be referring to the data defined in https://github.com/ajanata/PretendYoureXyzzy/blob/master/src/net/socialgamer/cah/Constants.java. These values are used to express commands and parameters over the wire. Some UI strings are defined here as well (which you are free to replace with something equivalent). +**CONSTANTS_URL**: URL to the JavaScript version of the wire constants. + + + + +Long poll: The client MUST always keep a connection open to LONGPOLL_URL; the server will block until there is something to tell the client. When the client receives a response \ No newline at end of file