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
74 // string server_address
77 // byte current_players
79 // byte protocol_version NET_PROTOCOL_VERSION
94 // There are two address forms used above. The short form is just a
95 // port number. The address that goes along with the port is defined as
96 // "whatever address you receive this reponse from". This lets us use
97 // the host OS to solve the problem of multiple host addresses (possibly
98 // with no routing between them); the host will use the right address
99 // when we reply to the inbound connection request. The long from is
100 // a full address and port in a string. It is used for returning the
101 // address of a server that is not running locally.
103 #define CCREQ_CONNECT 0x01
104 #define CCREQ_SERVER_INFO 0x02
105 #define CCREQ_PLAYER_INFO 0x03
106 #define CCREQ_RULE_INFO 0x04
108 #define CCREP_ACCEPT 0x81
109 #define CCREP_REJECT 0x82
110 #define CCREP_SERVER_INFO 0x83
111 #define CCREP_PLAYER_INFO 0x84
112 #define CCREP_RULE_INFO 0x85
114 typedef struct netconn_s
116 struct netconn_s *next;
118 lhnetsocket_t *mysocket;
119 lhnetaddress_t peeraddress;
121 // this is mostly identical to qsocket_t from quake
123 // if this time is reached, kick off peer
126 double lastMessageTime;
129 // writing buffer to send to peer as the next reliable message
130 // can be added to at any time, copied into sendMessage buffer when it is
131 // possible to send a reliable message and then cleared
133 unsigned char messagedata[NET_MAXMESSAGE];
135 // reliable message that is currently sending
136 // (for building fragments)
137 int sendMessageLength;
138 unsigned char sendMessage[NET_MAXMESSAGE];
140 // reliable message that is currently being received
141 // (for putting together fragments)
142 int receiveMessageLength;
143 unsigned char receiveMessage[NET_MAXMESSAGE];
145 // used by both NQ and QW protocols
146 unsigned int outgoing_unreliable_sequence;
150 unsigned int ackSequence;
151 unsigned int sendSequence;
153 unsigned int receiveSequence;
154 unsigned int unreliableReceiveSequence;
160 qboolean fatal_error;
162 float last_received; // for timeouts
164 // the statistics are cleared at each client begin, because
165 // the server connecting process gives a bogus picture of the data
166 float frame_latency; // rolling average
169 int drop_count; // dropped packets, cleared each level
170 int good_count; // cleared each level
174 // sequencing variables
175 int incoming_sequence;
176 int incoming_acknowledged;
177 int incoming_reliable_acknowledged; // single bit
179 int incoming_reliable_sequence; // single bit, maintained local
181 int reliable_sequence; // single bit
182 int last_reliable_sequence; // sequence number of last send
186 // bandwidth estimator
187 double cleartime; // if realtime > nc->cleartime, free to go
189 // this tracks packet loss and packet sizes on the most recent packets
190 // used by shownetgraph feature
191 #define NETGRAPH_PACKETS 100
192 #define NETGRAPH_NOPACKET 0
193 #define NETGRAPH_LOSTPACKET -1
194 #define NETGRAPH_CHOKEDPACKET -2
195 int incoming_packetcounter;
196 int incoming_reliablesize[NETGRAPH_PACKETS];
197 int incoming_unreliablesize[NETGRAPH_PACKETS];
198 int incoming_acksize[NETGRAPH_PACKETS];
199 int outgoing_packetcounter;
200 int outgoing_reliablesize[NETGRAPH_PACKETS];
201 int outgoing_unreliablesize[NETGRAPH_PACKETS];
202 int outgoing_acksize[NETGRAPH_PACKETS];
207 extern netconn_t *netconn_list;
208 extern mempool_t *netconn_mempool;
210 extern cvar_t hostname;
211 extern cvar_t developer_networking;
213 #define SERVERLIST_TOTALSIZE 2048
214 #define SERVERLIST_VIEWLISTSIZE SERVERLIST_TOTALSIZE
215 #define SERVERLIST_ANDMASKCOUNT 5
216 #define SERVERLIST_ORMASKCOUNT 5
218 typedef enum serverlist_maskop_e
220 // SLMO_CONTAINS is the default for strings
221 // SLMO_GREATEREQUAL is the default for numbers (also used when OP == CONTAINS or NOTCONTAINS
231 } serverlist_maskop_t;
233 // struct with all fields that you can search for or sort by
234 typedef struct serverlist_info_s
236 // address for connecting
238 // ping time for sorting servers
246 // name of the session
250 // number of currently connected players (including bots)
252 // number of currently connected players that are bots
254 // number of currently connected players that are not bots
256 // number of free slots
261 // (an integer that is used for filtering incompatible servers,
262 // not filterable by QC)
281 } serverlist_infofield_t;
290 } serverlist_query_state;
292 typedef struct serverlist_entry_s
294 // used to determine whether this entry should be included into the final view
295 serverlist_query_state query;
296 // used to count the number of times the host has tried to query this server already
297 unsigned querycounter;
298 // used to calculate ping when update comes in
300 // query protocol to use on this server
301 int protocol; // may be PROTOCOL_QUAKEWORLD or PROTOCOL_DARKPLACES7
303 serverlist_info_t info;
308 } serverlist_entry_t;
310 typedef struct serverlist_mask_s
313 serverlist_maskop_t tests[SLIF_COUNT];
314 serverlist_info_t info;
317 extern serverlist_mask_t serverlist_andmasks[SERVERLIST_ANDMASKCOUNT];
318 extern serverlist_mask_t serverlist_ormasks[SERVERLIST_ORMASKCOUNT];
320 extern serverlist_infofield_t serverlist_sortbyfield;
321 extern qboolean serverlist_sortdescending;
323 extern int serverlist_viewcount;
324 extern serverlist_entry_t *serverlist_viewlist[SERVERLIST_VIEWLISTSIZE];
326 extern int serverlist_cachecount;
328 extern qboolean serverlist_consoleoutput;
330 void ServerList_GetPlayerStatistics(int *numplayerspointer, int *maxplayerspointer);
332 //============================================================================
334 // public network functions
336 //============================================================================
338 extern char net_extresponse[NET_EXTRESPONSE_MAX][1400];
339 extern int net_extresponse_count;
340 extern int net_extresponse_last;
342 extern double masterquerytime;
343 extern int masterquerycount;
344 extern int masterreplycount;
345 extern int serverquerycount;
346 extern int serverreplycount;
348 extern sizebuf_t net_message;
350 extern cvar_t sv_public;
352 extern cvar_t cl_netlocalping;
354 extern cvar_t cl_netport;
355 extern cvar_t sv_netport;
356 extern cvar_t net_address;
357 //extern cvar_t net_netaddress_ipv6;
359 qboolean NetConn_CanSend(netconn_t *conn);
360 int NetConn_SendUnreliableMessage(netconn_t *conn, sizebuf_t *data, protocolversion_t protocol, int rate, qboolean quakesignon_suppressreliables);
361 qboolean NetConn_HaveClientPorts(void);
362 qboolean NetConn_HaveServerPorts(void);
363 void NetConn_CloseClientPorts(void);
364 void NetConn_OpenClientPorts(void);
365 void NetConn_CloseServerPorts(void);
366 void NetConn_OpenServerPorts(int opennetports);
367 void NetConn_UpdateSockets(void);
368 lhnetsocket_t *NetConn_ChooseClientSocketForAddress(lhnetaddress_t *address);
369 lhnetsocket_t *NetConn_ChooseServerSocketForAddress(lhnetaddress_t *address);
370 void NetConn_Init(void);
371 void NetConn_Shutdown(void);
372 netconn_t *NetConn_Open(lhnetsocket_t *mysocket, lhnetaddress_t *peeraddress);
373 void NetConn_Close(netconn_t *conn);
374 void NetConn_Listen(qboolean state);
375 int NetConn_Read(lhnetsocket_t *mysocket, void *data, int maxlength, lhnetaddress_t *peeraddress);
376 int NetConn_Write(lhnetsocket_t *mysocket, const void *data, int length, const lhnetaddress_t *peeraddress);
377 int NetConn_WriteString(lhnetsocket_t *mysocket, const char *string, const lhnetaddress_t *peeraddress);
378 int NetConn_IsLocalGame(void);
379 void NetConn_ClientFrame(void);
380 void NetConn_ServerFrame(void);
381 void NetConn_SleepMicroseconds(int microseconds);
382 void NetConn_QueryMasters(qboolean querydp, qboolean queryqw);
383 void NetConn_Heartbeat(int priority);
384 void NetConn_QueryQueueFrame(void);
385 void Net_Stats_f(void);
386 void Net_Slist_f(void);
387 void Net_SlistQW_f(void);
388 void Net_Refresh_f(void);
390 // ServerList interface (public)
391 // manually refresh the view set, do this after having changed the mask or any other flag
392 void ServerList_RebuildViewList(void);
393 void ServerList_ResetMasks(void);
394 void ServerList_QueryList(qboolean resetcache, qboolean querydp, qboolean queryqw, qboolean consoleoutput);