____                _       __
    / __ )____  _____   | |     / /___ ___________
   / __  / __ \/ ___/   | | /| / / __ `/ ___/ ___/
  / /_/ / /_/ (__  )    | |/ |/ / /_/ / /  (__  )
 /_____/\____/____/     |__/|__/\__,_/_/  /____/

       A futuristic real-time strategy game.
          This file is part of Bos Wars.

(C) Copyright 2001-2007 by the Bos Wars and Stratagus Project. Distributed under the "GNU General Public License"

---

netconnect.h

Go to the documentation of this file.

//     ____                _       __               
//    / __ )____  _____   | |     / /___ ___________
//   / __  / __ \/ ___/   | | /| / / __ `/ ___/ ___/
//  / /_/ / /_/ (__  )    | |/ |/ / /_/ / /  (__  ) 
// /_____/\____/____/     |__/|__/\__,_/_/  /____/  
//                                              
//       A futuristic real-time strategy game.
//          This file is part of Bos Wars.
//
//
//      (c) Copyright 1998-2008 by Lutz Sammer, Andreas Arens, and Jimmy Salmon
//
//      This program is free software; you can redistribute it and/or modify
//      it under the terms of the GNU General Public License as published by
//      the Free Software Foundation; only version 2 of the License.
//
//      This program is distributed in the hope that it will be useful,
//      but WITHOUT ANY WARRANTY; without even the implied warranty of
//      MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
//      GNU General Public License for more details.
//
//      You should have received a copy of the GNU General Public License
//      along with this program; if not, write to the Free Software
//      Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
//      02111-1307, USA.

#ifndef __NETCONNECT_H__
#define __NETCONNECT_H__


#include <string>
#include "SDL.h"

/*----------------------------------------------------------------------------
--  Defines
----------------------------------------------------------------------------*/

#define NetworkProtocolMajorVersion StratagusMajorVersion
#define NetworkProtocolMinorVersion StratagusMinorVersion
#define NetworkProtocolPatchLevel   StratagusPatchLevel
#define NetworkProtocolVersion \
    (NetworkProtocolMajorVersion * 10000 + NetworkProtocolMinorVersion * 100 + \
        NetworkProtocolPatchLevel)

#define NetworkProtocolFormatString "%d.%d.%d"
#define NetworkProtocolFormatArgs(v) (v) / 10000, ((v) / 100) % 100, (v) % 100

#define NetworkDefaultPort 6660  

/*----------------------------------------------------------------------------
--  Declarations
----------------------------------------------------------------------------*/

class CNetworkHost {
public:
    unsigned char *Serialize() const;
    void Deserialize(const unsigned char *p);
    static size_t Size() { return 4+2+2+16; }

    Uint32 Host;         
    Uint16 Port;         
    Uint16 PlyNr;        
    char   PlyName[16];  
};

typedef struct _network_state_ {
    unsigned char  State;   
    unsigned short MsgCnt;  
    // Fill in here...
} NetworkState;

class CServerSetup {
public:
    unsigned char *Serialize() const;
    void Deserialize(const unsigned char *p);
    static size_t Size() { return 1+1+1+1+1+1+1+ 1*PlayerMax + 1*PlayerMax + 4*PlayerMax; }
    void Clear() {
        ResourcesOption = UnitsOption = FogOfWar = RevealMap =
            GameTypeOption = Difficulty = MapRichness = 0;
        memset(CompOpt, 0, sizeof(CompOpt));
        memset(Ready, 0, sizeof(Ready));
        memset(LastFrame, 0, sizeof(LastFrame));
    }

    Uint8  ResourcesOption;       
    Uint8  UnitsOption;           
    Uint8  FogOfWar;              
    Uint8  RevealMap;             
    Uint8  GameTypeOption;        
    Uint8  Difficulty;            
    Uint8  MapRichness;           
    Uint8  CompOpt[PlayerMax];    
    Uint8  Ready[PlayerMax];      
    Uint32 LastFrame[PlayerMax];  
    // Fill in here...
};

class CInitMessage {
public:
    unsigned char *Serialize() const;
    void Deserialize(const unsigned char *p);
    static size_t Size() { return 1+1+4+4+4+4+4+4+1+256; }

    Uint8  Type;        
    Uint8  SubType;     
    Sint32 Stratagus;   
    Sint32 Version;     
    Uint32 ConfUID;     
    Uint32 MapUID;      
    Sint32 Lag;         
    Sint32 Updates;     
    Uint8  HostsCount;  

    union {
        CNetworkHost Hosts[PlayerMax]; 
        char         MapPath[256];
        CServerSetup State;             
    } u;
};

enum _ic_message_subtype_ {
    ICMHello,               
    ICMConfig,              

    ICMEngineMismatch,      
    ICMProtocolMismatch,    
    ICMEngineConfMismatch,  
    ICMMapUidMismatch,      

    ICMGameFull,            
    ICMWelcome,             

    ICMWaiting,             
    ICMMap,                 
    ICMState,               
    ICMResync,              

    ICMServerQuit,          
    ICMGoodBye,             
    ICMSeeYou,              

    ICMGo,                  

    ICMAYT,                 
    ICMIAH,                 
};

enum _net_client_con_state_ {
    ccs_unused = 0,           
    ccs_connecting,           
    ccs_connected,            
    ccs_mapinfo,              
    ccs_badmap,               
    ccs_synced,               
    ccs_async,                
    ccs_changed,              
    ccs_detaching,            
    ccs_disconnected,         
    ccs_unreachable,          
    ccs_usercanceled,         
    ccs_nofreeslots,          
    ccs_serverquits,          
    ccs_goahead,              
    ccs_started,              
    ccs_incompatibleengine,   
    ccs_incompatiblenetwork,  
};

/*----------------------------------------------------------------------------
--  Variables
----------------------------------------------------------------------------*/

extern std::string NetworkArg;        
extern int NetPlayers;                
extern int NetworkPort;               

extern std::string LocalPlayerName;   

extern int HostsCount;                
extern CNetworkHost Hosts[PlayerMax]; 

extern int NetConnectRunning;              
extern NetworkState NetStates[PlayerMax];  
extern unsigned char NetLocalState;        
extern int NetLocalHostsSlot;              
extern int NetLocalPlayerNumber;           

extern CServerSetup ServerSetupState;      
extern CServerSetup LocalSetupState;       

/*----------------------------------------------------------------------------
--  Functions
----------------------------------------------------------------------------*/

extern void NetworkServerStartGame(void);       
extern void NetworkGamePrepareGameSettings(void);
extern void NetworkConnectSetupGame(void);      

extern void NetworkInitClientConnect(void);     
extern void NetworkExitClientConnect(void);     
extern void NetworkInitServerConnect(int openslots); 
extern void NetworkExitServerConnect(void);     
extern int NetworkParseSetupEvent(const unsigned char *buf, int size);  
extern int NetworkSetupServerAddress(const std::string &serveraddr);  
extern void NetworkProcessClientRequest(void);  
extern void NetworkProcessServerRequest(void);  
extern void NetworkServerResyncClients(void);   
extern void NetworkDetachFromServer(void);      


#endif // !__NETCONNECT_H__

---