empire/empserver
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Clarify what happens when the player aborts commands

Browse source
This commit is contained in:
Markus Armbruster 2012-02-07 07:26:57 +01:00
parent b4f076fc36
commit 78dc17c02c
1 changed files with 7 additions and 3 deletions
Download patch file Download diff file Expand all files Collapse all files

10
doc/clients-howto
View file

@ -49,7 +49,7 @@ clients. Likewise, overlong or malformed UTF-8 sequences should not
occur and may be ignored. occur and may be ignored.
The server prompts for input. Each prompt `consumes' one line of The server prompts for input. Each prompt `consumes' one line of
input (except for C_EXECUTE, and when the update aborts a command, as input (except for C_EXECUTE, and when a command is aborted, as
described below). Input lines are arbitrary text, terminated by line described below). Input lines are arbitrary text, terminated by line
feed, which is optionally preceded by carriage return (decimal 13). feed, which is optionally preceded by carriage return (decimal 13).
Lines should not contain ASCII control characters other than Lines should not contain ASCII control characters other than
@ -198,8 +198,12 @@ The following ids occur:
* Argument prompt C_FLUSH * Argument prompt C_FLUSH
The server consumes a line of input and passes it to the currently The server consumes a line of input and passes it to the currently
executing command. Commands usually fail on interrupt. The server executing command.
terminates the session on EOF (but see C_EXECUTE for an exception).
The server aborts the command on interrupt and EOF. Any argument
prompts it may send before the next command prompt do not consume
input. On EOF, the server then terminates the session (but see
C_EXECUTE for an exception).
If an update runs while the server waits for the line of input to If an update runs while the server waits for the line of input to
arrive, the current command is aborted. Whether the server consumes arrive, the current command is aborted. Whether the server consumes