RESULT

Name

RESULT --  General message to indicate the result of a request

Synopsis

<RESULT ACTION="action" CODE="code"/>
DataTypeExample
ACTIONstringlist
CODEstringok

Description

Server response to any request, embedding the answer data

Message Data

ACTION

The request type this result is referring to. Actions include 'motd', 'list', 'enter', 'chat', 'launch', 'join', 'leave', 'reseat', 'update', 'protocol', 'channel', 'login', and 'pong'.

CODE

Result indicator: either 'ok' or an error string. Errors may include 'usr lookup', 'bad options', 'room full', 'table full', table empty', launch fail', 'join fail', 'no table', 'leave fail', 'leave forbidden', 'already logged in', 'not logged in', 'not in room', 'at table', 'in transit', 'no permission', 'bad xml', 'seat assign fail', 'no channel', or 'too long'. The client should behave sanely when it receives an unrecognized error.

Usage

RESULT is sent from the server to the client in response to LIST, ENTER, LAUNCH, JOIN, LEAVE, CHAT, ADMIN, PERMADMIN, and LOGIN requests. Note that in some of these cases (e.g. LIST) the response to the request will be contained within the RESULT, whereas in others it will not. The logic on which is which is reasonable, but nonetheless the lack of consistency may be confusing.