patch from div0 that fixes rate limiting code to make use of sv_maxrate (as it was...
[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         // writing buffer to send to peer as the next reliable message
129         // can be added to at any time, copied into sendMessage buffer when it is
130         // possible to send a reliable message and then cleared
131         sizebuf_t message;
132         unsigned char messagedata[NET_MAXMESSAGE];
133
134         // reliable message that is currently sending
135         // (for building fragments)
136         int sendMessageLength;
137         unsigned char sendMessage[NET_MAXMESSAGE];
138
139         // reliable message that is currently being received
140         // (for putting together fragments)
141         int receiveMessageLength;
142         unsigned char receiveMessage[NET_MAXMESSAGE];
143
144         struct netconn_nq_s
145         {
146                 unsigned int ackSequence;
147                 unsigned int sendSequence;
148                 unsigned int unreliableSendSequence;
149
150                 unsigned int receiveSequence;
151                 unsigned int unreliableReceiveSequence;
152         }
153         nq;
154         struct netconn_qw_s
155         {
156                 // QW protocol
157                 qboolean        fatal_error;
158
159                 float           last_received;          // for timeouts
160
161         // the statistics are cleared at each client begin, because
162         // the server connecting process gives a bogus picture of the data
163                 float           frame_latency;          // rolling average
164                 float           frame_rate;
165
166                 int                     drop_count;                     // dropped packets, cleared each level
167                 int                     good_count;                     // cleared each level
168
169                 int                     qport;
170
171         // bandwidth estimator
172                 double          cleartime;                      // if realtime > nc->cleartime, free to go
173                 double          rate;                           // seconds / byte
174
175         // sequencing variables
176                 int                     incoming_sequence;
177                 int                     incoming_acknowledged;
178                 int                     incoming_reliable_acknowledged; // single bit
179
180                 int                     incoming_reliable_sequence;             // single bit, maintained local
181
182                 int                     outgoing_sequence;
183                 int                     reliable_sequence;                      // single bit
184                 int                     last_reliable_sequence;         // sequence number of last send
185         }
186         qw;
187
188         // this tracks which of the last 100 received packet sequence numbers were lost
189         int packetlostcounter;
190         unsigned char packetlost[100];
191
192         char address[128];
193 } netconn_t;
194
195 extern netconn_t *netconn_list;
196 extern mempool_t *netconn_mempool;
197
198 extern cvar_t hostname;
199 extern cvar_t developer_networking;
200
201 #define SERVERLIST_TOTALSIZE            2048
202 #define SERVERLIST_VIEWLISTSIZE         SERVERLIST_TOTALSIZE
203 #define SERVERLIST_ANDMASKCOUNT         5
204 #define SERVERLIST_ORMASKCOUNT          5
205
206 typedef enum serverlist_maskop_e
207 {
208         // SLMO_CONTAINS is the default for strings
209         // SLMO_GREATEREQUAL is the default for numbers (also used when OP == CONTAINS or NOTCONTAINS
210         SLMO_CONTAINS,
211         SLMO_NOTCONTAIN,
212
213         SLMO_LESSEQUAL,
214         SLMO_LESS,
215         SLMO_EQUAL,
216         SLMO_GREATER,
217         SLMO_GREATEREQUAL,
218         SLMO_NOTEQUAL
219 } serverlist_maskop_t;
220
221 // struct with all fields that you can search for or sort by
222 typedef struct serverlist_info_s
223 {
224         // address for connecting
225         char cname[128];
226         // ping time for sorting servers
227         int ping;
228         // name of the game
229         char game[32];
230         // name of the mod
231         char mod[32];
232         // name of the map
233         char map[32];
234         // name of the session
235         char name[128];
236         // max client number
237         int maxplayers;
238         // number of currently connected players
239         int numplayers;
240         // protocol version
241         int protocol;
242         // game data version
243         // (an integer that is used for filtering incompatible servers,
244         //  not filterable by QC)
245         int gameversion;
246 } serverlist_info_t;
247
248 typedef enum
249 {
250         SLIF_CNAME,
251         SLIF_PING,
252         SLIF_GAME,
253         SLIF_MOD,
254         SLIF_MAP,
255         SLIF_NAME,
256         SLIF_MAXPLAYERS,
257         SLIF_NUMPLAYERS,
258         SLIF_PROTOCOL,
259         SLIF_COUNT
260 } serverlist_infofield_t;
261
262 typedef enum
263 {
264         SQS_NONE = 0,
265         SQS_QUERYING,
266         SQS_QUERIED,
267         SQS_TIMEDOUT
268 } serverlist_query_state;
269
270 typedef struct serverlist_entry_s
271 {
272         // used to determine whether this entry should be included into the final view
273         serverlist_query_state query;
274         // used to count the number of times the host has tried to query this server already
275         unsigned querycounter;
276         // used to calculate ping when update comes in
277         double querytime;
278         // query protocol to use on this server
279         int protocol; // may be PROTOCOL_QUAKEWORLD or PROTOCOL_DARKPLACES7
280
281         serverlist_info_t info;
282
283         // legacy stuff
284         char line1[128];
285         char line2[128];
286 } serverlist_entry_t;
287
288 typedef struct serverlist_mask_s
289 {
290         qboolean                        active;
291         serverlist_maskop_t  tests[SLIF_COUNT];
292         serverlist_info_t info;
293 } serverlist_mask_t;
294
295 extern serverlist_mask_t serverlist_andmasks[SERVERLIST_ANDMASKCOUNT];
296 extern serverlist_mask_t serverlist_ormasks[SERVERLIST_ORMASKCOUNT];
297
298 extern serverlist_infofield_t serverlist_sortbyfield;
299 extern qboolean serverlist_sortdescending;
300
301 extern int serverlist_viewcount;
302 extern serverlist_entry_t *serverlist_viewlist[SERVERLIST_VIEWLISTSIZE];
303
304 extern int serverlist_cachecount;
305
306 extern qboolean serverlist_consoleoutput;
307
308 //============================================================================
309 //
310 // public network functions
311 //
312 //============================================================================
313
314 extern double masterquerytime;
315 extern int masterquerycount;
316 extern int masterreplycount;
317 extern int serverquerycount;
318 extern int serverreplycount;
319
320 extern sizebuf_t net_message;
321
322 extern cvar_t cl_netlocalping;
323
324 extern cvar_t cl_netport;
325 extern cvar_t sv_netport;
326 extern cvar_t net_address;
327 //extern cvar_t net_netaddress_ipv6;
328
329 int NetConn_SendUnreliableMessage(netconn_t *conn, sizebuf_t *data, protocolversion_t protocol);
330 void NetConn_CloseClientPorts(void);
331 void NetConn_OpenClientPorts(void);
332 void NetConn_CloseServerPorts(void);
333 void NetConn_OpenServerPorts(int opennetports);
334 void NetConn_UpdateSockets(void);
335 lhnetsocket_t *NetConn_ChooseClientSocketForAddress(lhnetaddress_t *address);
336 lhnetsocket_t *NetConn_ChooseServerSocketForAddress(lhnetaddress_t *address);
337 void NetConn_Init(void);
338 void NetConn_Shutdown(void);
339 netconn_t *NetConn_Open(lhnetsocket_t *mysocket, lhnetaddress_t *peeraddress);
340 void NetConn_Close(netconn_t *conn);
341 void NetConn_Listen(qboolean state);
342 int NetConn_Read(lhnetsocket_t *mysocket, void *data, int maxlength, lhnetaddress_t *peeraddress);
343 int NetConn_Write(lhnetsocket_t *mysocket, const void *data, int length, const lhnetaddress_t *peeraddress);
344 int NetConn_WriteString(lhnetsocket_t *mysocket, const char *string, const lhnetaddress_t *peeraddress);
345 int NetConn_IsLocalGame(void);
346 void NetConn_ClientFrame(void);
347 void NetConn_ServerFrame(void);
348 void NetConn_QueryMasters(qboolean querydp, qboolean queryqw);
349 void NetConn_Heartbeat(int priority);
350 void NetConn_QueryQueueFrame(void);
351 void Net_Stats_f(void);
352 void Net_Slist_f(void);
353 void Net_SlistQW_f(void);
354
355 // ServerList interface (public)
356 // manually refresh the view set, do this after having changed the mask or any other flag
357 void ServerList_RebuildViewList(void);
358 void ServerList_ResetMasks(void);
359 void ServerList_QueryList(qboolean querydp, qboolean queryqw);
360
361 #endif
362