X-Git-Url: https://git.cworth.org/git?p=ttt;a=blobdiff_plain;f=PROTOCOL;h=91c8545b88ac96f482ca5c27893a3715ce10ba07;hp=4fcec635a468d92e7d491d81c35467ecaa0b8663;hb=78c696d4ed9578c3d1ece01b8e4667839ff5fb04;hpb=4f0f5e3d16e6ec375844c711d4f88d6fec79ae45 diff --git a/PROTOCOL b/PROTOCOL index 4fcec63..91c8545 100644 --- a/PROTOCOL +++ b/PROTOCOL @@ -139,7 +139,7 @@ Document Conventions INVITE - Possible errors: NO_USER, BUSY, NO_NAME_SET + Possible errors: NO_NAME_SET, NO_USER, BUSY 1.3.2. Accepting an invitation @@ -149,7 +149,7 @@ Document Conventions ACCEPT - Possible errors: NO_USER, NO_NAME_SET + Possible errors: NO_NAME_SET, NO_USER, NO_INVITE 1.3.3. Retracting an invitiation @@ -159,7 +159,7 @@ Document Conventions RETRACT - Possible errors: NO_USER, NO_NAME_SET + Possible errors: NO_NAME_SET, NO_USER, NO_INVITE 1.3.3. Declining an invitation @@ -169,7 +169,7 @@ Document Conventions DECLINE - Possible errors: NO_USER, NO_NAME_SET + Possible errors: NO_NAME_SET, NO_USER, NO_INVITE 1.4. In-game commands @@ -201,7 +201,7 @@ Document Conventions _|X|_ X|O|O" - Possible errors: NO_NAME_SET, NO_GAME, NOT_IN_GAME + Possible errors: NO_NAME_SET, NO_GAME 1.4.2. Part @@ -213,7 +213,7 @@ Document Conventions Departs the specified game - Possible errors: NO_NAME_SET, NO_GAME, NOT_IN_GAME + Possible errors: NO_NAME_SET, NO_GAME 1.4.3. Making a move @@ -230,8 +230,8 @@ Document Conventions 3|4|5 6|7|8 - Possible errors: NO_NAME_SET, NO_GAME, NOT_IN_GAME, - NOT_YOUR_MOVE, NOT_GRID + Possible errors: NO_NAME_SET, NO_GAME, NOT_PLAYING, + NOT_YOUR_MOVE, NOT_GRID, NOT_VALID_MOVE 2. Asynchronous notification. @@ -332,13 +332,15 @@ Document Conventions 'helo' must be sent before any command other than 'help', 'version', 'quit'. - Possibly returned by: WHO MESSAGE INVITE ACCEPT SHOW PART MOVE + Possibly returned by: WHO, STATISTICS, MESSAGE, INVITE, + ACCEPT, RETRACT, DECLINE, SHOW, PART, MOVE 3.1.2. Invalid name ERROR INVALID_NAME - All names must be of non-zero length and must be unique. + All names must be of non-zero length and must be unique, + though case-insensitive. Possibly returned by: HELO @@ -350,39 +352,56 @@ Document Conventions ERROR COMMAND - An invalid command was specified - + An invalid command was specified. + 3.2.2. Syntax ERROR SYNTAX - A syntax error was detected + A syntax error was detected. 3.2.3. Not number ERROR NOT_NUMBER - A non-numeric value was supplied where a number was required + A non-numeric value was supplied where a number was required. + Possibly returned by: MOVE + 3.2.4. Not a grid number ERROR NOT_GRID - The number specified in the command was not a valid grid number - + The number specified in the command was not a valid grid + number. + + Possibly returned by: MOVE + 3.3. Global command errors. - There are no errors from any of the global commands + There are no global command errors from any of the global + commands. 3.4. Game management errors. Errors from game management commands - 3.4.1. No such game + 3.4.1. No invitiation from/for specified user + + ERROR NO_INVITE + + An invitiation action was attempted where no invitation + exists. + + Possibly returned by: ACCEPT, RETRACT, DECLINE + + 3.4.2. No such game ERROR NO_GAME - A game name was provided that does not exist. + A game id was provided that does not exist. + + Possibly returned by: SHOW, PART, MOVE 3.5. User information errors @@ -392,25 +411,21 @@ Document Conventions A user name was provided that does not exist. + Possibly returned by: STATISTICS, INVITE, ACCEPT, RETRACT, + DECLINE + 3.6. In-game errors 3.6.1. Global game errors - 3.6.1.1. Not in game - - ERROR NOT_IN_GAME - - A game playing command was made, but the user is not a - particpant of any game. - - Possibly returned by: MOVE - - 3.6.1.2. Not playing + 3.6.1.1. Not playing ERROR NOT_PLAYING A command was executed by a watching user that is - permitted only to players + permitted only to players. + + Possibly returned by: MOVE 3.6.2. Moving errors @@ -418,6 +433,14 @@ Document Conventions ERROR NOT_YOUR_TURN - A move was submitted during the other player's turn + A move was submitted during the other player's turn. + + Possibly returned by: MOVE + + 3.6.2.2. Not a valid move + + ERROR NOT_VALID_MOVE + + A move was submitted for a cell that is occupied. Possibly returned by: MOVE