include/multi_kick.h

   1 /*
   2  * $Logfile: /Freespace2/code/Network/multi_kick.h $
   3  * $Revision$
   4  * $Date$
   5  * $Author$
   6  *
   7  * $Log$
   8  * Revision 1.1  2002/05/03 03:28:12  root
   9  * Initial revision
  10  *
  11  *
  12  * 3     11/05/98 5:55p Dave
  13  * Big pass at reducing #includes
  14  *
  15  * 2     10/07/98 10:53a Dave
  16  * Initial checkin.
  17  *
  18  * 1     10/07/98 10:50a Dave
  19  *
  20  * 3     9/11/98 4:14p Dave
  21  * Fixed file checksumming of < file_size. Put in more verbose kicking and
  22  * PXO stats store reporting.
  23  *
  24  * 2     3/24/98 5:00p Dave
  25  * Fixed several ui bugs. Put in pre and post voice stream playback sound
  26  * fx. Put in error specific popups for clients getting dropped from games
  27  * through actions other than their own.
  28  *
  29  * 1     2/12/98 4:38p Dave
  30  * Multiplayer kick functionality
  31  *
  32  * $NoKeywords: $
  33  */
  34 #ifndef _MULTIPLAYER_KICK_HEADER_FILE
  35 #define _MULTIPLAYER_KICK_HEADER_FILE
  36
  37 // ----------------------------------------------------------------------------------
  38 // KICK DEFINES/VARS
  39 //
  40
  41 struct net_addr;
  42 struct net_player;
  43
  44 // special reasons for kicking players
  45 #define KICK_REASON_NORM                                0                               // plain old kick
  46 #define KICK_REASON_BAD_XFER                    1                               // error xferring mission
  47 #define KICK_REASON_CANT_XFER                   2                               // can't xfer a builtin mission
  48 #define KICK_REASON_INGAME_ENDED                3                               // kicked while ingame joining a mission about to end
  49
  50
  51 // ----------------------------------------------------------------------------------
  52 // KICK FUNCTIONS
  53 //
  54
  55 // initialize all kicking details (ban lists, etc). it is safe to call this function at any time
  56 void multi_kick_init();
  57
  58 // process all kick details (disconnecting players who have been kicked but haven't closed their socket)
  59 void multi_kick_process();
  60
  61 // attempt to kick a player. return success or fail
  62 void multi_kick_player(int player_index, int ban = 1, int reason = KICK_REASON_NORM);
  63
  64 // is this net address currently kicked and banded
  65 int multi_kick_is_banned(net_addr *addr);
  66
  67 // debug console function called to determine which player to kick
  68 void multi_dcf_kick();
  69
  70 // fill in the passed string with the appropriate "kicked" string
  71 void multi_kick_get_text(net_player *pl, int reason, char *str);
  72
  73 #endif
  74