rewrote protocol version system (including splitting PROTOCOL_QUAKE into PROTOCOL_QUA...
[divverent/darkplaces.git] / netconn.h
1 /*
2 Copyright (C) 1996-1997 Id Software, Inc.
3 Copyright (C) 2003 Forest Hale
4
5 This program is free software; you can redistribute it and/or
6 modify it under the terms of the GNU General Public License
7 as published by the Free Software Foundation; either version 2
8 of the License, or (at your option) any later version.
9
10 This program is distributed in the hope that it will be useful,
11 but WITHOUT ANY WARRANTY; without even the implied warranty of
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
13
14 See the GNU General Public License for more details.
15
16 You should have received a copy of the GNU General Public License
17 along with this program; if not, write to the Free Software
18 Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
19
20 */
21
22 #ifndef NET_H
23 #define NET_H
24
25 #include "lhnet.h"
26
27 #define NET_HEADERSIZE          (2 * sizeof(unsigned int))
28
29 // NetHeader flags
30 #define NETFLAG_LENGTH_MASK     0x0000ffff
31 #define NETFLAG_DATA            0x00010000
32 #define NETFLAG_ACK                     0x00020000
33 #define NETFLAG_NAK                     0x00040000
34 #define NETFLAG_EOM                     0x00080000
35 #define NETFLAG_UNRELIABLE      0x00100000
36 #define NETFLAG_CTL                     0x80000000
37
38
39 #define NET_PROTOCOL_VERSION    3
40
41 // This is the network info/connection protocol.  It is used to find Quake
42 // servers, get info about them, and connect to them.  Once connected, the
43 // Quake game protocol (documented elsewhere) is used.
44 //
45 //
46 // General notes:
47 //      game_name is currently always "QUAKE", but is there so this same protocol
48 //              can be used for future games as well; can you say Quake2?
49 //
50 // CCREQ_CONNECT
51 //              string  game_name                               "QUAKE"
52 //              byte    net_protocol_version    NET_PROTOCOL_VERSION
53 //
54 // CCREQ_SERVER_INFO
55 //              string  game_name                               "QUAKE"
56 //              byte    net_protocol_version    NET_PROTOCOL_VERSION
57 //
58 // CCREQ_PLAYER_INFO
59 //              byte    player_number
60 //
61 // CCREQ_RULE_INFO
62 //              string  rule
63 //
64 //
65 //
66 // CCREP_ACCEPT
67 //              long    port
68 //
69 // CCREP_REJECT
70 //              string  reason
71 //
72 // CCREP_SERVER_INFO
73 //              string  server_address
74 //              string  host_name
75 //              string  level_name
76 //              byte    current_players
77 //              byte    max_players
78 //              byte    protocol_version        NET_PROTOCOL_VERSION
79 //
80 // CCREP_PLAYER_INFO
81 //              byte    player_number
82 //              string  name
83 //              long    colors
84 //              long    frags
85 //              long    connect_time
86 //              string  address
87 //
88 // CCREP_RULE_INFO
89 //              string  rule
90 //              string  value
91
92 //      note:
93 //              There are two address forms used above.  The short form is just a
94 //              port number.  The address that goes along with the port is defined as
95 //              "whatever address you receive this reponse from".  This lets us use
96 //              the host OS to solve the problem of multiple host addresses (possibly
97 //              with no routing between them); the host will use the right address
98 //              when we reply to the inbound connection request.  The long from is
99 //              a full address and port in a string.  It is used for returning the
100 //              address of a server that is not running locally.
101
102 #define CCREQ_CONNECT           0x01
103 #define CCREQ_SERVER_INFO       0x02
104 #define CCREQ_PLAYER_INFO       0x03
105 #define CCREQ_RULE_INFO         0x04
106
107 #define CCREP_ACCEPT            0x81
108 #define CCREP_REJECT            0x82
109 #define CCREP_SERVER_INFO       0x83
110 #define CCREP_PLAYER_INFO       0x84
111 #define CCREP_RULE_INFO         0x85
112
113 typedef struct netconn_s
114 {
115         struct netconn_s *next;
116
117         lhnetsocket_t *mysocket;
118         lhnetaddress_t peeraddress;
119
120         // this is mostly identical to qsocket_t from quake
121
122         // if this time is reached, kick off peer
123         double connecttime;
124         double timeout;
125         double lastMessageTime;
126         double lastSendTime;
127
128         qboolean canSend;
129         qboolean sendNext;
130
131         unsigned int ackSequence;
132         unsigned int sendSequence;
133         unsigned int unreliableSendSequence;
134         int sendMessageLength;
135         qbyte sendMessage[NET_MAXMESSAGE];
136
137         unsigned int receiveSequence;
138         unsigned int unreliableReceiveSequence;
139         int receiveMessageLength;
140         qbyte receiveMessage[NET_MAXMESSAGE];
141
142         char address[128];
143 } netconn_t;
144
145 extern netconn_t *netconn_list;
146 extern mempool_t *netconn_mempool;
147
148 extern cvar_t hostname;
149 extern cvar_t developer_networking;
150 extern char playername[];
151 extern int playercolor;
152
153 #define SERVERLIST_TOTALSIZE            2048
154 #define SERVERLIST_VIEWLISTSIZE         128
155 #define SERVERLIST_ANDMASKCOUNT         5
156 #define SERVERLIST_ORMASKCOUNT          5
157
158 typedef enum
159 {
160         // SLMO_CONTAINS is the default for strings
161         // SLMO_GREATEREQUAL is the default for numbers (also used when OP == CONTAINS or NOTCONTAINS
162         SLMO_CONTAINS,
163         SLMO_NOTCONTAIN,
164
165         SLMO_LESSEQUAL,
166         SLMO_LESS,
167         SLMO_EQUAL,
168         SLMO_GREATER,
169         SLMO_GREATEREQUAL,
170         SLMO_NOTEQUAL
171 } serverlist_maskop_t;
172
173 // struct with all fields that you can search for or sort by
174 typedef struct
175 {
176         // address for connecting
177         char cname[128];
178         // ping time for sorting servers
179         int ping;
180         // name of the game
181         char game[32];
182         // name of the mod
183         char mod[32];
184         // name of the map
185         char map[32];
186         // name of the session
187         char name[128];
188         // max client number
189         int maxplayers;
190         // number of currently connected players
191         int numplayers;
192         // protocol version
193         int protocol;
194 } serverlist_info_t;
195
196 typedef enum
197 {
198         SLIF_CNAME,
199         SLIF_PING,
200         SLIF_GAME,
201         SLIF_MOD,
202         SLIF_MAP,
203         SLIF_NAME,
204         SLIF_MAXPLAYERS,
205         SLIF_NUMPLAYERS,
206         SLIF_PROTOCOL,
207         SLIF_COUNT
208 } serverlist_infofield_t;
209
210 typedef struct
211 {
212         // used to determine whether this entry should be included into the final view
213         qboolean finished;
214         // used to calculate ping when update comes in
215         double querytime;
216
217         serverlist_info_t info;
218
219         // legacy stuff
220         char line1[128];
221         char line2[128];
222 } serverlist_entry_t;
223
224 typedef struct
225 {
226         qboolean                        active;
227         serverlist_maskop_t  tests[SLIF_COUNT];
228         serverlist_info_t info;
229 } serverlist_mask_t;
230
231 extern serverlist_mask_t serverlist_andmasks[SERVERLIST_ANDMASKCOUNT];
232 extern serverlist_mask_t serverlist_ormasks[SERVERLIST_ORMASKCOUNT];
233
234 extern serverlist_infofield_t serverlist_sortbyfield;
235 extern qboolean serverlist_sortdescending;
236
237 extern int serverlist_viewcount;
238 extern serverlist_entry_t *serverlist_viewlist[SERVERLIST_VIEWLISTSIZE];
239
240 extern int serverlist_cachecount;
241
242 extern qboolean serverlist_consoleoutput;
243
244 #if !defined(_WIN32 ) && !defined (__linux__) && !defined (__sun__)
245 #ifndef htonl
246 extern unsigned long htonl (unsigned long hostlong);
247 #endif
248 #ifndef htons
249 extern unsigned short htons (unsigned short hostshort);
250 #endif
251 #ifndef ntohl
252 extern unsigned long ntohl (unsigned long netlong);
253 #endif
254 #ifndef ntohs
255 extern unsigned short ntohs (unsigned short netshort);
256 #endif
257 #endif
258
259 //============================================================================
260 //
261 // public network functions
262 //
263 //============================================================================
264
265 extern double masterquerytime;
266 extern int masterquerycount;
267 extern int masterreplycount;
268 extern int serverquerycount;
269 extern int serverreplycount;
270
271 extern sizebuf_t net_message;
272
273 extern cvar_t cl_netlocalping;
274
275 int NetConn_SendReliableMessage(netconn_t *conn, sizebuf_t *data);
276 //void NetConn_SendMessageNext(netconn_t *conn);
277 //void NetConn_ReSendMessage(netconn_t *conn);
278 qboolean NetConn_CanSendMessage(netconn_t *conn);
279 int NetConn_SendUnreliableMessage(netconn_t *conn, sizebuf_t *data);
280 void NetConn_CloseClientPorts(void);
281 void NetConn_OpenClientPorts(void);
282 void NetConn_CloseServerPorts(void);
283 void NetConn_OpenServerPorts(int opennetports);
284 lhnetsocket_t *NetConn_ChooseClientSocketForAddress(lhnetaddress_t *address);
285 lhnetsocket_t *NetConn_ChooseServerSocketForAddress(lhnetaddress_t *address);
286 void NetConn_Init(void);
287 void NetConn_Shutdown(void);
288 netconn_t *NetConn_Open(lhnetsocket_t *mysocket, lhnetaddress_t *peeraddress);
289 void NetConn_Close(netconn_t *conn);
290 void NetConn_Listen(qboolean state);
291 int NetConn_IsLocalGame(void);
292 //int NetConn_ReceivedMessage(netconn_t *conn, qbyte *data, int length);
293 //int NetConn_ClientParsePacket(lhnetsocket_t *mysocket, qbyte *data, int length, lhnetaddress_t *peeraddress);
294 //int NetConn_ServerParsePacket(lhnetsocket_t *mysocket, qbyte *data, int length, lhnetaddress_t *peeraddress);
295 void NetConn_ClientFrame(void);
296 void NetConn_ServerFrame(void);
297 void NetConn_QueryMasters(void);
298 void NetConn_Heartbeat(int priority);
299 int NetConn_SendToAll(sizebuf_t *data, double blocktime);
300 void Net_Stats_f(void);
301 void Net_Slist_f(void);
302
303 // ServerList interface (public)
304 // manually refresh the view set, do this after having changed the mask or any other flag
305 void ServerList_RebuildViewList(void);
306 void ServerList_ResetMasks(void);
307 void ServerList_QueryList(void);
308
309 #endif
310