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
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.
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?
51 // string game_name "QUAKE"
52 // byte net_protocol_version NET_PROTOCOL_VERSION
55 // string game_name "QUAKE"
56 // byte net_protocol_version NET_PROTOCOL_VERSION
73 // string server_address
76 // byte current_players
78 // byte protocol_version NET_PROTOCOL_VERSION
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.
102 #define CCREQ_CONNECT 0x01
103 #define CCREQ_SERVER_INFO 0x02
104 #define CCREQ_PLAYER_INFO 0x03
105 #define CCREQ_RULE_INFO 0x04
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
113 typedef struct netconn_s
115 struct netconn_s *next;
117 lhnetsocket_t *mysocket;
118 lhnetaddress_t peeraddress;
120 // this is mostly identical to qsocket_t from quake
122 // if this time is reached, kick off peer
125 double lastMessageTime;
131 unsigned int ackSequence;
132 unsigned int sendSequence;
133 unsigned int unreliableSendSequence;
134 int sendMessageLength;
135 qbyte sendMessage[NET_MAXMESSAGE];
137 unsigned int receiveSequence;
138 unsigned int unreliableReceiveSequence;
139 int receiveMessageLength;
140 qbyte receiveMessage[NET_MAXMESSAGE];
145 extern netconn_t *netconn_list;
146 extern mempool_t *netconn_mempool;
148 extern cvar_t hostname;
149 extern cvar_t developer_networking;
150 extern char playername[];
151 extern int playercolor;
153 #define SERVERLIST_TOTALSIZE 2048
154 #define SERVERLIST_VIEWLISTSIZE SERVERLIST_TOTALSIZE
155 #define SERVERLIST_ANDMASKCOUNT 5
156 #define SERVERLIST_ORMASKCOUNT 5
158 typedef enum serverlist_maskop_e
160 // SLMO_CONTAINS is the default for strings
161 // SLMO_GREATEREQUAL is the default for numbers (also used when OP == CONTAINS or NOTCONTAINS
171 } serverlist_maskop_t;
173 // struct with all fields that you can search for or sort by
174 typedef struct serverlist_info_s
176 // address for connecting
178 // ping time for sorting servers
186 // name of the session
190 // number of currently connected players
208 } serverlist_infofield_t;
216 } serverlist_query_state;
218 typedef struct serverlist_entry_s
220 // used to determine whether this entry should be included into the final view
221 serverlist_query_state query;
222 // used to count the number of times the host has tried to query this server already
223 unsigned querycounter;
224 // used to calculate ping when update comes in
227 serverlist_info_t info;
232 } serverlist_entry_t;
234 typedef struct serverlist_mask_s
237 serverlist_maskop_t tests[SLIF_COUNT];
238 serverlist_info_t info;
241 extern serverlist_mask_t serverlist_andmasks[SERVERLIST_ANDMASKCOUNT];
242 extern serverlist_mask_t serverlist_ormasks[SERVERLIST_ORMASKCOUNT];
244 extern serverlist_infofield_t serverlist_sortbyfield;
245 extern qboolean serverlist_sortdescending;
247 extern int serverlist_viewcount;
248 extern serverlist_entry_t *serverlist_viewlist[SERVERLIST_VIEWLISTSIZE];
250 extern int serverlist_cachecount;
252 extern qboolean serverlist_consoleoutput;
254 #if !defined(_WIN32) && !defined(__linux__) && !defined(SUNOS)
256 extern unsigned long htonl (unsigned long hostlong);
259 extern unsigned short htons (unsigned short hostshort);
262 extern unsigned long ntohl (unsigned long netlong);
265 extern unsigned short ntohs (unsigned short netshort);
269 //============================================================================
271 // public network functions
273 //============================================================================
275 extern double masterquerytime;
276 extern int masterquerycount;
277 extern int masterreplycount;
278 extern int serverquerycount;
279 extern int serverreplycount;
281 extern sizebuf_t net_message;
283 extern cvar_t cl_netlocalping;
285 int NetConn_SendReliableMessage(netconn_t *conn, sizebuf_t *data);
286 //void NetConn_SendMessageNext(netconn_t *conn);
287 //void NetConn_ReSendMessage(netconn_t *conn);
288 qboolean NetConn_CanSendMessage(netconn_t *conn);
289 int NetConn_SendUnreliableMessage(netconn_t *conn, sizebuf_t *data);
290 void NetConn_CloseClientPorts(void);
291 void NetConn_OpenClientPorts(void);
292 void NetConn_CloseServerPorts(void);
293 void NetConn_OpenServerPorts(int opennetports);
294 lhnetsocket_t *NetConn_ChooseClientSocketForAddress(lhnetaddress_t *address);
295 lhnetsocket_t *NetConn_ChooseServerSocketForAddress(lhnetaddress_t *address);
296 void NetConn_Init(void);
297 void NetConn_Shutdown(void);
298 netconn_t *NetConn_Open(lhnetsocket_t *mysocket, lhnetaddress_t *peeraddress);
299 void NetConn_Close(netconn_t *conn);
300 void NetConn_Listen(qboolean state);
301 int NetConn_IsLocalGame(void);
302 //int NetConn_ReceivedMessage(netconn_t *conn, qbyte *data, int length);
303 //int NetConn_ClientParsePacket(lhnetsocket_t *mysocket, qbyte *data, int length, lhnetaddress_t *peeraddress);
304 //int NetConn_ServerParsePacket(lhnetsocket_t *mysocket, qbyte *data, int length, lhnetaddress_t *peeraddress);
305 void NetConn_ClientFrame(void);
306 void NetConn_ServerFrame(void);
307 void NetConn_QueryMasters(void);
308 void NetConn_Heartbeat(int priority);
309 void NetConn_QueryQueueFrame(void);
310 int NetConn_SendToAll(sizebuf_t *data, double blocktime);
311 void Net_Stats_f(void);
312 void Net_Slist_f(void);
314 // ServerList interface (public)
315 // manually refresh the view set, do this after having changed the mask or any other flag
316 void ServerList_RebuildViewList(void);
317 void ServerList_ResetMasks(void);
318 void ServerList_QueryList(void);