changeset 20646:a6bc0442a71b draft

(svn r25598) -Doc: Implications of the asynchronous processing of the rcon content command on send time of ADMIN_SERVER_ADMIN_RCON and ADMIN_SERVER_ADMIN_RCON_END packets
author planetmaker <planetmaker@openttd.org>
date Sat, 13 Jul 2013 09:59:09 +0000
parents ea3b420db268
children c0ab0b43788a
files docs/admin_network.txt
diffstat 1 files changed, 9 insertions(+), 1 deletions(-) [+]
line wrap: on
line diff
--- a/docs/admin_network.txt
+++ b/docs/admin_network.txt
@@ -150,7 +150,8 @@
 
   Note: No additional authentication is required for rcon commands.
 
-  The server will reply with a ADMIN_PACKET_SERVER_RCON packet. Applications
+  The server will reply with one or more ADMIN_PACKET_SERVER_RCON packets.
+  Finally an ADMIN_PACKET_ADMIN_RCON_END packet will be sent. Applications
   will not receive the answer twice if they have asked for the AdminUpdateType
   ADMIN_UPDATE_CONSOLE, as the result is not printed on the servers console
   (just like clients rcon commands).
@@ -160,6 +161,13 @@
   Chat from the server itself will only be sent to the admin network when it
   was not sent from the admin network.
 
+  Note that when content is queried or updated via rcon, the processing
+  happens asynchronously. But the ADMIN_PACKET_ADMIN_RCON_END packet is sent
+  already right after the content is requested as there's no immediate output.
+  Thus other packages and the output of content rcon command may be sent at
+  an arbitrary later time, mixing into the output of other console activity,
+  e.g. also of possible subsequent other rcon commands sent.
+
 
 5.0) Sending chat
 ---- ------------