enable -nofade
[btb/d2x.git] / include / ipx.h
1 /* $Id: ipx.h,v 1.5 2002-08-29 09:03:36 btb Exp $ */
2 /*
3 THE COMPUTER CODE CONTAINED HEREIN IS THE SOLE PROPERTY OF PARALLAX
4 SOFTWARE CORPORATION ("PARALLAX").  PARALLAX, IN DISTRIBUTING THE CODE TO
5 END-USERS, AND SUBJECT TO ALL OF THE TERMS AND CONDITIONS HEREIN, GRANTS A
6 ROYALTY-FREE, PERPETUAL LICENSE TO SUCH END-USERS FOR USE BY SUCH END-USERS
7 IN USING, DISPLAYING,  AND CREATING DERIVATIVE WORKS THEREOF, SO LONG AS
8 SUCH USE, DISPLAY OR CREATION IS FOR NON-COMMERCIAL, ROYALTY OR REVENUE
9 FREE PURPOSES.  IN NO EVENT SHALL THE END-USER USE THE COMPUTER CODE
10 CONTAINED HEREIN FOR REVENUE-BEARING PURPOSES.  THE END-USER UNDERSTANDS
11 AND AGREES TO THE TERMS HEREIN AND ACCEPTS THE SAME BY USE OF THIS FILE.
12 COPYRIGHT 1993-1998 PARALLAX SOFTWARE CORPORATION.  ALL RIGHTS RESERVED.
13 */
14 /*
15  *
16  * Prototype for IPX communications.
17  *
18  * Old Log:
19  * Revision 2.6  1995/03/29  11:19:32  john
20  * Added broadcasting over a net.
21  *
22  * Revision 2.5  1995/03/28  20:04:43  john
23  * Took away alternate server stuff.
24  *
25  * Revision 2.4  1995/03/23  19:00:10  john
26  * Added user list capabitly.
27  *
28  * Revision 2.3  1995/03/23  12:26:57  john
29  * Move IPX into bios lib.
30  *
31  * Revision 2.2  1995/03/22  19:08:14  john
32  * Added code to fix sending packets over router... now
33  * we just need to make broadcasts go over router!!
34  *
35  * Revision 2.1  1995/03/21  08:39:56  john
36  * Ifdef'd out the NETWORK code.
37  *
38  * Revision 2.0  1995/02/27  11:30:16  john
39  * New version 2.0, which has no anonymous unions, builds with
40  * Watcom 10.0, and doesn't require parsing BITMAPS.TBL.
41  *
42  * Revision 1.16  1995/02/16  17:34:52  john
43  * Added code to allow dynamic socket changing.
44  *
45  * Revision 1.15  1995/01/04  21:43:27  rob
46  * Remove SPX size definition.
47  *
48  * Revision 1.14  1995/01/03  13:46:18  john
49  * Added code that should make ipx work over different servers,
50  * but ifdef'd it out with SHAREWARE in ipx.c.  I haven't tested
51  * this, and I hope it doesn't introduce net bugs.
52  *
53  * Revision 1.13  1994/11/02  11:37:16  rob
54  * Changed default socket number to a higher regions.
55  *
56  * Revision 1.12  1994/11/01  15:56:51  rob
57  * Added defines for SPX socketsx.
58  *
59  * Revision 1.11  1994/10/31  19:23:31  rob
60  * Added a prototype for the new object send function.
61  *
62  * Revision 1.10  1994/09/07  13:37:25  john
63  * Changed default socket to 0x4000, because
64  * the ipx/spx book says that we can only use
65  * sockets 0x4000 - 0x7fff.
66  *
67  * Revision 1.9  1994/08/25  18:14:45  matt
68  * Changed socket because of packet change
69  *
70  * Revision 1.8  1994/08/12  22:42:24  john
71  * Took away Player_stats; added Players array.
72  *
73  * Revision 1.7  1994/08/09  19:31:47  john
74  * Networking changes.
75  *
76  * Revision 1.6  1994/08/05  16:11:46  john
77  * Psuedo working version of networking.
78  *
79  * Revision 1.5  1994/08/04  19:17:20  john
80  * Inbetween version of network stuff.
81  *
82  * Revision 1.4  1994/07/29  16:08:59  john
83  * *** empty log message ***
84  *
85  * Revision 1.3  1994/07/25  12:33:22  john
86  * Network "pinging" in.
87  *
88  * Revision 1.2  1994/07/20  15:58:29  john
89  * First installment of ipx stuff.
90  *
91  * Revision 1.1  1994/07/19  15:43:05  john
92  * Initial revision
93  *
94  *
95  */
96
97 #ifndef _IPX_H
98 #define _IPX_H
99
100 // The default socket to use.
101 #ifdef SHAREWARE
102          #define IPX_DEFAULT_SOCKET 0x5110
103 #else
104          #define IPX_DEFAULT_SOCKET 0x5130
105 #endif
106
107 //---------------------------------------------------------------
108 // Initializes all IPX internals.
109 // If socket_number==0, then opens next available socket.
110 // Returns:     0  if successful.
111 //                              -1 if socket already open.
112 //                              -2      if socket table full.
113 //                              -3 if IPX not installed.
114 //                              -4 if couldn't allocate low dos memory
115 //                              -5 if error with getting internetwork address
116 extern int ipx_init( int socket_number, int show_address );
117
118 extern int ipx_change_default_socket( ushort socket_number );
119
120 // Returns a pointer to 6-byte address
121 extern ubyte * ipx_get_my_local_address();
122 // Returns a pointer to 4-byte server
123 extern ubyte * ipx_get_my_server_address();
124
125 // Determines the local address equivalent of an internetwork address.
126 void ipx_get_local_target( ubyte * server, ubyte * node, ubyte * local_target );
127
128 // If any packets waiting to be read in, this fills data in with the packet data and returns
129 // the number of bytes read.  Else returns 0 if no packets waiting.
130 extern int ipx_get_packet_data( ubyte * data );
131
132 // Sends a broadcast packet to everyone on this socket.
133 extern void ipx_send_broadcast_packet_data( ubyte * data, int datasize );
134
135 // Sends a packet to a certain address
136 extern void ipx_send_packet_data( ubyte * data, int datasize, ubyte *network, ubyte *address, ubyte *immediate_address );
137 extern void ipx_send_internetwork_packet_data( ubyte * data, int datasize, ubyte * server, ubyte *address );
138
139 #define IPX_MAX_DATA_SIZE (542)         //(546-4)
140
141 extern void ipx_read_user_file(char * filename);
142 extern void ipx_read_network_file(char * filename);
143
144 #endif