dxx-rebirth/include/ipx.h

/* $Id: ipx.h,v 1.8 2003-10-12 09:17:47 btb Exp $ */
/*
THE COMPUTER CODE CONTAINED HEREIN IS THE SOLE PROPERTY OF PARALLAX
SOFTWARE CORPORATION ("PARALLAX").  PARALLAX, IN DISTRIBUTING THE CODE TO
END-USERS, AND SUBJECT TO ALL OF THE TERMS AND CONDITIONS HEREIN, GRANTS A
ROYALTY-FREE, PERPETUAL LICENSE TO SUCH END-USERS FOR USE BY SUCH END-USERS
IN USING, DISPLAYING,  AND CREATING DERIVATIVE WORKS THEREOF, SO LONG AS
SUCH USE, DISPLAY OR CREATION IS FOR NON-COMMERCIAL, ROYALTY OR REVENUE
FREE PURPOSES.  IN NO EVENT SHALL THE END-USER USE THE COMPUTER CODE
CONTAINED HEREIN FOR REVENUE-BEARING PURPOSES.  THE END-USER UNDERSTANDS
AND AGREES TO THE TERMS HEREIN AND ACCEPTS THE SAME BY USE OF THIS FILE.
COPYRIGHT 1993-1998 PARALLAX SOFTWARE CORPORATION.  ALL RIGHTS RESERVED.
*/
/*
 *
 * Prototypes for lower-level network routines.
 * This file is called ipx.h and the prefix of these routines is "ipx_"
 * because orignally IPX was the only network driver.
 *
 *
 * Old Log:
 * Revision 2.6  1995/03/29  11:19:32  john
 * Added broadcasting over a net.
 *
 * Revision 2.5  1995/03/28  20:04:43  john
 * Took away alternate server stuff.
 *
 * Revision 2.4  1995/03/23  19:00:10  john
 * Added user list capabitly.
 *
 * Revision 2.3  1995/03/23  12:26:57  john
 * Move IPX into bios lib.
 *
 * Revision 2.2  1995/03/22  19:08:14  john
 * Added code to fix sending packets over router... now
 * we just need to make broadcasts go over router!!
 *
 * Revision 2.1  1995/03/21  08:39:56  john
 * Ifdef'd out the NETWORK code.
 *
 * Revision 2.0  1995/02/27  11:30:16  john
 * New version 2.0, which has no anonymous unions, builds with
 * Watcom 10.0, and doesn't require parsing BITMAPS.TBL.
 *
 * Revision 1.16  1995/02/16  17:34:52  john
 * Added code to allow dynamic socket changing.
 *
 * Revision 1.15  1995/01/04  21:43:27  rob
 * Remove SPX size definition.
 *
 * Revision 1.14  1995/01/03  13:46:18  john
 * Added code that should make ipx work over different servers,
 * but ifdef'd it out with SHAREWARE in ipx.c.  I haven't tested
 * this, and I hope it doesn't introduce net bugs.
 *
 * Revision 1.13  1994/11/02  11:37:16  rob
 * Changed default socket number to a higher regions.
 *
 * Revision 1.12  1994/11/01  15:56:51  rob
 * Added defines for SPX socketsx.
 *
 * Revision 1.11  1994/10/31  19:23:31  rob
 * Added a prototype for the new object send function.
 *
 * Revision 1.10  1994/09/07  13:37:25  john
 * Changed default socket to 0x4000, because
 * the ipx/spx book says that we can only use
 * sockets 0x4000 - 0x7fff.
 *
 * Revision 1.9  1994/08/25  18:14:45  matt
 * Changed socket because of packet change
 *
 * Revision 1.8  1994/08/12  22:42:24  john
 * Took away Player_stats; added Players array.
 *
 * Revision 1.7  1994/08/09  19:31:47  john
 * Networking changes.
 *
 * Revision 1.6  1994/08/05  16:11:46  john
 * Psuedo working version of networking.
 *
 * Revision 1.5  1994/08/04  19:17:20  john
 * Inbetween version of network stuff.
 *
 * Revision 1.4  1994/07/29  16:08:59  john
 * *** empty log message ***
 *
 * Revision 1.3  1994/07/25  12:33:22  john
 * Network "pinging" in.
 *
 * Revision 1.2  1994/07/20  15:58:29  john
 * First installment of ipx stuff.
 *
 * Revision 1.1  1994/07/19  15:43:05  john
 * Initial revision
 *
 *
 */

#ifndef _IPX_H
#define _IPX_H

#include "pstypes.h"

// The default socket to use.
#ifdef SHAREWARE
         #define IPX_DEFAULT_SOCKET 0x5110
#else
         #define IPX_DEFAULT_SOCKET 0x5130
#endif

#define IPX_DRIVER_IPX  1 // IPX "IPX driver" :-)
#define IPX_DRIVER_KALI 2
#define IPX_DRIVER_UDP  3 // UDP/IP, user datagrams protocol over the internet
#define IPX_DRIVER_MCAST4 4 // UDP/IP, user datagrams protocol over multicast networks

/* Sets the "IPX driver" (net driver).  Takes one of the above consts as argument. */
extern void arch_ipx_set_driver(int ipx_driver);

#define IPX_INIT_OK              0
#define IPX_SOCKET_ALREADY_OPEN -1
#define IPX_SOCKET_TABLE_FULL   -2
#define IPX_NOT_INSTALLED       -3
#define IPX_NO_LOW_DOS_MEM      -4 // couldn't allocate low dos memory
#define IPX_ERROR_GETTING_ADDR  -5 // error with getting internetwork address

/* returns one of the above constants */
extern int ipx_init(int socket_number);

extern void ipx_close(void);

extern int ipx_change_default_socket( ushort socket_number );

// Returns a pointer to 6-byte address
extern ubyte * ipx_get_my_local_address();
// Returns a pointer to 4-byte server
extern ubyte * ipx_get_my_server_address();

// Determines the local address equivalent of an internetwork address.
void ipx_get_local_target( ubyte * server, ubyte * node, ubyte * local_target );

// If any packets waiting to be read in, this fills data in with the packet data and returns
// the number of bytes read.  Else returns 0 if no packets waiting.
extern int ipx_get_packet_data( ubyte * data );

// Sends a broadcast packet to everyone on this socket.
extern void ipx_send_broadcast_packet_data( ubyte * data, int datasize );

// Sends a packet to a certain address
extern void ipx_send_packet_data( ubyte * data, int datasize, ubyte *network, ubyte *address, ubyte *immediate_address );
extern void ipx_send_internetwork_packet_data( ubyte * data, int datasize, ubyte * server, ubyte *address );

// Sends a packet to everyone in the game
extern int ipx_send_game_packet(ubyte *data, int datasize);

// Initialize and handle the protocol-specific field of the netgame struct.
extern void ipx_init_netgame_aux_data(ubyte data[]);
extern int ipx_handle_netgame_aux_data(const ubyte data[]);
// Handle disconnecting from the game
extern void ipx_handle_leave_game();

#define IPX_MAX_DATA_SIZE (542)		//(546-4)

extern void ipx_read_user_file(char * filename);
extern void ipx_read_network_file(char * filename);

#endif