2 Copyright (C) 1996-1997 Id Software, Inc.
3 Copyright (C) 2003 Forest Hale
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.
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.
14 See the GNU General Public License for more details.
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.
27 #define NET_HEADERSIZE (2 * sizeof(unsigned int))
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
39 #define NET_PROTOCOL_VERSION 3
40 #define NET_EXTRESPONSE_MAX 16
42 // This is the network info/connection protocol. It is used to find Quake
43 // servers, get info about them, and connect to them. Once connected, the
44 // Quake game protocol (documented elsewhere) is used.
48 // game_name is currently always "QUAKE", but is there so this same protocol
49 // can be used for future games as well; can you say Quake2?
52 // string game_name "QUAKE"
53 // byte net_protocol_version NET_PROTOCOL_VERSION
56 // string game_name "QUAKE"
57 // byte net_protocol_version NET_PROTOCOL_VERSION
78 // string server_address
81 // byte current_players
83 // byte protocol_version NET_PROTOCOL_VERSION
101 // There are two address forms used above. The short form is just a
102 // port number. The address that goes along with the port is defined as
103 // "whatever address you receive this reponse from". This lets us use
104 // the host OS to solve the problem of multiple host addresses (possibly
105 // with no routing between them); the host will use the right address
106 // when we reply to the inbound connection request. The long from is
107 // a full address and port in a string. It is used for returning the
108 // address of a server that is not running locally.
110 #define CCREQ_CONNECT 0x01
111 #define CCREQ_SERVER_INFO 0x02
112 #define CCREQ_PLAYER_INFO 0x03
113 #define CCREQ_RULE_INFO 0x04
114 #define CCREQ_RCON 0x05 // RocketGuy: ProQuake rcon support
116 #define CCREP_ACCEPT 0x81
117 #define CCREP_REJECT 0x82
118 #define CCREP_SERVER_INFO 0x83
119 #define CCREP_PLAYER_INFO 0x84
120 #define CCREP_RULE_INFO 0x85
121 #define CCREP_RCON 0x86 // RocketGuy: ProQuake rcon support
123 typedef struct netconn_s
125 struct netconn_s *next;
127 lhnetsocket_t *mysocket;
128 lhnetaddress_t peeraddress;
130 // this is mostly identical to qsocket_t from quake
132 // if this time is reached, kick off peer
135 double lastMessageTime;
138 // writing buffer to send to peer as the next reliable message
139 // can be added to at any time, copied into sendMessage buffer when it is
140 // possible to send a reliable message and then cleared
142 unsigned char messagedata[NET_MAXMESSAGE];
144 // reliable message that is currently sending
145 // (for building fragments)
146 int sendMessageLength;
147 unsigned char sendMessage[NET_MAXMESSAGE];
149 // reliable message that is currently being received
150 // (for putting together fragments)
151 int receiveMessageLength;
152 unsigned char receiveMessage[NET_MAXMESSAGE];
154 // used by both NQ and QW protocols
155 unsigned int outgoing_unreliable_sequence;
159 unsigned int ackSequence;
160 unsigned int sendSequence;
162 unsigned int receiveSequence;
163 unsigned int unreliableReceiveSequence;
169 qboolean fatal_error;
171 float last_received; // for timeouts
173 // the statistics are cleared at each client begin, because
174 // the server connecting process gives a bogus picture of the data
175 float frame_latency; // rolling average
178 int drop_count; // dropped packets, cleared each level
179 int good_count; // cleared each level
183 // sequencing variables
184 int incoming_sequence;
185 int incoming_acknowledged;
186 int incoming_reliable_acknowledged; // single bit
188 int incoming_reliable_sequence; // single bit, maintained local
190 int reliable_sequence; // single bit
191 int last_reliable_sequence; // sequence number of last send
195 // bandwidth estimator
196 double cleartime; // if realtime > nc->cleartime, free to go
198 // this tracks packet loss and packet sizes on the most recent packets
199 // used by shownetgraph feature
200 #define NETGRAPH_PACKETS 100
201 #define NETGRAPH_NOPACKET 0
202 #define NETGRAPH_LOSTPACKET -1
203 #define NETGRAPH_CHOKEDPACKET -2
204 int incoming_packetcounter;
205 int incoming_reliablesize[NETGRAPH_PACKETS];
206 int incoming_unreliablesize[NETGRAPH_PACKETS];
207 int incoming_acksize[NETGRAPH_PACKETS];
208 int outgoing_packetcounter;
209 int outgoing_reliablesize[NETGRAPH_PACKETS];
210 int outgoing_unreliablesize[NETGRAPH_PACKETS];
211 int outgoing_acksize[NETGRAPH_PACKETS];
216 extern netconn_t *netconn_list;
217 extern mempool_t *netconn_mempool;
219 extern cvar_t hostname;
220 extern cvar_t developer_networking;
222 #define SERVERLIST_TOTALSIZE 2048
223 #define SERVERLIST_VIEWLISTSIZE SERVERLIST_TOTALSIZE
224 #define SERVERLIST_ANDMASKCOUNT 5
225 #define SERVERLIST_ORMASKCOUNT 5
227 typedef enum serverlist_maskop_e
229 // SLMO_CONTAINS is the default for strings
230 // SLMO_GREATEREQUAL is the default for numbers (also used when OP == CONTAINS or NOTCONTAINS
242 } serverlist_maskop_t;
244 // struct with all fields that you can search for or sort by
245 typedef struct serverlist_info_s
247 // address for connecting
249 // ping time for sorting servers
257 // name of the session
259 // qc-defined short status string
261 // frags/ping/name list (if they fit in the packet)
265 // number of currently connected players (including bots)
267 // number of currently connected players that are bots
269 // number of currently connected players that are not bots
271 // number of free slots
276 // (an integer that is used for filtering incompatible servers,
277 // not filterable by QC)
279 // favorite server flag
301 } serverlist_infofield_t;
306 SLSF_FAVORITESFIRST = 2
307 } serverlist_sortflags_t;
316 } serverlist_query_state;
318 typedef struct serverlist_entry_s
320 // used to determine whether this entry should be included into the final view
321 serverlist_query_state query;
322 // used to count the number of times the host has tried to query this server already
323 unsigned querycounter;
324 // used to calculate ping when update comes in
326 // query protocol to use on this server
327 int protocol; // may be PROTOCOL_QUAKEWORLD or PROTOCOL_DARKPLACES7
329 serverlist_info_t info;
334 } serverlist_entry_t;
336 typedef struct serverlist_mask_s
339 serverlist_maskop_t tests[SLIF_COUNT];
340 serverlist_info_t info;
343 extern serverlist_mask_t serverlist_andmasks[SERVERLIST_ANDMASKCOUNT];
344 extern serverlist_mask_t serverlist_ormasks[SERVERLIST_ORMASKCOUNT];
346 extern serverlist_infofield_t serverlist_sortbyfield;
347 extern int serverlist_sortflags; // not using the enum, as it is a bitmask
349 extern int serverlist_viewcount;
350 extern serverlist_entry_t *serverlist_viewlist[SERVERLIST_VIEWLISTSIZE];
352 extern int serverlist_cachecount;
354 extern qboolean serverlist_consoleoutput;
356 void ServerList_GetPlayerStatistics(int *numplayerspointer, int *maxplayerspointer);
358 //============================================================================
360 // public network functions
362 //============================================================================
364 extern char net_extresponse[NET_EXTRESPONSE_MAX][1400];
365 extern int net_extresponse_count;
366 extern int net_extresponse_last;
368 extern double masterquerytime;
369 extern int masterquerycount;
370 extern int masterreplycount;
371 extern int serverquerycount;
372 extern int serverreplycount;
374 extern sizebuf_t net_message;
376 extern cvar_t sv_public;
378 extern cvar_t cl_netlocalping;
380 extern cvar_t cl_netport;
381 extern cvar_t sv_netport;
382 extern cvar_t net_address;
383 extern cvar_t net_address_ipv6;
385 qboolean NetConn_CanSend(netconn_t *conn);
386 int NetConn_SendUnreliableMessage(netconn_t *conn, sizebuf_t *data, protocolversion_t protocol, int rate, qboolean quakesignon_suppressreliables);
387 qboolean NetConn_HaveClientPorts(void);
388 qboolean NetConn_HaveServerPorts(void);
389 void NetConn_CloseClientPorts(void);
390 void NetConn_OpenClientPorts(void);
391 void NetConn_CloseServerPorts(void);
392 void NetConn_OpenServerPorts(int opennetports);
393 void NetConn_UpdateSockets(void);
394 lhnetsocket_t *NetConn_ChooseClientSocketForAddress(lhnetaddress_t *address);
395 lhnetsocket_t *NetConn_ChooseServerSocketForAddress(lhnetaddress_t *address);
396 void NetConn_Init(void);
397 void NetConn_Shutdown(void);
398 netconn_t *NetConn_Open(lhnetsocket_t *mysocket, lhnetaddress_t *peeraddress);
399 void NetConn_Close(netconn_t *conn);
400 void NetConn_Listen(qboolean state);
401 int NetConn_Read(lhnetsocket_t *mysocket, void *data, int maxlength, lhnetaddress_t *peeraddress);
402 int NetConn_Write(lhnetsocket_t *mysocket, const void *data, int length, const lhnetaddress_t *peeraddress);
403 int NetConn_WriteString(lhnetsocket_t *mysocket, const char *string, const lhnetaddress_t *peeraddress);
404 int NetConn_IsLocalGame(void);
405 void NetConn_ClientFrame(void);
406 void NetConn_ServerFrame(void);
407 void NetConn_SleepMicroseconds(int microseconds);
408 void NetConn_QueryMasters(qboolean querydp, qboolean queryqw);
409 void NetConn_Heartbeat(int priority);
410 void NetConn_QueryQueueFrame(void);
411 void Net_Stats_f(void);
412 void Net_Slist_f(void);
413 void Net_SlistQW_f(void);
414 void Net_Refresh_f(void);
416 // ServerList interface (public)
417 // manually refresh the view set, do this after having changed the mask or any other flag
418 void ServerList_RebuildViewList(void);
419 void ServerList_ResetMasks(void);
420 void ServerList_QueryList(qboolean resetcache, qboolean querydp, qboolean queryqw, qboolean consoleoutput);
422 // called whenever net_slist_favorites changes
423 void NetConn_UpdateFavorites();