Snack machine handlers

[tpg/opendispense2.git] / proto.txt

diff --git a/proto.txt b/proto.txt
index 4f4da81..f3734aa 100644 (file)
--- a/proto.txt
+++ b/proto.txt
@@ -15,7 +15,9 @@ All server responses are on one line and are prefixed by a three digit response
 403    User not allowed to perform this action
 404    Bad other username
 406    Bad Item ID
 403    User not allowed to perform this action
 404    Bad other username
 406    Bad Item ID

+407    Invalid arguments

 500    Unknown Dispense Failure
 500    Unknown Dispense Failure

+501    Action Rejected

 
 == Item IDs ==
 <item_id> represents the item ID
 
 == Item IDs ==
 <item_id> represents the item ID


@@ -29,18 +31,12 @@ c   PASS <hash>\n   (Hex-Encoded SHA-512 Hash of <username><salt><password>)
 s      200 Auth OK\n or 401 Auth Failure\n
 User is now authenticated
 --- Alternate Method (Implicit Trust Authentication) ---
 s      200 Auth OK\n or 401 Auth Failure\n
 User is now authenticated
 --- Alternate Method (Implicit Trust Authentication) ---

-If the client is connecting from a trusted machine on a low port then
+If the client is connecting from a trusted machine on a root port then

 automatic authentication is allowed
 c      AUTOAUTH <username>\n
 s      200 Auth OK\n or 401 Auth Failure\n or 401 Untrusted\n
 
 === Commands ===
 automatic authentication is allowed
 c      AUTOAUTH <username>\n
 s      200 Auth OK\n or 401 Auth Failure\n or 401 Untrusted\n
 
 === Commands ===

---- Get Item list ---
-c      ENUM_ITEMS\n
-s      201 Items <count> <item_id> <item_id> ...\n
---- Get Item Information ---
-c      ITEM_INFO <item_id>\n
-s      202 Item <item_id> <price> "<description>"\n

 --- Dispense an item ---
 c      DISPENSE <item_id>\n
 s      200 Dispense OK\n or 402 Poor You\n or 500 Dispense Error\n or 406 Bad Item\n
 --- Dispense an item ---
 c      DISPENSE <item_id>\n
 s      200 Dispense OK\n or 402 Poor You\n or 500 Dispense Error\n or 406 Bad Item\n


@@ -48,10 +44,17 @@ s   200 Dispense OK\n or 402 Poor You\n or 500 Dispense Error\n or 406 Bad Item\n
 c      GIVE <user> <ammount> <reason>\n
 s      200 Give OK\n or 402 Poor You\n or 404 Bad User\n
 --- Update balance ---
 c      GIVE <user> <ammount> <reason>\n
 s      200 Give OK\n or 402 Poor You\n or 404 Bad User\n
 --- Update balance ---

-c      ADD <user> <ammount> "<reason>"\n
+c      ADD <user> <ammount> <reason>\n

 s      200 Add OK\n or 403 Not Coke\n or 404 Bad User\n
 s      200 Add OK\n or 403 Not Coke\n or 404 Bad User\n

+
+--- Get Item list ---
+c      ENUM_ITEMS\n
+s      201 Items <count> <item_id> <item_id> ...\n
+--- Get Item Information ---
+c      ITEM_INFO <item_id>\n
+s      202 Item <item_id> <price> <description>\n

 --- Set Balance ---
 --- Set Balance ---

-c      SET <user> <balance> "<reason>"\n
+c      SET <user> <balance> <reason>\n

 s      200 Set OK\n or 403 Not allowed\n or 404 Bad User\n
 --- Get Users Balances ---
 c      ENUM_USERS[ <max balance>]\n
 s      200 Set OK\n or 403 Not allowed\n or 404 Bad User\n
 --- Get Users Balances ---
 c      ENUM_USERS[ <max balance>]\n