2 Copyright (C) 1996-1997 Id Software, Inc.
4 This program is free software; you can redistribute it and/or
5 modify it under the terms of the GNU General Public License
6 as published by the Free Software Foundation; either version 2
7 of the License, or (at your option) any later version.
9 This program is distributed in the hope that it will be useful,
10 but WITHOUT ANY WARRANTY; without even the implied warranty of
11 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
13 See the GNU General Public License for more details.
15 You should have received a copy of the GNU General Public License
16 along with this program; if not, write to the Free Software
17 Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
20 // net.h -- quake's interface to the networking layer
25 unsigned char sa_data[14];
29 #define NET_NAMELEN 64
31 #define NET_MAXMESSAGE 16384
32 #define NET_HEADERSIZE (2 * sizeof(unsigned int))
33 #define NET_DATAGRAMSIZE (MAX_DATAGRAM + NET_HEADERSIZE)
36 #define NETFLAG_LENGTH_MASK 0x0000ffff
37 #define NETFLAG_DATA 0x00010000
38 #define NETFLAG_ACK 0x00020000
39 #define NETFLAG_NAK 0x00040000
40 #define NETFLAG_EOM 0x00080000
41 #define NETFLAG_UNRELIABLE 0x00100000
42 #define NETFLAG_CTL 0x80000000
45 #define NET_PROTOCOL_VERSION 3
47 // This is the network info/connection protocol. It is used to find Quake
48 // servers, get info about them, and connect to them. Once connected, the
49 // Quake game protocol (documented elsewhere) is used.
53 // game_name is currently always "QUAKE", but is there so this same protocol
54 // can be used for future games as well; can you say Quake2?
57 // string game_name "QUAKE"
58 // byte net_protocol_version NET_PROTOCOL_VERSION
61 // string game_name "QUAKE"
62 // byte net_protocol_version NET_PROTOCOL_VERSION
79 // string server_address
82 // byte current_players
84 // byte protocol_version NET_PROTOCOL_VERSION
99 // There are two address forms used above. The short form is just a
100 // port number. The address that goes along with the port is defined as
101 // "whatever address you receive this reponse from". This lets us use
102 // the host OS to solve the problem of multiple host addresses (possibly
103 // with no routing between them); the host will use the right address
104 // when we reply to the inbound connection request. The long from is
105 // a full address and port in a string. It is used for returning the
106 // address of a server that is not running locally.
108 #define CCREQ_CONNECT 0x01
109 #define CCREQ_SERVER_INFO 0x02
110 #define CCREQ_PLAYER_INFO 0x03
111 #define CCREQ_RULE_INFO 0x04
113 #define CCREP_ACCEPT 0x81
114 #define CCREP_REJECT 0x82
115 #define CCREP_SERVER_INFO 0x83
116 #define CCREP_PLAYER_INFO 0x84
117 #define CCREP_RULE_INFO 0x85
119 typedef struct qsocket_s
121 struct qsocket_s *next;
123 double lastMessageTime;
126 qboolean disconnected;
135 unsigned int ackSequence;
136 unsigned int sendSequence;
137 unsigned int unreliableSendSequence;
138 int sendMessageLength;
139 byte sendMessage [NET_MAXMESSAGE];
141 unsigned int receiveSequence;
142 unsigned int unreliableReceiveSequence;
143 int receiveMessageLength;
144 byte receiveMessage [NET_MAXMESSAGE];
146 struct qsockaddr addr;
147 char address[NET_NAMELEN];
151 extern qsocket_t *net_activeSockets;
152 // LordHavoc: sockets are dynamically allocated now
153 //extern qsocket_t *net_freeSockets;
154 //extern int net_numsockets;
155 extern mempool_t *net_mempool;
160 qboolean initialized;
163 void (*Shutdown) (void);
164 void (*Listen) (qboolean state);
165 int (*OpenSocket) (int port);
166 int (*CloseSocket) (int socket);
167 int (*Connect) (int socket, struct qsockaddr *addr);
168 int (*CheckNewConnections) (void);
169 int (*Read) (int socket, byte *buf, int len, struct qsockaddr *addr);
170 int (*Write) (int socket, byte *buf, int len, struct qsockaddr *addr);
171 int (*Broadcast) (int socket, byte *buf, int len);
172 char * (*AddrToString) (struct qsockaddr *addr);
173 int (*StringToAddr) (char *string, struct qsockaddr *addr);
174 int (*GetSocketAddr) (int socket, struct qsockaddr *addr);
175 int (*GetNameFromAddr) (struct qsockaddr *addr, char *name);
176 int (*GetAddrFromName) (char *name, struct qsockaddr *addr);
177 int (*AddrCompare) (struct qsockaddr *addr1, struct qsockaddr *addr2);
178 int (*GetSocketPort) (struct qsockaddr *addr);
179 int (*SetSocketPort) (struct qsockaddr *addr, int port);
182 #define MAX_NET_DRIVERS 8
183 extern int net_numlandrivers;
184 extern net_landriver_t net_landrivers[MAX_NET_DRIVERS];
189 qboolean initialized;
191 void (*Listen) (qboolean state);
192 void (*SearchForHosts) (qboolean xmit);
193 qsocket_t *(*Connect) (char *host);
194 qsocket_t *(*CheckNewConnections) (void);
195 int (*QGetMessage) (qsocket_t *sock);
196 int (*QSendMessage) (qsocket_t *sock, sizebuf_t *data);
197 int (*SendUnreliableMessage) (qsocket_t *sock, sizebuf_t *data);
198 qboolean (*CanSendMessage) (qsocket_t *sock);
199 qboolean (*CanSendUnreliableMessage) (qsocket_t *sock);
200 void (*Close) (qsocket_t *sock);
201 void (*Shutdown) (void);
205 extern int net_numdrivers;
206 extern net_driver_t net_drivers[MAX_NET_DRIVERS];
208 extern int DEFAULTnet_hostport;
209 extern int net_hostport;
211 extern int net_driverlevel;
212 extern cvar_t hostname;
213 extern char playername[];
214 extern int playercolor;
216 extern int messagesSent;
217 extern int messagesReceived;
218 extern int unreliableMessagesSent;
219 extern int unreliableMessagesReceived;
221 qsocket_t *NET_NewQSocket (void);
222 void NET_FreeQSocket(qsocket_t *);
223 double SetNetTime(void);
226 #define HOSTCACHESIZE 8
237 struct qsockaddr addr;
240 extern int hostCacheCount;
241 extern hostcache_t hostcache[HOSTCACHESIZE];
243 #if !defined(_WIN32 ) && !defined (__linux__) && !defined (__sun__)
245 extern unsigned long htonl (unsigned long hostlong);
248 extern unsigned short htons (unsigned short hostshort);
251 extern unsigned long ntohl (unsigned long netlong);
254 extern unsigned short ntohs (unsigned short netshort);
258 //============================================================================
260 // public network functions
262 //============================================================================
264 extern double net_time;
265 extern sizebuf_t net_message;
266 extern int net_activeconnections;
268 void NET_Init (void);
269 void NET_Shutdown (void);
271 struct qsocket_s *NET_CheckNewConnections (void);
272 // returns a new connection number if there is one pending, else -1
274 struct qsocket_s *NET_Connect (char *host);
275 // called by client to connect to a host. Returns -1 if not able to
277 qboolean NET_CanSendMessage (qsocket_t *sock);
278 // Returns true or false if the given qsocket can currently accept a
279 // message to be transmitted.
281 int NET_GetMessage (struct qsocket_s *sock);
282 // returns data in net_message sizebuf
283 // returns 0 if no data is waiting
284 // returns 1 if a message was received
285 // returns 2 if an unreliable message was received
286 // returns -1 if the connection died
288 int NET_SendMessage (struct qsocket_s *sock, sizebuf_t *data);
289 int NET_SendUnreliableMessage (struct qsocket_s *sock, sizebuf_t *data);
290 // returns 0 if the message connot be delivered reliably, but the connection
291 // is still considered valid
292 // returns 1 if the message was sent properly
293 // returns -1 if the connection died
295 int NET_SendToAll(sizebuf_t *data, int blocktime);
296 // This is a reliable *blocking* send to all attached clients.
299 void NET_Close (struct qsocket_s *sock);
300 // if a dead connection is returned by a get or send function, this function
301 // should be called when it is convenient
303 // Server calls when a client is kicked off for a game related misbehavior
304 // like an illegal protocal conversation. Client calls when disconnecting
306 // A netcon_t number will not be reused until this function is called for it
311 typedef struct _PollProcedure
313 struct _PollProcedure *next;
319 void SchedulePollProcedure(PollProcedure *pp, double timeOffset);
321 extern qboolean ipxAvailable;
322 extern qboolean tcpipAvailable;
323 extern char my_ipx_address[NET_NAMELEN];
324 extern char my_tcpip_address[NET_NAMELEN];
326 extern qboolean slistInProgress;
327 extern qboolean slistSilent;
328 extern qboolean slistLocal;
330 extern cvar_t hostname;
332 void NET_Slist_f (void);