Changeset - r16565:33d2d0a0ae84
[Not reviewed]
master
0 1 0
glx - 14 years ago 2010-11-23 23:06:30
glx@openttd.org
(svn r21304) -Fix (r21005): some typos in documentation (Xaroth)
1 file changed with 5 insertions and 5 deletions:
0 comments (0 inline, 0 general)
docs/admin_network.txt
Show inline comments
 
@@ -50,25 +50,25 @@ 1. Joining the network
 
  ADMIN_PACKET_SERVER_PROTOCOL contains details about the protocol version.
 
  It is the job of your application to check this number and decide whether
 
  it will remain connected or not.
 
  Furthermore, this packet holds details on every AdminUpdateType and the
 
  supported AdminFrequencyTypes (bitwise representation).
 

	
 
  ADMIN_PACKET_SERVER_WELCOME contains details on the server and the map,
 
  e.g. if the server is dedicated, its NetworkLanguage, size of the Map, etc.
 

	
 
  Once you have received ADMIN_PACKET_SERVER_WELCOME you are connected and
 
  authorized to do your thing.
 
  The server will not provide any game related updates unless you ask for them.
 
  There are four packets the serve will none the less send, if applicable:
 
  There are four packets the server will none the less send, if applicable:
 
    - ADMIN_PACKET_SERVER_ERROR
 
    - ADMIN_PACKET_SERVER_WELCOME
 
    - ADMIN_PACKET_SERVER_NEWGAME
 
    - ADMIN_PACKET_SERVER_SHUTDOWN
 

	
 
  However, ADMIN_PACKET_SERVER_WELCOME only after a ADMIN_PACKET_SERVER_NEWGAME
 

	
 

	
 
2. Asking for updates
 
---------------------
 

	
 
  Asking for updates is done with ADMIN_PACKET_ADMIN_UPDATE_FREQUENCY.
 
@@ -134,26 +134,26 @@ 3. Polling manually
 
  Additional debug information can be found with a debug level of net=3.
 

	
 

	
 
4. Sending rcon commands
 
------------------------
 

	
 
  Rcon runs separate from the ADMIN_UPDATE_CONSOLE AdminUpdateType. Requesting
 
  the execution of a remote console command is done with the packet
 
  ADMIN_PACKET_ADMIN_RCON.
 

	
 
  Note: No additional authentication is required for rcon commands.
 

	
 
  The server will reply with a ADMIN_PACIKET_SERVER_RCON packet. Applications
 
  will not receive the answer twice if they ave asked for the AdminUpdateType
 
  The server will reply with a ADMIN_PACKET_SERVER_RCON packet. 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).
 

	
 
  Furthermore, sending a 'say' command (or any similar command) will not
 
  be sent back into the admin network.
 
  Chat from the server itself will only be sent to the admin network when it
 
  was not sent from the admin network.
 

	
 

	
 
5. Sending Chat
 
---------------
 

	
 
@@ -174,32 +174,32 @@ 6. Receiving chat
 
-----------------
 

	
 
  Register ADMIN_UPDATE_CHAT at ADMIN_FREQUENCY_AUTOMATIC to receive chat.
 
  The application will be able to receive all chat the server can see.
 

	
 
  The configuration option network.server_admin_chat specifies whether
 
  private chat for to the server is distributed into the admin network.
 

	
 

	
 
7. Disconnecting
 
----------------
 

	
 
  It is a kind thing to say good bye before leaving. Do this sending the
 
  It is a kind thing to say good bye before leaving. Do this by sending the
 
  ADMIN_PACKET_ADMIN_QUIT packet.
 

	
 

	
 
8. Certain packet information
 
-----------------------------
 

	
 
  All ADMIN_PACKET_SERVER_* packets have an enum value greater 100.
 

	
 
  ADMIN_PACKET_SERVER_WELCOME
 
    Either directly follows ADMIN_PACKET_SERVER_PROTOCOL or is send
 
    Either directly follows ADMIN_PACKET_SERVER_PROTOCOL or is sent
 
    after a new game has been started or a map loaded, i.e. also
 
    after ADMIN_PACKET_SERVER_NEWGAME.
 

	
 
  ADMIN_PACKET_SERVER_CLIENT_JOIN and ADMIN_PACKET_SERVER_COMPANY_NEW
 
    These packets directly follow their respective INFO packets. If you receive
 
    a CLIENT_JOIN / COMPANY_NEW packet without having received the INFO packet
 
    it may be a good idea to POLL for the specific ID.
 

	
 

	
0 comments (0 inline, 0 general)