include/ipx.h

   1 /*
   2 THE COMPUTER CODE CONTAINED HEREIN IS THE SOLE PROPERTY OF PARALLAX
   3 SOFTWARE CORPORATION ("PARALLAX").  PARALLAX, IN DISTRIBUTING THE CODE TO
   4 END-USERS, AND SUBJECT TO ALL OF THE TERMS AND CONDITIONS HEREIN, GRANTS A
   5 ROYALTY-FREE, PERPETUAL LICENSE TO SUCH END-USERS FOR USE BY SUCH END-USERS
   6 IN USING, DISPLAYING,  AND CREATING DERIVATIVE WORKS THEREOF, SO LONG AS
   7 SUCH USE, DISPLAY OR CREATION IS FOR NON-COMMERCIAL, ROYALTY OR REVENUE
   8 FREE PURPOSES.  IN NO EVENT SHALL THE END-USER USE THE COMPUTER CODE
   9 CONTAINED HEREIN FOR REVENUE-BEARING PURPOSES.  THE END-USER UNDERSTANDS
  10 AND AGREES TO THE TERMS HEREIN AND ACCEPTS THE SAME BY USE OF THIS FILE.
  11 COPYRIGHT 1993-1998 PARALLAX SOFTWARE CORPORATION.  ALL RIGHTS RESERVED.
  12 */
  13 /*
  14  *
  15  * Prototypes for lower-level network routines.
  16  * This file is called ipx.h and the prefix of these routines is "ipx_"
  17  * because orignally IPX was the only network driver.
  18  *
  19  */
  20
  21 #ifndef _IPX_H
  22 #define _IPX_H
  23
  24 #include "pstypes.h"
  25
  26 // The default socket to use.
  27 #ifdef SHAREWARE
  28          #define IPX_DEFAULT_SOCKET 0x5110
  29 #else
  30          #define IPX_DEFAULT_SOCKET 0x5130
  31 #endif
  32
  33 #define IPX_DRIVER_IPX  1 // IPX "IPX driver" :-)
  34 #define IPX_DRIVER_KALI 2
  35 #define IPX_DRIVER_UDP  3 // UDP/IP, user datagrams protocol over the internet
  36 #define IPX_DRIVER_MCAST4 4 // UDP/IP, user datagrams protocol over multicast networks
  37
  38 /* Sets the "IPX driver" (net driver).  Takes one of the above consts as argument. */
  39 extern void arch_ipx_set_driver(int ipx_driver);
  40
  41 #define IPX_INIT_OK              0
  42 #define IPX_SOCKET_ALREADY_OPEN -1
  43 #define IPX_SOCKET_TABLE_FULL   -2
  44 #define IPX_NOT_INSTALLED       -3
  45 #define IPX_NO_LOW_DOS_MEM      -4 // couldn't allocate low dos memory
  46 #define IPX_ERROR_GETTING_ADDR  -5 // error with getting internetwork address
  47
  48 /* returns one of the above constants */
  49 extern int ipx_init(int socket_number);
  50
  51 extern void ipx_close(void);
  52
  53 extern int ipx_change_default_socket( ushort socket_number );
  54
  55 // Returns a pointer to 6-byte address
  56 extern ubyte * ipx_get_my_local_address(void);
  57 // Returns a pointer to 4-byte server
  58 extern ubyte * ipx_get_my_server_address(void);
  59
  60 // Determines the local address equivalent of an internetwork address.
  61 void ipx_get_local_target( ubyte * server, ubyte * node, ubyte * local_target );
  62
  63 // If any packets waiting to be read in, this fills data in with the packet data and returns
  64 // the number of bytes read.  Else returns 0 if no packets waiting.
  65 extern int ipx_get_packet_data( ubyte * data );
  66
  67 // Sends a broadcast packet to everyone on this socket.
  68 extern void ipx_send_broadcast_packet_data( ubyte * data, int datasize );
  69
  70 // Sends a packet to a certain address
  71 extern void ipx_send_packet_data( ubyte * data, int datasize, ubyte *network, ubyte *address, ubyte *immediate_address );
  72 extern void ipx_send_internetwork_packet_data( ubyte * data, int datasize, ubyte * server, ubyte *address );
  73
  74 // Sends a packet to everyone in the game
  75 extern int ipx_send_game_packet(ubyte *data, int datasize);
  76
  77 // Initialize and handle the protocol-specific field of the netgame struct.
  78 extern void ipx_init_netgame_aux_data(ubyte data[]);
  79 extern int ipx_handle_netgame_aux_data(const ubyte data[]);
  80 // Handle disconnecting from the game
  81 extern void ipx_handle_leave_game(void);
  82
  83 #define IPX_MAX_DATA_SIZE (542)         //(546-4)
  84
  85 extern void ipx_read_user_file(char * filename);
  86 extern void ipx_read_network_file(char * filename);
  87
  88 #endif