1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
|
/*
* XEvil(TM) Copyright (C) 1994,2000 Steve Hardt and Michael Judge
* http://www.xevil.com
* satan@xevil.com
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or (at
* your option) any later version.
*
* This program is distributed in the hope that it will be useful, but
* WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program, the file "gpl.txt"; if not, write to the Free
* Software Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
* 02111-1307, USA, or visit http://www.gnu.org.
*/
// "xetp_basic.h"
// A restricted subset of XETP. Only contains simple methods that require
// no information about Physical, Intel, World, Locator, or any other
// major XEvil module. xetp_basic.h is used for utility programs dealing
// with XETP.
#ifndef XETP_BASIC_H
#define XETP_BASIC_H
#if X11
#ifndef NO_PRAGMAS
#pragma interface
#endif
#endif
#include "utils.h"
#include "streams.h"
class XETPBasic {
public:
// All methods are proceeded by header of form
//
// <method:1><length:2>
//
// OLD was.....XETP<version:4><method:1><length:2>
//
// Where LENGTH does not include length of header.
// All values are big-endian
enum {HEADER_LENGTH = 3}; // 8
enum {VERSION_LENGTH = 8}; // streams.h depends on this value.
static const char *versionStr;
// The ':' syntax gives the size in bytes of each component. :String means
// use Utils::string_read(), Utils::string_write(), etc.
// Methods for XETP
enum {
CONNECT = 1, // null
ACCEPT, // null
TCP_CONNECT, // <udpPort:2><humanName:String>
// <ViewportInfo><skip:4><wantSounds:1>
// Human must be the same as human after the <IntelId>
HUMAN, // <IntelId><human data>
OBJECT, // <ClassId:2><Id><Turn:4><TickType:1><object data>
NEW_TURN, // null
NEW_WORLD, // <worldVersion:4><world data>
// Start a new game.
RESET, // <gameStyleType:4>
// Unused.
WORLD_ROOM, // <worldVersion:4><Rooms><RoomIndex><Dim><world data>
MESSAGE, // <message>
ARENA_MESSAGE, // <time(ms):4><message>
ROOMS_KNOWN, // <worldVersion:4><Rooms><u_char map[Rooms]>
COMMAND, // <IntelId><command:1>
DELETE_OBJECT, // <Id>
// Server asking Client to confirm existence
PING, // null
// Client responding to PING
// Also sent by client everytime it sees a new maximum turn.
PONG, // null
TIMER_PING, // <turn:4>
TIMER_PONG, // <ping_turn:4><local_turn:4>
// Server explicitly killing Client connection.
DISCONNECT, // null
// Server informing the client of some UI info.
HUMANS_PLAYING, // <int>
// Server informing the client of some UI info.
ENEMIES_PLAYING, // <int>
// Client is begging to start a new game with a new human.
REQUEST_NEW_HUMAN, // null
// Server tells client to play a sound effect.
SOUND_REQUEST, // <SoundRequest>
// Ask a server to give information about itself.
SERVER_PING, // null
// Server responding to a SERVER_PING.
// human_kills is the value after taking soups into account.
SERVER_PONG, // <game_style:1><enemies_num:4><humans_num:2>
// <version:String>
// (humans_num * (<name><clientName><human_kills:4>
// <enemy_kills:4><Id>))
// A client asks the server to send a CHAT packet to the named receiver.
// Send to everyone if receiverName is "".
CHAT_REQUEST, // <receiverName><message>
// Server passing on a CHAT message to a specific client.
// IntelId is that of the sender.
CHAT, // <senderName><IntelId><message>
// Must be last.
XETP_METHOD_MAX,
};
// The default port to use for XEvil servers.
static const CMN_PORT DEFAULT_PORT;
static void check_sizes();
/* EFFECTS: Runtime check that our assumptions about the sizes of
primitive data types are correct. */
static int add_header(int bodyLen) {return HEADER_LENGTH + bodyLen;}
/* EFFECTS: Returns the entire size of a packet to be sent. */
////////// SEND METHODS
static void send_server_ping(OutStreamP out)
{send_generic(out,SERVER_PING);}
////////// RECEIVE METHODS
static Boolean receive_header(InStreamP inStream,
u_short &method,u_int &length);
/* EFFECTS: Look for XETP header coming in from inStream,
return method and length of body. */
/* MODIFIES: method, length */
/* NOTE: Does not call prepare_packet() or done_packet(). */
#ifndef PROTECTED_IS_PUBLIC
protected:
#endif
static void send_header(OutStreamP,u_short method,u_int length);
/* NOTE: Does not call prepare_packet() or done_packet(). */
static void send_generic(OutStreamP,u_short method);
/* EFFECTS: Send a method with no data. */
static void send_int(OutStreamP,u_short method,u_int val);
/* EFFECTS: Send a method with an integer data. */
static void send_string(OutStreamP,u_short method,char *msg);
/* EFFECTS: Send a method with String data. */
};
#endif
|
